本指南提供了有关如何使用 Developer Knowledge API 的主要功能的示例:搜索文档、检索单个文档以及批量检索多个文档。
在开始之前,请确保您已启用 API 并生成 Developer Knowledge API 密钥,并将密钥保存到环境变量中:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
使用 SearchDocumentChunks 搜索文档
使用 documents.searchDocumentChunks 方法查找与查询字符串匹配的文档块。结果包括文档中的内容块和 parent 参考,您可以使用该参考检索完整的文档内容。
以下示例搜索与“BigQuery”匹配的文档:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
您可以使用 pageSize 等参数来优化搜索结果,以限制每页的结果数量,并使用 pageToken 来检索后续页面。
使用 GetDocument 检索文档
使用 documents.get 方法可检索单个文档的完整内容,使用 SearchDocumentChunks 调用返回的 DocumentChunk.parent。
以下示例检索名称为 documents/DOCUMENT_ID 的文档:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
响应是完整的 Document 资源,包括 content 字段。
使用 BatchGetDocuments 检索多个文档
使用 documents.batchGet 方法可通过一次 API 调用按名称检索最多 100 个文档。这比发出多个 GetDocument 请求更高效。
以下示例按名称检索两个文档:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
响应包含所请求的 Document 资源列表。