Method: projects.locations.collections.dataObjects.aggregate

Agrega objetos de dados.

Solicitação HTTP

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso da coleção a ser consultada. Formato: projects/{project}/locations/{location}/collections/{collection}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "filter": {
    object
  },
  "aggregate": enum (AggregationMethod)
}
Campos
filter

object (Struct format)

Opcional. Uma expressão de filtro JSON, por exemplo, {"genre": {"$eq": "sci-fi"}}, representada como um google.protobuf.Struct.
aggregate

enum (AggregationMethod)

Obrigatório. O método de agregação a ser aplicado à consulta.

Corpo da resposta

Mensagem de resposta para DataObjectSearchService.AggregateDataObjects.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "aggregateResults": [
    {
      object
    }
  ]
}
Campos
aggregateResults[]

object (Struct format)

Os resultados agregados da consulta.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • vectorsearch.dataObjects.query

Para mais informações, consulte a documentação do IAM.

AggregationMethod

Métodos de agregação.

Tipos enumerados
AGGREGATION_METHOD_UNSPECIFIED Não pode ser usado.
COUNT Conta o número de objetos de dados que correspondem ao filtro.