ContentSearchSpec

用于配置内容搜索行为的规范。

JSON 表示法 
{
  "snippetSpec": {
    object (SnippetSpec)
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "extractiveContentSpec": {
    object (ExtractiveContentSpec)
  },
  "searchResultMode": enum (SearchResultMode),
  "chunkSpec": {
    object (ChunkSpec)
  }
}
字段
snippetSpec

object (SnippetSpec)

如果未指定 snippetSpec，则搜索响应中不包含摘要。
summarySpec

object (SummarySpec)

如果未指定 summarySpec，则搜索响应中不会包含摘要。
extractiveContentSpec

object (ExtractiveContentSpec)

如果未提供 extractiveContentSpec，则搜索响应中不会包含提取式答案。
searchResultMode

enum (SearchResultMode)

指定搜索结果模式。如果未指定，搜索结果模式默认为 DOCUMENTS。
chunkSpec

object (ChunkSpec)

指定要从搜索响应中返回的块规范。仅在 SearchRequest.ContentSearchSpec.search_result_mode 设置为 CHUNKS 时可用

SnippetSpec

用于配置搜索响应中的摘要的规范。

JSON 表示法 
{
  "maxSnippetCount": integer,
  "referenceOnly": boolean,
  "returnSnippet": boolean
}
字段
maxSnippetCount
(deprecated)

integer

[已弃用] 此字段已弃用。如需控制代码段返回，请使用 returnSnippet 字段。为了实现向后兼容性，如果 maxSnippetCount > 0，我们将返回摘要。
referenceOnly
(deprecated)

boolean

[已弃用] 此字段已弃用，不会对代码段产生任何影响。
returnSnippet

boolean

如果为 true，则返回代码段。如果无法生成摘要，我们会返回“No snippet is available for this page.”。系统还会返回包含 SUCCESS 或 NO_SNIPPET_AVAILABLE 的 snippetStatus。

ExtractiveContentSpec

用于配置搜索响应中提取内容的规范。

JSON 表示法 
{
  "maxExtractiveAnswerCount": integer,
  "maxExtractiveSegmentCount": integer,
  "returnExtractiveSegmentScore": boolean,
  "numPreviousSegments": integer,
  "numNextSegments": integer
}
字段
maxExtractiveAnswerCount

integer

每个搜索结果中返回的提取式答案数量上限。

提取式答案是指从原始文档中提取的逐字逐句的答案，可针对搜索查询提供精准且符合上下文的回答。

如果匹配答案的数量小于 maxExtractiveAnswerCount，则返回所有答案。否则，返回 maxExtractiveAnswerCount。

每个 SearchResult 最多返回 5 个答案。
maxExtractiveSegmentCount

integer

每个搜索结果中返回的提取段落数上限。仅在 DataStore 设置为 DataStore.ContentConfig.CONTENT_REQUIRED 或 DataStore.solution_types 为 SOLUTION_TYPE_CHAT 时应用。

提取式片段是从原始文档中提取的与搜索查询相关的文本片段，通常比提取式答案更详细。然后，该片段可用作 LLM 的输入，以生成摘要和答案。

如果匹配的片段数小于 maxExtractiveSegmentCount，则返回所有片段。否则，返回 maxExtractiveSegmentCount。
returnExtractiveSegmentScore

boolean

指定是否返回每个搜索结果中提取式片段的置信度得分。此功能仅适用于新的数据存储区或已列入许可名单的数据存储区。如需将您的数据存储区列入许可名单，请与您的客户工程师联系。默认值为 false。
numPreviousSegments

integer

指定是否还包含每个所选细分的相邻细分。在每个所选片段之前最多返回 numPreviousSegments 个片段。
numNextSegments

integer

在每个所选片段之后最多返回 numNextSegments 个片段。

ChunkSpec

指定要从搜索响应中返回的块规范。仅在 SearchRequest.ContentSearchSpec.search_result_mode 设置为 CHUNKS 时可用

JSON 表示法 
{
  "numPreviousChunks": integer,
  "numNextChunks": integer
}
字段
numPreviousChunks

integer

要返回的当前块之前块的数量。允许的最大值为 3。如果未指定，则不会返回任何之前的块。
numNextChunks

integer

当前块要返回的后续块的数量。允许的最大值为 3。如果未指定，则不会返回任何后续块。