Method: projects.locations.collections.dataObjects.query

Consulta objetos de dados.

Solicitação HTTP

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

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
  },
  "outputFields": {
    object (OutputFields)
  },
  "pageSize": integer,
  "pageToken": string
}
Campos
filter

object (Struct format)

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

object (OutputFields)

Opcional. Máscara que especifica os campos a serem retornados.
pageSize

integer

Opcional. O tamanho de página de lista padrão.
pageToken

string

Opcional. O token de página de lista padrão. Normalmente recebido via QueryDataObjectsResponse.next_page_token da chamada DataObjectSearchService.QueryDataObjects anterior.

Corpo da resposta

Mensagem de resposta para DataObjectSearchService.QueryDataObjects.

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

Representação JSON 
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
Campos
dataObjects[]

object (DataObject)

A lista de dataObjects que correspondem à consulta.
nextPageToken

string

Token para recuperar a próxima página de resultados. Passe para [DataObjectSearchService.QueryDataObjectsRequest.page_token][] para receber essa página.

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.