Method: projects.locations.collections.dataObjects.aggregate

データ オブジェクトを集計します。

HTTP リクエスト

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

パスパラメータ

パラメータ
parent

string

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

リクエストの本文

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

JSON 表現 
{
  "filter": {
    object
  },
  "aggregate": enum (AggregationMethod)
}
フィールド
filter

object (Struct format)

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

enum (AggregationMethod)

必須。クエリに適用する集計メソッド。

レスポンスの本文

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

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

JSON 表現 
{
  "aggregateResults": [
    {
      object
    }
  ]
}
フィールド
aggregateResults[]

object (Struct format)

クエリの集計結果。

認可スコープ

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

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

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

IAM 権限

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

  • vectorsearch.dataObjects.query

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

AggregationMethod

集計方法。

列挙型
AGGREGATION_METHOD_UNSPECIFIED これは使用しないでください。
COUNT フィルタに一致するデータ オブジェクトの数をカウントします。