Method: projects.locations.collections.dataObjects.query

データ オブジェクトをクエリします。

HTTP リクエスト

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

パスパラメータ

パラメータ
parent

string

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

リクエストの本文

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

JSON 表現 
{
  "filter": {
    object
  },
  "outputFields": {
    object (OutputFields)
  },
  "pageSize": integer,
  "pageToken": string
}
フィールド
filter

object (Struct format)

省略可。JSON フィルタ式（例: {"genre": {"$eq": "sci-fi"}}）。google.protobuf.Struct として表されます。
outputFields

object (OutputFields)

省略可。返されるフィールドを指定するマスク。
pageSize

integer

省略可。標準的なリストのページサイズ。デフォルトは 100 です。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
pageToken

string

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

レスポンスの本文

DataObjectSearchService.QueryDataObjects に対するレスポンス メッセージです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
フィールド
dataObjects[]

object (DataObject)

出力専用。クエリに一致する dataObjects のリスト。
nextPageToken

string

出力専用。結果の次ページを取得するためのトークン。[DataObjectSearchService.QueryDataObjectsRequest.page_token][] に渡して、そのページを取得します。

認可スコープ

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

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

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

IAM 権限

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

  • vectorsearch.dataObjects.query

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