CompletionConfig

Es la configuración para personalizar la respuesta de la API de Autocomplete para los motores y los almacenes de datos. Algunos campos solo se aplican a uno de ellos.

Representación JSON 
{
  "name": string,
  "matchingOrder": string,
  "maxSuggestions": integer,
  "minPrefixLength": integer,
  "queryModel": string,
  "queryFrequencyThreshold": integer,
  "numUniqueUsersThreshold": integer,
  "shouldServeContentSuggestions": boolean,
  "filterPiiSuggestionsUsingDlp": boolean,
  "enableMode": enum (EnableMode)
}
Campos
name

string

Obligatorio. Inmutable. Nombre completamente calificado projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

Es el orden de coincidencia de las sugerencias de autocompletar. Por ejemplo, una búsqueda que consta de sh con out-of-order especificado sugeriría women's shoes, mientras que una búsqueda de red s con exact-prefix especificado sugeriría red shoes. Valores admitidos actualmente:

  • out-of-order
  • exact-prefix

Valor predeterminado: exact-prefix.
maxSuggestions

integer

Es la cantidad máxima de sugerencias de autocompletar que se muestran por término.

maxSuggestions debe estar dentro del rango de [1, 20]. Si no se establece o se establece en 0, se establecerá en el valor predeterminado de 20 sugerencias.
minPrefixLength

integer

Es la cantidad mínima de caracteres que se deben escribir para obtener sugerencias.

minPrefixLength debe estar dentro del rango de [1, 20]. Si no se establece o se establece en 0, se establecerá en el valor predeterminado de 1 carácter.
queryModel

string

Es el modelo de datos de las sugerencias de búsqueda para la entrega.

Valores admitidos actualmente:

  • automatic: El backend de autocompletar selecciona o combina automáticamente sugerencias de diferentes modelos.
  • document: Usar sugerencias generadas a partir de documentos importados por el usuario
  • search-history: Se usan sugerencias generadas a partir del historial de llamadas a la API de SearchService.Search. No lo uses cuando no haya tráfico para la API de Search.
  • user-event: Se usan sugerencias generadas a partir de eventos de búsqueda importados por el usuario.
  • document-completable: Se usan sugerencias tomadas directamente de los campos de documentos importados por el usuario y marcados como completables.

Si el modelo de búsqueda está vacío, la publicación aplica el modelo "automático" de forma predeterminada.
queryFrequencyThreshold

integer

Este campo solo es significativo para las sugerencias generadas a partir de eventos del usuario o del historial de búsqueda. Si una búsqueda aparece menos que este umbral, es posible que indique que rara vez se busca y, por lo tanto, no se generará como sugerencia. Este campo puede ser útil para evitar que las búsquedas de PII se conviertan en sugerencias, ya que esas búsquedas suelen ser únicas. Si no se establece, se usa el valor predeterminado 8 en la canalización de generación.
numUniqueUsersThreshold

integer

Este campo solo es significativo para las sugerencias generadas a partir de eventos del usuario o del historial de búsqueda, que pueden tener IDs de usuario adjuntos. Si la cantidad de usuarios únicos que buscaron una búsqueda es inferior a este umbral, la búsqueda no se generará como sugerencia. Este campo puede ser útil para evitar que las búsquedas de PII se conviertan en sugerencias, ya que esas búsquedas suelen ser únicas. Si no se establece, se usa el valor predeterminado 3 en la canalización de generación.
shouldServeContentSuggestions

boolean

Indica si se deben generar y publicar sugerencias de contenido. Esto permite que se muestren sugerencias de contenido además de las sugerencias de búsqueda.
filterPiiSuggestionsUsingDlp

boolean

Si es verdadero, se intentará detectar y quitar las sugerencias que contengan ciertos tipos de información de PII. DLP realiza esta detección de forma interna.
enableMode

enum (EnableMode)

Es el modo de habilitación de las canalizaciones de generación de autocompletado. Si no se configura este campo, el comportamiento predeterminado del servidor será CompletionConfig.EnableMode.AUTOMATIC. Solo se aplica a DataStore. Se ignora para Engine.

EnableMode

Especifica el modo de habilitación de las canalizaciones de generación de autocompletado.

Enums
ENABLE_MODE_UNSPECIFIED Cuando no se especifica el modo de habilitación de AutoComplete, se usa el modo AUTOMATIC de forma predeterminada.
AUTOMATIC La función de autocompletado se habilitará cuando el almacén de datos cumpla con los criterios.
MANUAL La función de autocompletar se habilitará independientemente de los requisitos de datos de la UCS.