Method: projects.locations.collections.dataObjects.batchSearch

批次搜尋資料物件。

HTTP 要求

POST https://vectorsearch.googleapis.com/v1/{parent}/dataObjects:batchSearch

路徑參數

參數
parent

string

這是必要旗標，要搜尋的集合資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "searches": [
    {
      object (Search)
    }
  ],
  "combine": {
    object (CombineResultsOptions)
  }
}
欄位
searches[]

object (Search)

這是必要旗標，要同時執行的搜尋要求清單。
combine

object (CombineResultsOptions)

選用。合併批次搜尋作業結果的選項。

回應主體

批次搜尋作業的回應。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "results": [
    {
      object (SearchDataObjectsResponse)
    }
  ]
}
欄位
results[]

object (SearchDataObjectsResponse)

僅供輸出。搜尋回應清單，批次中的每項要求各有一個回應。如果使用排序器，系統會傳回單一排序結果清單。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • vectorsearch.dataObjects.search

詳情請參閱 IAM 說明文件。

CombineResultsOptions

合併批次搜尋作業結果的選項。

JSON 表示法 
{
  "ranker": {
    object (Ranker)
  },
  "outputFields": {
    object (OutputFields)
  },
  "topK": integer
}
欄位
ranker

object (Ranker)

這是必要旗標，用於合併結果的排序器。
outputFields

object (OutputFields)

選用。遮罩，用於指定要傳回的欄位。
topK

integer

選用。要傳回的結果數。如未設定，系統會使用預設值。

Ranker

定義排序器，合併多項搜尋的結果。

JSON 表示法 
{

  // Union field ranker can be only one of the following:
  "rrf": {
    object (ReciprocalRankFusion)
  },
  "vertex": {
    object (VertexRanker)
  }
  // End of list of possible types for union field ranker.
}
欄位
聯集欄位 ranker。要使用的排名方法。ranker 只能是下列其中一個設定：
rrf

object (ReciprocalRankFusion)

倒數排名融合排名。
vertex

object (VertexRanker)

Vertex AI 排名。

ReciprocalRankFusion

定義結果排名的倒數排名融合 (RRF) 演算法。

JSON 表示法 
{
  "weights": [
    number
  ]
}
欄位
weights[]

number

這是必要旗標，在融合期間套用至每個搜尋結果集的權重。

VertexRanker

使用 Vertex AI 排序服務定義排序器。詳情請參閱 https://cloud.google.com/generative-ai-app-builder/docs/ranking。

JSON 表示法 
{
  "query": string,
  "titleTemplate": string,
  "contentTemplate": string,
  "model": string
}
欄位
query

string

這是必要旗標，用來對記錄進行排序和評分的查詢。
titleTemplate

string

選用。用於產生記錄標題的範本。
contentTemplate

string

選用。用於生成記錄內容的範本。
model

string

這是必要旗標，用來排序文件的模型。如果未指定模型，則會使用 semantic-ranker-default@latest。