Method: projects.locations.collections.dataStores.completeQuery

Complète l'entrée utilisateur spécifiée par des suggestions de mots clés.

Requête HTTP

GET https://discoveryengine.googleapis.com/v1/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:completeQuery

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
dataStore

string

Obligatoire. Nom de ressource du data store parent pour lequel la saisie semi-automatique est effectuée, par exemple projects/*/locations/global/collections/default_collection/dataStores/default_data_store.

Paramètres de requête

Paramètres
query

string

Obligatoire. Saisie de typeahead utilisée pour récupérer les suggestions. Il ne doit pas dépasser 128 caractères.
queryModel

string

Spécifie le modèle de données d'autocomplétion. Cela remplace tout modèle spécifié dans la section Configuration > Saisie semi-automatique de la console Cloud. Valeurs actuellement acceptées :

  • document : utiliser les suggestions générées à partir de documents importés par l'utilisateur
  • search-history : utilise les suggestions générées à partir de l'historique des appels d'API SearchService.Search. Ne l'utilisez pas en l'absence de trafic pour l'API Search.
  • user-event : en utilisant les suggestions générées à partir des événements de recherche importés par l'utilisateur.
  • document-completable : utilise des suggestions tirées directement des champs de documents importés par l'utilisateur et marqués comme "à compléter".

Valeurs par défaut :

  • document est le modèle par défaut pour les dataStores standards.
  • search-history est le modèle par défaut pour les dataStores de recherche sur les sites.
userPseudoId

string

Facultatif. Identifiant unique permettant d'effectuer le suivi des visiteurs. Par exemple, cela peut être implémenté avec un cookie HTTP, qui doit pouvoir identifier de manière unique un visiteur sur un seul appareil. Cet identifiant unique ne doit pas changer si le visiteur se connecte au site Web ou s'en déconnecte.

Ce champ ne doit PAS avoir de valeur fixe telle que unknown_visitor.

Cet identifiant doit être identique à celui de UserEvent.user_pseudo_id et SearchRequest.user_pseudo_id.

Le champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 128 caractères. Sinon, une erreur INVALID_ARGUMENT est renvoyée.
includeTailSuggestions

boolean

Indique si des suggestions de longue traîne doivent être renvoyées si aucune suggestion ne correspond à la requête complète. Même si la valeur est définie sur "true", si des suggestions correspondent à la requête complète, elles sont renvoyées et aucune suggestion de queue n'est renvoyée.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de CompleteQueryResponse.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

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

  • discoveryengine.dataStores.completeQuery

Pour en savoir plus, consultez la documentation IAM.