Method: projects.locations.collections.dataObjects.aggregate

匯總資料物件。

HTTP 要求

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

路徑參數

參數
parent

string

這是必要旗標,要查詢的集合資源名稱,格式: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 計算符合篩選條件的資料物件數量。