Method: projects.locations.collections.dataObjects.query

Interroge les objets de données.

Requête HTTP

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

Paramètres de chemin

Paramètres
parent

string

Obligatoire. Nom de la ressource 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
  },
  "outputFields": {
    object (OutputFields)
  },
  "pageSize": integer,
  "pageToken": string
}
Champs
filter

object (Struct format)

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

object (OutputFields)

Facultatif. Masque spécifiant les champs à renvoyer.
pageSize

integer

Facultatif. La taille de page de la liste standard. La valeur par défaut est 100. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000.
pageToken

string

Facultatif. Jeton de la page de la liste standard. Généralement obtenu via QueryDataObjectsResponse.next_page_token de l'appel DataObjectSearchService.QueryDataObjects précédent.

Corps de la réponse

Message de réponse pour DataObjectSearchService.QueryDataObjects.

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

Représentation JSON 
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
Champs
dataObjects[]

object (DataObject)

Uniquement en sortie. Liste des dataObjects qui correspondent à la requête.
nextPageToken

string

Uniquement en sortie. Jeton permettant de récupérer la page de résultats suivante. Transmettez-le à [DataObjectSearchService.QueryDataObjectsRequest.page_token][] pour obtenir cette page.

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.