CompletionConfig

Configuración para personalizar la respuesta de la API Autocomplete para ambos motores y 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 completo projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

El orden de coincidencia de las sugerencias de Autocompletar. Por ejemplo, una consulta que incluya sh con out-of-order especificado sugeriría women's shoes, mientras que una consulta que incluya red s con exact-prefix especificado sugeriría red shoes. Valores admitidos actualmente:

  • out-of-order
  • exact-prefix

Valor predeterminado: exact-prefix.
maxSuggestions

integer

Número máximo de sugerencias de autocompletar devueltas por término.

maxSuggestions debe estar en el intervalo [1, 20]. Si no se define o se define en 0, se le asignará el valor predeterminado de 20 sugerencias.
minPrefixLength

integer

El número mínimo de caracteres que se deben escribir para obtener sugerencias.

minPrefixLength debe estar comprendido entre 1 y 20. Si no se define o se define como 0, se le asignará el valor predeterminado de 1 carácter.
queryModel

string

El modelo de datos de las sugerencias de consulta para el servicio.

Valores admitidos actualmente:

  • automatic: Autocompletar backend selecciona automáticamente o combina sugerencias de diferentes modelos.
  • document: usar sugerencias generadas a partir de documentos importados por los usuarios.
  • search-history: se usan sugerencias generadas a partir del historial de llamadas a la API SearchService.Search. No la uses cuando no haya tráfico para la API Search.
  • user-event: se usan sugerencias generadas a partir de eventos de búsqueda importados por los usuarios.
  • document-completable: se usan sugerencias tomadas directamente de los campos de documentos importados por los usuarios que están marcados como completables.

Si el modelo de consulta está vacío, el servicio aplica el modelo "automático" de forma predeterminada.
queryFrequencyThreshold

integer

Este campo solo es útil para las sugerencias generadas a partir de eventos de usuario o del historial de búsqueda. Si una consulta se muestra por debajo de este umbral, puede indicar que rara vez se busca y, por lo tanto, no se generará como sugerencia. Este campo puede ser útil para evitar que las consultas de información personal identificable se conviertan en sugerencias, ya que esas consultas suelen buscarse de forma única. Si no se define, se usará el valor predeterminado 8 en la canalización de generación.
numUniqueUsersThreshold

integer

Este campo solo es útil para las sugerencias generadas a partir de eventos de usuario o del historial de búsqueda, que pueden tener IDs de usuario asociados. Si el número de usuarios únicos que han buscado una consulta es inferior a este umbral, la consulta no se generará como sugerencia. Este campo puede ser útil para evitar que las consultas de información personal identificable se conviertan en sugerencias, ya que esas consultas suelen buscarse de forma única. Si no se define, se usa el valor predeterminado 3 en la canalización de generación.
shouldServeContentSuggestions

boolean

Si se deben generar y servir sugerencias de contenido. De esta forma, se pueden ofrecer sugerencias de contenido además de sugerencias de consulta.
filterPiiSuggestionsUsingDlp

boolean

Si el valor es "true", se intentará detectar y eliminar las sugerencias que contengan determinados tipos de información personal identificable. Esta detección se realiza mediante DLP.
enableMode

enum (EnableMode)

El modo de habilitación de las canalizaciones de generación de autocompletado. Si no se define este campo, el comportamiento predeterminado del servidor será CompletionConfig.EnableMode.AUTOMATIC. Solo se aplica a DataStore. Ignorado por el buscador.

EnableMode

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

Enumeraciones
ENABLE_MODE_UNSPECIFIED Si no se especifica el modo de habilitación de Autocompletar, se usa el modo AUTOMATIC de forma predeterminada.
AUTOMATIC La función Autocompletar se habilitará cuando el almacén de datos cumpla los criterios.
MANUAL La función Autocompletar se habilitará independientemente de los requisitos de datos de UCS.