Developer Knowledge API

Developer Knowledge API 可让您以编程方式访问 Google 的公开开发者文档,从而将此知识库集成到您自己的应用和工作流程中。

概览

Developer Knowledge API 旨在成为以机器可读格式访问 Google 开发者文档的规范来源。它提供两项主要功能:

  • SearchDocumentChunks,以根据查询内容查找相关网页 URI 和内容摘要。
  • GetDocumentBatchGetDocuments 来获取搜索结果的完整内容。

如需快速开始使用,请按照快速入门指南操作。

可搜索内容的语料库列在语料库参考中。

预览版注意事项:此预览版支持以非结构化 Markdown 内容的形式搜索和检索文档页面。

启用 API

如需使用 Developer Knowledge API,您需要先为您的 Google Cloud 项目启用该 API。

  1. 在 Google API 库中打开 Developer Knowledge API 页面
  2. 检查您是否已选择要使用相应 API 的正确项目。
  3. 点击启用。启用或使用该 API 不需要任何特定的 IAM 角色。

身份验证

您需要使用 Developer Knowledge API 密钥才能使用 Developer Knowledge API。如需创建这样的账号,请执行以下操作:

  1. 在您启用该 API 的项目的 Google Cloud 控制台中,前往“凭据”页面
  2. 点击创建凭证,然后从菜单中选择 API 密钥。“API 密钥已创建”对话框会显示新创建的密钥的字符串。
  3. 点击修改 API 密钥
  4. 名称字段中,提供密钥的名称。
  5. API restrictions 下,选择 Restrict key
  6. 选择 API 列表中,启用 Developer Knowledge API,然后点击确定
    • 注意:如果您刚刚启用了 Developer Knowledge API,则该 API 可能需要过一段时间才会显示在选择 API 列表中。
  7. 点击保存

在您的请求中包含此 Developer Knowledge API 密钥。例如,REST 调用应使用 key 查询参数包含此令牌。如需查看示例,请参阅快速入门指南

包含的文档

如需了解 API 搜索哪些文档,请参阅语料库参考

已知限制

  • Markdown 质量:Markdown 是从源 HTML 生成的。可能存在一些差异或格式问题。
  • 内容范围:仅包含语料库参考中的公开网页。 其他来源(例如 GitHub、OSS 网站、博客或 YouTube)的内容不包括在内。