Method: projects.locations.collections.dataObjects.aggregate

Aggregates data objects.

HTTP request

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

Path parameters

Parameters
parent

string

Required. The resource name of the Collection for which to query. Format: projects/{project}/locations/{location}/collections/{collection}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "filter": {
    object
  },
  "aggregate": enum (AggregationMethod)
}
Fields
filter

object (Struct format)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.
aggregate

enum (AggregationMethod)

Required. The aggregation method to apply to the query.

Response body

Response message for DataObjectSearchService.AggregateDataObjects.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "aggregateResults": [
    {
      object
    }
  ]
}
Fields
aggregateResults[]

object (Struct format)

The aggregated results of the query.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • vectorsearch.dataObjects.query

For more information, see the IAM documentation.

AggregationMethod

Aggregation methods.

Enums
AGGREGATION_METHOD_UNSPECIFIED Should not be used.
COUNT Count the number of data objects that match the filter.