快速入门：开始使用 Developer Knowledge API

本指南介绍了如何开始使用 Developer Knowledge API。您将学习如何启用 Developer Knowledge API、获取 API 密钥，以及发出第一个 API 调用来搜索和检索开发者文档。

准备工作

在开始使用 Developer Knowledge API 之前，请务必完成以下步骤。

启用 API

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

创建并保护 API 密钥

  1. 在您启用 API 的项目的 Google Cloud 控制台中，前往“凭据”页面。
  2. 点击创建凭证，然后从菜单中选择 API 密钥。
  3. 在名称字段中，提供密钥的名称。
  4. 点击选择 API 限制 下拉菜单，然后输入 Developer Knowledge API。点击相应结果，然后点击确定。
    • 注意：如果您刚刚启用 Developer Knowledge API，则可能需要过一段时间才能在列表中看到它。请等待几分钟，然后重试。
  5. 点击创建。

使用接地生成功能回答查询

获得 Developer Knowledge API 密钥后，您就可以开始使用该 API 了。以下示例展示了如何提出问题并获得基于文档的回答：

  1. 将 Developer Knowledge API 密钥保存到环境变量中：

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    将 YOUR_API_KEY 替换为您生成的 API 密钥。

  2. 使用 curl 调用 AnswerQuery 端点：

    curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

此命令会根据文档返回查询问题的答案。

搜索文档块

如果您想查找特定的文档片段，而不是生成的答案，可以直接搜索文档块。

使用 curl 调用 SearchDocumentChunks 端点：

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

响应包含文档中匹配的内容块以及对父文档的引用。

检索文档

来自 searchDocumentChunks 的响应包含文档块列表。每个文档块都有一个 parent 字段，其中包含文档的资源名称，您可以将该字段与 GetDocument 结合使用来检索文档的完整内容。

如需检索文档，请从 searchDocumentChunks 返回的某个块中复制 parent 字段并将其保存到环境变量中，然后使用 curl 调用 GetDocument 端点：

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

此方法会返回指定文档的完整 Markdown 内容。

后续步骤