CompletionConfig

Configuration permettant de personnaliser la réponse de l'API Autocomplete pour les moteurs et les data stores. Certains champs ne s'appliquent qu'à l'un d'eux.

Représentation JSON 
{
  "name": string,
  "matchingOrder": string,
  "maxSuggestions": integer,
  "minPrefixLength": integer,
  "queryModel": string,
  "queryFrequencyThreshold": integer,
  "numUniqueUsersThreshold": integer,
  "shouldServeContentSuggestions": boolean,
  "filterPiiSuggestionsUsingDlp": boolean,
  "enableMode": enum (EnableMode)
}
Champs
name

string

Obligatoire. Immuable. Nom complet projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

Ordre de correspondance pour les suggestions de saisie semi-automatique. Par exemple, une requête composée de sh avec out-of-order spécifié suggérera women's shoes, tandis qu'une requête red s avec exact-prefix spécifié suggérera red shoes. Valeurs actuellement acceptées :

  • out-of-order
  • exact-prefix

Valeur par défaut : exact-prefix
maxSuggestions

integer

Nombre maximal de suggestions de saisie semi-automatique renvoyées par terme.

maxSuggestions doit être compris entre 1 et 20. Si elle n'est pas définie ou est définie sur 0, elle est définie sur la valeur par défaut de 20 suggestions.
minPrefixLength

integer

Nombre minimal de caractères à saisir pour obtenir des suggestions.

minPrefixLength doit être compris entre 1 et 20. Si elle n'est pas définie ou est définie sur 0, elle est définie sur la valeur par défaut de 1 caractère.
queryModel

string

Modèle de données des suggestions de requêtes pour la diffusion.

Valeurs actuellement acceptées :

  • automatic : le backend de saisie semi-automatique sélectionne ou combine automatiquement des suggestions provenant de différents modèles.
  • 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".

Si le modèle de requête est vide, la diffusion applique le modèle "automatique" par défaut.
queryFrequencyThreshold

integer

Ce champ n'a de sens que pour les suggestions générées à partir d'événements utilisateur ou de l'historique des recherches. Si une requête s'affiche moins souvent que ce seuil, cela peut indiquer qu'elle est rarement recherchée et qu'elle ne sera donc pas générée en tant que suggestion. Ce champ peut être utile pour empêcher que les requêtes contenant des informations permettant d'identifier personnellement l'utilisateur ne deviennent des suggestions, car ces requêtes sont généralement recherchées de manière unique. Si ce paramètre n'est pas défini, la valeur par défaut 8 utilisée dans le pipeline de génération est appliquée.
numUniqueUsersThreshold

integer

Ce champ n'a de sens que pour les suggestions générées à partir d'événements utilisateur ou de l'historique des recherches, auxquels des ID utilisateur peuvent être associés. Si le nombre d'utilisateurs uniques ayant recherché une requête est inférieur à ce seuil, la requête ne sera pas générée en tant que suggestion. Ce champ peut être utile pour empêcher que les requêtes contenant des informations permettant d'identifier personnellement l'utilisateur ne deviennent des suggestions, car ces requêtes sont généralement recherchées de manière unique. Si ce paramètre n'est pas défini, la valeur par défaut 3 utilisée dans le pipeline de génération est appliquée.
shouldServeContentSuggestions

boolean

Indique si les suggestions de contenu doivent être générées et diffusées. Cela permet de diffuser des suggestions de contenu en plus des suggestions de requêtes.
filterPiiSuggestionsUsingDlp

boolean

Si la valeur est "true", essayez de détecter et de supprimer les suggestions contenant certains types d'informations permettant d'identifier personnellement l'utilisateur. Cette détection est effectuée par DLP en coulisses.
enableMode

enum (EnableMode)

Mode d'activation des pipelines de génération de saisie semi-automatique. Si ce champ n'est pas défini, le comportement du serveur est défini par défaut sur CompletionConfig.EnableMode.AUTOMATIC. S'applique uniquement à DataStore. Ignoré pour Engine.

EnableMode

Spécifie le mode d'activation des pipelines de génération de saisie semi-automatique.

Enums
ENABLE_MODE_UNSPECIFIED Si le mode d'activation de la saisie semi-automatique n'est pas spécifié, le mode AUTOMATIC est utilisé par défaut.
AUTOMATIC La saisie semi-automatique sera activée lorsque le data store répondra aux critères.
MANUAL La saisie semi-automatique sera activée, quels que soient les exigences concernant les données UCS.