SearchSpec

搜索规范。

JSON 表示法 
{

  // Union field input can be only one of the following:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of list of possible types for union field input.
}
字段
联合字段 input。用于控制搜索行为的搜索参数。或者提供搜索结果列表以生成答案。input 只能是下列其中一项：
searchParams

object (SearchParams)

搜索参数。
searchResultList

object (SearchResultList)

搜索结果列表。

SearchParams

搜索参数。

JSON 表示法 
{
  "maxReturnResults": integer,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "orderBy": string,
  "searchResultMode": enum (SearchResultMode),
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "naturalLanguageQueryUnderstandingSpec": {
    object (NaturalLanguageQueryUnderstandingSpec)
  }
}
字段
maxReturnResults

integer

要返回的搜索结果数。默认值为 10。
filter

string

过滤器语法使用一种表达式语言，可根据要过滤文档的一个或多个字段构建过滤条件。过滤表达式区分大小写。此参数将用于过滤搜索结果，可能会影响回答响应。

如果此字段无法识别，则返回 INVALID_ARGUMENT。

Vertex AI Search 中的过滤是通过将 LHS 过滤键映射到 Vertex AI Search 后端中定义的键属性来完成的，此映射由客户在其架构中定义。例如，媒体客户的架构中可能包含“name”字段。在这种情况下，过滤条件将如下所示：filter --> name:'ANY("king kong")'

如需详细了解过滤（包括语法和过滤运算符），请参阅过滤
boostSpec

object (BoostSpec)

提升规范，以提升搜索结果中某些文档的排名，这可能会影响回答查询响应。如需详细了解热推，请参阅热推
orderBy

string

返回文档的顺序。可以按 Document 对象中的字段对文档进行排序。如果按相关性排序，则将其留空。orderBy 表达式区分大小写。如需详细了解排序，请参阅排序

如果此字段无法识别，则返回 INVALID_ARGUMENT。
searchResultMode

enum (SearchResultMode)

指定搜索结果模式。如果未指定，搜索结果模式默认为 DOCUMENTS。请参阅解析和分块文档
dataStoreSpecs[]

object (DataStoreSpec)

用于定义在搜索调用中要过滤的数据存储区以及这些数据存储区的配置。仅在引擎具有多个 dataStore 的使用情形下考虑此参数。对于引擎中的单个 dataStore，它们应使用顶层的规范。
naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

可选。用于为搜索请求启用自然语言理解功能的规范。

SearchResultList

搜索结果列表。

JSON 表示法 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
字段
searchResults[]

object (SearchResult)

搜索结果。

SearchResult

搜索结果。

JSON 表示法 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of list of possible types for union field content.
}
字段
联合字段 content。搜索结果内容。content 只能是下列其中一项：
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

非结构化文档信息。
chunkInfo

object (ChunkInfo)

分块信息。

UnstructuredDocumentInfo

非结构化文档信息。

JSON 表示法 
{
  "document": string,
  "uri": string,
  "title": string,
  "documentContexts": [
    {
      object (DocumentContext)
    }
  ],
  "extractiveSegments": [
    {
      object (ExtractiveSegment)
    }
  ],
  "extractiveAnswers": [
    {
      object (ExtractiveAnswer)
    }
  ]
}
字段
document

string

文档资源名称。
uri

string

相应文档的 URI。
title

string

标题。
documentContexts[]

object (DocumentContext)

文档上下文列表。该内容将用于生成回答。这应该是文档的主要内容，可以很长且很全面。
extractiveSegments[]

object (ExtractiveSegment)

提取式细分列表。
extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

已弃用：此字段已弃用，不会对答案生成产生任何影响。请改用 documentContexts 和 extractiveSegments 字段。抽样答案列表。

DocumentContext

文档上下文。

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

string

网页标识符。
content

string

用于生成答案的文档内容。

ExtractiveSegment

提取式片段。指南：仅当 documentContexts 为空时，回答生成才会使用它。这应该是较短的摘要。

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

string

网页标识符。
content

string

提取式片段内容。

ExtractiveAnswer

提取式回答。指南

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

string

网页标识符。
content

string

提取式答案内容。

ChunkInfo

分块信息。

JSON 表示法 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
字段
chunk

string

块资源名称。
content

string

块状文本内容。
documentMetadata

object (DocumentMetadata)

当前块中相应文档的元数据。

DocumentMetadata

文档元数据包含当前块的文档信息。

JSON 表示法 
{
  "uri": string,
  "title": string
}
字段
uri

string

文档的 URI。
title

string

文档的标题。