Method: projects.locations.collections.dataObjects.aggregate

Agrège les objets de données.

Requête HTTP

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

Paramètres de chemin

Paramètres
parent

string

Obligatoire. Nom de ressource de la collection pour laquelle effectuer la requête. Format : projects/{project}/locations/{location}/collections/{collection}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "filter": {
    object
  },
  "aggregate": enum (AggregationMethod)
}
Champs
filter

object (Struct format)

Facultatif. Expression de filtre JSON, par exemple {"genre": {"$eq": "sci-fi"}}, représentée sous la forme d'une google.protobuf.Struct.
aggregate

enum (AggregationMethod)

Obligatoire. Méthode d'agrégation à appliquer à la requête.

Corps de la réponse

Message de réponse pour DataObjectSearchService.AggregateDataObjects.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "aggregateResults": [
    {
      object
    }
  ]
}
Champs
aggregateResults[]

object (Struct format)

Résultats agrégés de la requête.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • vectorsearch.dataObjects.query

Pour en savoir plus, consultez la documentation IAM.

AggregationMethod

Méthodes d'agrégation.

Enums
AGGREGATION_METHOD_UNSPECIFIED Ne doit pas être utilisée.
COUNT Comptez le nombre d'objets de données correspondant au filtre.