Method: projects.locations.collections.dataObjects.search

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

HTTP リクエスト

POST https://vectorsearch.googleapis.com/v1beta/{parent}/dataObjects:search

パスパラメータ

パラメータ
parent

string

必須。検索するコレクションのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "pageSize": integer,
  "pageToken": string,

  // Union field search_type can be only one of the following:
  "vectorSearch": {
    object (VectorSearch)
  },
  "semanticSearch": {
    object (SemanticSearch)
  },
  "textSearch": {
    object (TextSearch)
  }
  // End of list of possible types for union field search_type.
}
フィールド
pageSize

integer

省略可。標準的なリストのページサイズ。

pageToken

string

省略可。標準的なリストのページトークン。通常は、前の DataObjectSearchService.SearchDataObjects 呼び出しの SearchDataObjectsResponse.next_page_token を介して取得します。

共用体フィールド search_type。検索するクエリ。search_type は次のいずれかになります。

レスポンスの本文

成功した場合、レスポンスの本文には SearchDataObjectsResponse のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • vectorsearch.dataObjects.search

詳細については、IAM のドキュメントをご覧ください。