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)

出力専用。検索レスポンスのリスト。バッチ内の各リクエストに 1 つのレスポンスがあります。ランカーが使用されている場合は、結果のランク付けされたリストが 1 つ返されます。

認可スコープ

次の 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

省略可。返される結果の数。設定しない場合、デフォルト値が使用されます。

ランカー

複数の検索の結果を結合するランカーを定義します。

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)

Reciprocal Rank Fusion ランキング。
vertex

object (VertexRanker)

Vertex AI ランキング。

ReciprocalRankFusion

結果のランキングに使用する Reciprocal Rank Fusion（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 が使用されます。