Method: projects.locations.collections.dataObjects.batchSearch

データ オブジェクトを一括検索します。

HTTP リクエスト

POST https://vectorsearch.googleapis.com/v1beta/{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 つのレスポンスがあります。ランカーを使用すると、ランク付けされた結果の単一リストが返されます。

認可スコープ

次の 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)
  }
  // End of list of possible types for union field ranker.

  // Union field reranker can be only one of the following:
  "vertexRanker": {
    object (VertexRanker)
  }
  // End of list of possible types for union field reranker.
}
フィールド
共用体フィールド ranker。使用するランキング方法。ranker は次のいずれかになります。
rrf

object (ReciprocalRankFusion)

Reciprocal Rank Fusion ランキング。
共用体フィールド reranker。ランカーによって結合された結果の最終的なランキングに使用するリランカー。reranker は次のいずれかになります。
vertexRanker

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 表現 
{
  "model": string,
  "topN": integer,

  // Union field record_spec can be only one of the following:
  "textRecordSpec": {
    object (TextRecordSpec)
  }
  // End of list of possible types for union field record_spec.
}
フィールド
model

string

必須。ドキュメントのランキングに使用されるモデル。利用可能なモデルのリストについては、https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models をご覧ください。現在、semantic-ranker-fast@latest のみがサポートされています。
topN

integer

必須。ランキングのために処理されるドキュメントの数。
共用体フィールド record_spec。ランキングのレコード仕様。少なくとも 1 つのレコード仕様を設定する必要があります。record_spec は次のいずれかになります。
textRecordSpec

object (TextRecordSpec)

テキスト検索のレコード仕様。

TextRecordSpec

テキスト検索のレコード仕様。

JSON 表現 
{
  "query": string,
  "titleTemplate": string,
  "contentTemplate": string
}
フィールド
query

string

必須。レコードのランク付けとスコア付けに使用するクエリ。
titleTemplate

string

省略可。レコードのタイトルを生成するために使用されるテンプレート。
contentTemplate

string

省略可。レコードのコンテンツを生成するために使用されるテンプレート。