Method: documents.searchDocumentChunks

在 Google 的开发者文档中搜索开发者知识。根据用户的查询返回 DocumentChunk。同一个 Document 中可能包含许多块。如需检索完整文档，请将 SearchDocumentChunksResponse.results 中返回的 DocumentChunk.parent 与 DeveloperKnowledge.GetDocument 或 DeveloperKnowledge.BatchGetDocuments 结合使用。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
query

string

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

integer

可选。指定要返回的最大结果数。服务返回的值可能小于此值。

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

最大值为 100；高于 100 的值将被强制转换为 100。
pageToken

string

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

string

可选。对搜索结果应用严格的过滤条件。该表达式支持 https://google.aip.dev/160 中介绍的语法的子集。

虽然 documents.searchDocumentChunks 返回 DocumentChunk，但过滤条件会应用于 DocumentChunk.document 字段。

支持过滤的字段：

  • contentLengthBytes (INTEGER)：Document.content 字段的长度（以字节为单位）。
  • dataSource (STRING)：文档的来源，例如 docs.cloud.google.com。如需查看语料库中数据源的完整列表，请参阅 https://developers.google.com/knowledge/reference/corpus-reference。
  • updateTime (TIMESTAMP)：文档上次有意义更新的时间戳。有意义的更新是指更改文档的 Markdown 内容或元数据的更新。
  • uri (STRING)：文档 URI，例如 https://docs.cloud.google.com/bigquery/docs/tables。

INTEGER 字段支持 =、<、<=、> 和 >= 运算符。

STRING 字段支持 =（等于）和 !=（不等于）运算符，用于对整个字符串进行 完全匹配。不支持部分匹配、前缀匹配和正则表达式匹配。

TIMESTAMP 字段支持 =、<、<=、> 和 >= 运算符。时间戳必须采用 RFC-3339 格式，例如 "2025-01-01T00:00:00Z"。

您可以使用 AND、OR 和 NOT（或 -）逻辑运算符组合表达式。OR 的优先级高于 AND。使用括号进行显式优先级分组。

示例：

  • 按 Document.content_length_bytes 过滤： contentLengthBytes < 50000
  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

filter 字符串不得超过 500 个字符；如果值超过 500 个字符，则会导致 INVALID_ARGUMENT 错误。

请求正文

请求正文必须为空。

响应正文

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
  • https://www.googleapis.com/auth/cloud-platform

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