Method: projects.locations.dataStores.completionConfig.completeQuery

Complète la saisie de l'utilisateur avec des suggestions de mots clés avancées.

Requête HTTP

POST https://discoveryengine.googleapis.com/v1beta/{completionConfig=projects/*/locations/*/dataStores/*/completionConfig}:completeQuery

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
completionConfig

string

Obligatoire. Le nom de ressource completionConfig du dataStore ou du moteur parent pour lequel la saisie est effectuée, par exemple projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Corps de la requête

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

Représentation JSON 
{
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "includeTailSuggestions": boolean,
  "boostSpec": {
    object (BoostSpec)
  },
  "suggestionTypes": [
    enum (SuggestionType)
  ],
  "suggestionTypeSpecs": [
    {
      object (SuggestionTypeSpec)
    }
  ],
  "experimentIds": [
    string
  ]
}
Champs
query

string

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

La requête ne peut pas être vide pour la plupart des types de suggestions. Si elle est vide, une erreur INVALID_ARGUMENT est renvoyée. La seule exception concerne le cas où suggestionTypes ne contient que le type RECENT_SEARCH. Dans ce cas, la requête peut être une chaîne vide. Cette fonctionnalité, appelée "préfixe zéro", renvoie les requêtes récemment recherchées par l'utilisateur à partir d'une requête vide.
queryModel

string

Spécifie le modèle de requête de saisie semi-automatique, qui ne s'applique qu'au SuggestionType QUERY. 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 des 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

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 ou se déconnecte du site Web.

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, d'une longueur maximale de 128 caractères.
userInfo

object (UserInfo)

Facultatif. Informations sur l'utilisateur final.

Ces informations d'identification doivent être identiques à celles de UserEvent.user_info et SearchRequest.user_info.
includeTailSuggestions

boolean

Indique si des suggestions de queue longue 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.
boostSpec

object (BoostSpec)

Facultatif. Spécification permettant d'améliorer les suggestions correspondant à la condition.
suggestionTypes[]

enum (SuggestionType)

Facultatif. Types de suggestions à renvoyer. Si ce champ est vide ou non spécifié, des suggestions de requêtes sont renvoyées. Pour le moment, un seul type de suggestion est accepté.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

Facultatif. Spécification de chaque type de suggestion.
experimentIds[]

string

Facultatif. ID de test pour cette requête.

Corps de la réponse

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

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

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

  • discoveryengine.completionConfigs.completeQuery

Pour en savoir plus, consultez la documentation IAM.