SearchResult

表示搜索结果。

JSON 表示法 
{
  "id": string,
  "document": {
    object (Document)
  },
  "chunk": {
    object (Chunk)
  },
  "modelScores": {
    string: {
      object (DoubleList)
    },
    ...
  },
  "rankSignals": {
    object (RankSignals)
  }
}
字段
id

string

搜索的 Document 的 Document.id。
document

object (Document)

搜索响应中的文档数据片段。系统仅会填充标记为 retrievable 的字段。
chunk

object (Chunk)

如果 SearchRequest.ContentSearchSpec.search_result_mode 设置为 CHUNKS，则该字段指示搜索响应中的块数据。
modelScores

map (key: string, value: object (DoubleList))

仅限输出。Google 提供的可用得分。
rankSignals

object (RankSignals)

可选。与结果关联的一组排名衡量因素。

块

块会捕获以块模式推荐或搜索的项的所有原始元数据信息。

JSON 表示法 
{
  "name": string,
  "id": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "derivedStructData": {
    object
  },
  "pageSpan": {
    object (PageSpan)
  },
  "chunkMetadata": {
    object (ChunkMetadata)
  },
  "dataUrls": [
    string
  ],
  "annotationContents": [
    string
  ],
  "annotationMetadata": [
    {
      object (AnnotationMetadata)
    }
  ],
  "relevanceScore": number
}
字段
name

string

块的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}。

此字段必须是采用 UTF-8 编码的字符串，长度限制为 1024 个字符。
id

string

当前块的唯一块 ID。
content

string

内容是文档中的字符串（已解析的内容）。
documentMetadata

object (DocumentMetadata)

当前数据块所属文档的元数据。
derivedStructData

object (Struct format)

仅限输出。此字段为 OUTPUT_ONLY。它包含不在原始输入文档中的派生数据。
pageSpan

object (PageSpan)

块的页面 span。
chunkMetadata

object (ChunkMetadata)

仅限输出。当前块的元数据。
dataUrls[]

string

仅限输出。当前块所含图片的图片数据网址。数据网址由四部分组成：前缀 (data:)、指示数据类型的 MIME 类型、可选的 base64 令牌（如果是非文本数据）和数据本身：data:[][;base64],
annotationContents[]

string

仅限输出。当前块所含注解的内容。
annotationMetadata[]

object (AnnotationMetadata)

仅限输出。注解元数据包含当前块中的结构化内容。
relevanceScore

number

仅限输出。表示基于相似度的相关性得分。得分越高，表示块的相关性越高。得分在 [-1.0, 1.0] 范围内。仅会针对 SearchResponse 进行填充。

DocumentMetadata

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

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

string

文档的 URI。
title

string

文档的标题。
mimeType

string

文档的 MIME 类型。https://www.iana.org/assignments/media-types/media-types.xhtml。
structData

object (Struct format)

数据表示形式。文档的结构化 JSON 数据。它应符合已注册的 Schema，否则系统会抛出 INVALID_ARGUMENT 错误。

PageSpan

块的页面 span。

JSON 表示法 
{
  "pageStart": integer,
  "pageEnd": integer
}
字段
pageStart

integer

块的起始页。
pageEnd

integer

块的结束页。

ChunkMetadata

当前块的元数据。此字段仅会针对 SearchService.Search API 进行填充。

JSON 表示法 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
字段
previousChunks[]

object (Chunk)

当前块之前的块。此数量由 SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks 控制。此字段仅会针对 SearchService.Search API 进行填充。
nextChunks[]

object (Chunk)

当前块之后的块。此数量由 SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks 控制。此字段仅会针对 SearchService.Search API 进行填充。

AnnotationMetadata

注解元数据包含当前块中的结构化内容。

JSON 表示法 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
字段
structuredContent

object (StructuredContent)

仅限输出。结构化内容信息。
imageId

string

仅限输出。如果结构化内容基于图片，则系统会提供图片 ID。

StructuredContent

结构化内容信息。

JSON 表示法 
{
  "structureType": enum (StructureType),
  "content": string
}
字段
structureType

enum (StructureType)

仅限输出。结构化内容的结构类型。
content

string

仅限输出。结构化内容的内容。

StructureType

定义可提取的结构化内容的类型。

枚举
STRUCTURE_TYPE_UNSPECIFIED 默认值。
SHAREHOLDER_STRUCTURE 股东结构。
SIGNATURE_STRUCTURE 签名结构。
CHECKBOX_STRUCTURE 复选框结构。

DoubleList

双精度列表。

JSON 表示法 
{
  "values": [
    number
  ]
}
字段
values[]

number

双精度值。

RankSignals

一组排名衡量因素。

JSON 表示法 
{
  "defaultRank": number,
  "customSignals": [
    {
      object (CustomSignal)
    }
  ],
  "precomputedExpressionValues": [
    number
  ],
  "keywordSimilarityScore": number,
  "relevanceScore": number,
  "semanticSimilarityScore": number,
  "pctrRank": number,
  "topicalityRank": number,
  "documentAge": number,
  "boostingFactor": number
}
字段
defaultRank

number

可选。结果的默认排名。
customSignals[]

object (CustomSignal)

可选。自定义 clearbox 衡量因素的列表。
precomputedExpressionValues[]

number

可选。相应文档的预计算表达式结果列表，按 SearchRequest.custom_ranking_params.expressions_to_precompute 中的请求顺序排列。
keywordSimilarityScore

number

可选。关键字匹配调整。
relevanceScore

number

可选。语义相关性调整。
semanticSimilarityScore

number

可选。语义相似度调整。
pctrRank

number

可选。以排名表示的预测转化率调整。
topicalityRank

number

可选。以排名表示的主题性调整。
documentAge

number

可选。文档存在时间（以小时为单位）。
boostingFactor

number

可选。文档的自定义加权组合。

CustomSignal

以名称和值对表示的自定义 clearbox 衡量因素。

JSON 表示法 
{
  "name": string,
  "value": number
}
字段
name

string

可选。衡量因素的名称。
value

number

可选。表示排名衡量因素的浮点值（例如，1.25 表示 BM25）。