SearchResult

代表搜尋結果。

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

string

Document.id 的搜尋結果Document。
document

object (Document)

搜尋回應中的文件資料摘要。系統只會填入標示為 retrievable 的欄位。
chunk

object (Chunk)

如果 SearchRequest.ContentSearchSpec.search_result_mode 設為 CHUNKS，搜尋回應中的區塊資料。
modelScores

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

僅供輸出。Google 提供可用的分數。
rankSignals

object (RankSignals)

(選用步驟) 與結果相關的一組排名信號。

Chunk

區塊會擷取項目所有原始中繼資料資訊，以便在區塊模式中推薦或搜尋項目。

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)

區塊的頁面範圍。
chunkMetadata

object (ChunkMetadata)

僅供輸出。目前區塊的中繼資料。
dataUrls[]

string

僅供輸出。如果目前的區塊包含圖片，則為圖片資料網址。資料 URL 由四個部分組成：前置字元 (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

區塊的頁面範圍。

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)
    }
  ],
  "keywordSimilarityScore": number,
  "relevanceScore": number,
  "semanticSimilarityScore": number,
  "pctrRank": number,
  "topicalityRank": number,
  "documentAge": number,
  "boostingFactor": number
}
欄位
defaultRank

number

(選用步驟) 結果的預設排名。
customSignals[]

object (CustomSignal)

(選用步驟) 自訂 Clearbox 信號清單。
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

(選用步驟) 代表排名信號的浮點值 (例如 BM25 的 1.25)。