Google 会使用 AI 技术将内容翻译成您偏好的语言。AI 翻译可能包含错误。

Developer Knowledge API

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

概览

Developer Knowledge API 旨在成为以机器可读方式访问 Google 开发者文档的规范来源。它提供以下功能来搜索和检索文档，以及回答查询：

Developer Knowledge API 支持以非结构化 Markdown 内容的形式搜索和检索文档页面。可搜索内容的语料库列在语料库参考中。

您可以根据自己的工作流程，通过以下平台访问开发者知识：

REST API 和 RPC API：直接调用 HTTP 或 gRPC 端点。如需了解方法规范，请参阅 REST 参考文档和 RPC 参考文档。
客户端库：使用适用于 Python、Node.js 和 TypeScript、Go、Java、PHP 和 Ruby 的官方客户端库将 Developer Knowledge API 集成到您的应用中。
Google Cloud CLI (gcloud)：在终端中运行 gcloud developer-knowledge 命令，以搜索文档块、提取 Markdown 内容和生成答案。
开发者知识 MCP 服务器：使用 Model Context Protocol (MCP) 工具（search_documents、get_documents 和 answer_query）将 AI 编码辅助或智能体连接到 Google 的文档。请参阅 MCP 参考。

Developer Knowledge API 和 Developer Knowledge MCP 服务器旨在满足不同的集成需求：

在以下情况下，使用 Developer Knowledge API、客户端库或 gcloud CLI：
- 您的项目未使用 AI 智能体。
- 您想为代理定义自定义工具或工具集。
- 您希望在将结果传递给模型之前对其进行处理或组合（例如，在提取完整内容之前检查文档字节长度）。
- 您需要过滤搜索结果（例如按 data_source 或 update_time 过滤）或应用字段掩码。
在以下情况下，请使用开发者知识 MCP 服务器和智能体技能：
- 您希望连接 AI 编码助理或智能体，而无需编写自定义工具定义和说明。
- 您希望在开发者知识 MCP 服务器添加新功能时自动更新。
- 您无需对搜索结果进行自定义元数据过滤。

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

您可以使用以下方法之一对向 Developer Knowledge API 发出的请求进行身份验证：

API 密钥：使用 key 查询参数或 X-Goog-Api-Key 标头对直接 REST 请求或开发者知识 MCP 服务器进行身份验证。
应用默认凭证 (ADC)、OAuth 2.0 或服务账号：在使用官方客户端库或生产工作流时，对请求进行身份验证。如需详细了解如何设置凭证，请参阅应用默认凭证文档。
用户凭据 (gcloud CLI)：通过使用 gcloud auth login 登录您的 Google Cloud 账号来对 CLI 请求进行身份验证。如需查看设置说明，请参阅 gcloud CLI 快速入门。

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

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