Method: projects.locations.indexEndpoints.searchIndexEndpoint

Recherchez un point de terminaison d'index déployé (type de corpus IMAGE uniquement).

Requête HTTP

POST https://visionai.googleapis.com/v1/{indexEndpoint=projects/*/locations/*/indexEndpoints/*}:searchIndexEndpoint

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
indexEndpoint

string

Obligatoire. Point de terminaison de l'index à rechercher. Format : "projects/{projectId}/locations/{locationId}/indexEndpoints/{indexEndpointId}"

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "criteria": [
    {
      object (Criteria)
    }
  ],
  "exclusionCriteria": [
    {
      object (Criteria)
    }
  ],
  "pageSize": integer,
  "pageToken": string,

  // Union field query can be only one of the following:
  "imageQuery": {
    object (ImageQuery)
  },
  "textQuery": string
  // End of list of possible types for union field query.
}
Champs
criteria[]

object (Criteria)

Critères appliqués aux résultats de recherche.
exclusionCriteria[]

object (Criteria)

Critères à exclure des résultats de recherche. Notez que fetchMatchedAnnotations sera ignoré.
pageSize

integer

Taille de la page demandée. L'API peut renvoyer moins de résultats que demandé. Si la valeur est négative, une erreur INVALID_ARGUMENT est renvoyée. Si aucune valeur n'est spécifiée ou si la valeur est 0, l'API sélectionne une taille par défaut, qui est de 10. Si la taille de page demandée est supérieure à la taille maximale, l'API sélectionnera la taille maximale, qui est de 100.
pageToken

string

Jeton de continuation permettant d'extraire la page suivante. Si la valeur est vide, cela signifie que la première page est récupérée.
Champ d'union query. Requête de recherche globale oneof. query ne peut être qu'un des éléments suivants :
imageQuery

object (ImageQuery)

Requête uniquement basée sur des images.
textQuery

string

Requête uniquement basée sur du texte.

Corps de la réponse

Message de réponse pour indexEndpoints.searchIndexEndpoint.

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

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

object (SearchResultItem)

Résultats de recherche renvoyés.
nextPageToken

string

Jeton de continuation de la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource indexEndpoint :

  • visionai.indexEndpoints.search

Pour en savoir plus, consultez la documentation IAM.

ImageQuery

Requête d'image pour la requête du point de terminaison de recherche.

Représentation JSON 
{

  // Union field image can be only one of the following:
  "inputImage": string,
  "asset": string
  // End of list of possible types for union field image.
}
Champs

Champ d'union image.

image ne peut être qu'un des éléments suivants :
inputImage

string (bytes format)

Image d'entrée en octets bruts.

Chaîne encodée en base64.
asset

string

Nom de ressource de l'élément. Compatible uniquement avec le type de corpus IMAGE. Format : projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/assets/{assetId}