Method: projects.locations.collections.dataObjects.query

Esegue query sugli oggetti dati.

Richiesta HTTP

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

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa della raccolta per cui eseguire la query. Formato: projects/{project}/locations/{location}/collections/{collection}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "filter": {
    object
  },
  "outputFields": {
    object (OutputFields)
  },
  "pageSize": integer,
  "pageToken": string
}
Campi
filter

object (Struct format)

Facoltativo. Un'espressione di filtro JSON, ad esempio {"genre": {"$eq": "sci-fi"}}, rappresentata come google.protobuf.Struct.

outputFields

object (OutputFields)

Facoltativo. Maschera che specifica i campi da restituire.

pageSize

integer

Facoltativo. Le dimensioni standard della pagina dell'elenco.

pageToken

string

Facoltativo. Il token della pagina dell'elenco standard. In genere ottenuto tramite QueryDataObjectsResponse.next_page_token della precedente chiamata DataObjectSearchService.QueryDataObjects.

Corpo della risposta

Messaggio di risposta per DataObjectSearchService.QueryDataObjects.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
Campi
dataObjects[]

object (DataObject)

L'elenco di dataObject che corrispondono alla query.

nextPageToken

string

Un token per recuperare la pagina dei risultati successiva. Passa a [DataObjectSearchService.QueryDataObjectsRequest.page_token][] per ottenere la pagina.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • vectorsearch.dataObjects.query

Per saperne di più, consulta la documentazione di IAM.