Developer Knowledge API 可让您以编程方式访问 Google 的公开开发者文档,从而将此知识库集成到您自己的应用和工作流中。
概览
Developer Knowledge API 旨在成为以机器可读方式访问 Google 开发者文档的规范来源。它提供以下功能来搜索和检索文档,以及回答查询:
SearchDocumentChunks,以根据查询内容查找相关网页 URI 和内容摘要。GetDocument或BatchGetDocuments来提取搜索结果的完整内容。AnswerQuery,根据文档语料库中的查询生成答案。
除了直接调用 REST API 或客户端库之外,您还可以使用以下工具将开发者知识与 AI 编码助理相关联:
- Developer Knowledge MCP 服务器:让 AI 编码助理能够使用模型上下文协议 (MCP) 工具(
search_documents、get_documents和answer_query)搜索和读取 Google 的文档。 retrieving-developer-knowledge代理技能:为 AI 助理提供内置指令,说明何时使用每个 Developer Knowledge MCP 服务器工具,以及在 MCP 不可用时如何使用curl调用 REST API。
如需快速开始使用,请参阅快速入门指南。
可搜索内容的语料库列在语料库参考中。
Developer Knowledge API 支持以非结构化 Markdown 内容的形式搜索和检索文档页面。
启用 API
如需使用 Developer Knowledge API,您需要先为您的 Google Cloud 项目启用该 API。
- 在 Google API 库中打开 Developer Knowledge API 页面。
- 检查您是否已选择打算使用相应 API 的正确项目。
- 点击启用。启用或使用该 API 不需要任何特定的 IAM 角色。
身份验证
您可以使用以下方法之一对向 Developer Knowledge API 发出的请求进行身份验证:
- API 密钥:使用
key查询参数或X-Goog-Api-Key标头对直接 REST 请求进行身份验证。如需查看示例,请参阅 REST 快速入门。 - 应用默认凭证 (ADC)、OAuth 2.0 或服务账号:在使用官方客户端库或生产工作流时,对请求进行身份验证。如需详细了解如何设置凭证,请参阅应用默认凭证文档。
包含的文档
如需了解 API 搜索哪些文档,请参阅语料库参考。
开发者知识 API 旨在提供对最新 Google 开发者文档的访问权限。我们的目标是在内容发布后 48 小时内重新为内容编制索引,以便在 2 个工作日内提供新的或更新的文档。已知限制
- Markdown 质量:Markdown 是从源 HTML 生成的。可能存在一些差异或格式问题。
- 内容范围:仅包含语料库参考中的公开网页。 不包括来自 GitHub、OSS 网站、博客或 YouTube 等其他来源的内容。