Developer Knowledge API 可让您以程序化方式访问 Google 的公开开发者文档,从而将此知识库集成到您自己的应用和工作流中。
概览
Developer Knowledge API 旨在成为以机器可读格式访问 Google 开发者文档的规范来源。它提供以下功能来搜索和检索文档,以及回答查询:
SearchDocumentChunks:根据查询查找相关网页 URI 和内容代码段。GetDocument或BatchGetDocuments:提取搜索结果的完整内容。AnswerQuery:获取基于文档语料库的查询答案。
如需快速入门,请按照快速入门指南进行操作。
可搜索内容的语料库列在语料库参考中。
Developer Knowledge API 支持以非结构化 Markdown 内容的形式搜索和检索文档页面。
启用 API
如需使用 Developer Knowledge API,您首先需要为您的 Google Cloud 云项目启用该 API。
- 在 Google API 库中打开 Developer Knowledge API 页面 。
- 检查您是否已选择要使用该 API 的正确项目。
- 点击启用 。启用或使用该 API 不需要任何特定的 IAM 角色。
身份验证
如需使用 Developer Knowledge API,您需要 Developer Knowledge API 密钥。如需创建这样的密钥,请执行以下操作:
- 在您启用该 API 的项目的 Google Cloud 控制台中,前往 “凭据”页面。
- 点击创建凭据 ,然后从菜单中选择 API 密钥 。
- 在名称 字段中,为密钥提供一个名称。
-
点击选择 API 限制 下拉列表,然后输入
Developer Knowledge API。点击结果,然后点击确定 。
- 注意:如果您刚刚启用了 Developer Knowledge API,则该 API 可能会延迟显示在列表中。请等待几分钟,然后重试。
- 点击创建 。
在您的请求中添加此 Developer Knowledge API 密钥。例如,REST 调用应使用 key 查询参数添加此密钥。如需查看示例,请参阅
快速入门指南。
包含的文档
如需了解该 API 搜索哪些文档,请参阅语料库参考以获取 相关信息。
已知限制
- Markdown 质量 :Markdown 是从源 HTML 生成的。可能会存在一些差异或格式问题。
- 内容范围 :仅包含 语料库参考中的公开页面。 不包含来自其他来源(例如 GitHub、OSS 网站、博客或 YouTube)的内容。