Method: documents.searchDocumentChunks

在 Google 的开发者文档中搜索开发者知识。此方法会根据用户的查询返回文档块。同一文档可以有多个块。如需检索完整文档，请使用 DeveloperKnowledge.GetDocument 或 DeveloperKnowledge.BatchGetDocuments 以及 SearchDocumentChunksResponse.results 中返回的 DocumentChunk.parent。

HTTP 请求

GET https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks

网址采用 gRPC 转码语法。

查询参数

参数
query

string

必需。用户提供的原始查询字符串，例如“如何创建 Cloud Storage 存储分区？”。
pageSize

integer

可选。返回的结果数上限。服务返回的值可能小于此值。

如果未指定，则最多返回 5 个结果。

最大值为 20；大于 20 的值将导致 INVALID_ARGUMENT 错误。
pageToken

string

可选。从之前的 documents.searchDocumentChunks 调用接收的页面令牌。利用其进行后续页面检索。

请求正文

请求正文必须为空。

响应正文

DeveloperKnowledge.SearchDocumentChunks 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
字段
results[]

object (DocumentChunk)

给定查询的搜索结果。此列表中的每个 DocumentChunk 都包含与搜索查询相关的内容摘要。将每个结果的 DocumentChunk.parent 字段与 DeveloperKnowledge.GetDocument 或 DeveloperKnowledge.BatchGetDocuments 搭配使用，即可检索完整的文档内容。
nextPageToken

string

可选。可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/devprofiles.full_control

如需了解详情，请参阅 OAuth 2.0 Overview。

DocumentChunk

DocumentChunk 表示 DeveloperKnowledge 语料库中某个文档的一段内容。如需提取整个文档内容，请将 parent 传递给 DeveloperKnowledge.GetDocument 或 DeveloperKnowledge.BatchGetDocuments。

JSON 表示法 
{
  "parent": string,
  "id": string,
  "content": string
}
字段
parent

string

仅限输出。相应块所来自的文档的资源名称。格式：documents/{uri_without_scheme} 示例：documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

仅限输出。相应块在文档中的 ID。块 ID 在文档中是唯一的，但在不同文档之间并不具有全局唯一性。块 ID 不稳定，可能会随时间而变化。
content

string

仅限输出。文档块的内容。