Method: projects.locations.collections.dataObjects.query

Consulta objetos de datos.

Solicitud HTTP

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

Parámetros de ruta

Parámetros
parent

string

Obligatorio. El nombre del recurso de la colección para la que se realizará la consulta. Formato: projects/{project}/locations/{location}/collections/{collection}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "filter": {
    object
  },
  "outputFields": {
    object (OutputFields)
  },
  "pageSize": integer,
  "pageToken": string
}
Campos
filter

object (Struct format)

Es opcional. Una expresión de filtro JSON, por ejemplo, {"genre": {"$eq": "sci-fi"}}, representada como google.protobuf.Struct.
outputFields

object (OutputFields)

Es opcional. Máscara que especifica qué campos mostrar.
pageSize

integer

Es opcional. El tamaño de página de lista estándar. El valor predeterminado es 100. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000.
pageToken

string

Es opcional. El token de página de lista estándar. Por lo general, se obtiene a través de QueryDataObjectsResponse.next_page_token de la llamada anterior a DataObjectSearchService.QueryDataObjects.

Cuerpo de la respuesta

Mensaje de respuesta para DataObjectSearchService.QueryDataObjects.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
Campos
dataObjects[]

object (DataObject)

Solo salida. Es la lista de dataObjects que coinciden con la consulta.
nextPageToken

string

Solo salida. Un token para recuperar la siguiente página de resultados. Pasa a [DataObjectSearchService.QueryDataObjectsRequest.page_token][] para obtener esa página.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • vectorsearch.dataObjects.query

Para obtener más información, consulta la documentación de IAM.