Developer Knowledge API

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

概览

Developer Knowledge API 旨在成为以机器可读格式访问 Google 开发者文档的规范来源。它提供用于搜索和检索文档以及回答查询的函数:

如需快速开始使用,请参阅快速入门指南

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

Developer Knowledge API 支持以非结构化 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 密钥
  3. 名称字段中,提供密钥的名称。
  4. 点击选择 API 限制下拉菜单,然后输入 Developer Knowledge API。点击相应结果,然后点击确定

    注意:

    • 如果您刚刚启用 Developer Knowledge API,则可能需要过一段时间才能在列表中看到它。请等待几分钟,然后重试。
    • 如果您计划将此密钥用于 AI 客户端的一般模型调用(例如 GEMINI_API_KEY),则还必须选择 Generative Language API。否则,这些来电将被屏蔽。
  5. 点击创建

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

包含的文档

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

Developer Knowledge API 旨在提供对最新 Google 开发者文档的访问权限。我们的目标是在内容发布后的 48 小时内重新为内容编制索引,以便在 2 个工作日内提供新的或更新的文档。

已知限制

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