CompletionConfig

Configuración para personalizar la respuesta de la API de Autocomplete para motores y almacenes de datos. Algunos campos se aplican solo 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

El orden de coincidencia para las sugerencias de autocompletar. Por ejemplo, una consulta que consta de sh con out-of-order especificado sugeriría women's shoes, mientras que una consulta 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

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

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

El modelo de datos de las sugerencias de consulta para la entrega.

Valores admitidos actualmente:

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

Si el modelo de consulta está vacío, la entrega 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 el historial de búsqueda. Si una consulta aparece menos que este umbral, puede indicar que la consulta rara vez se busca y, por lo tanto, no se generará como sugerencia. Este campo puede ser útil para evitar que las consultas de PII se conviertan en sugerencias, ya que esas consultas suelen ser únicas. Si no se establece, el valor predeterminado es 8, que se usa 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 el historial de búsqueda, que pueden tener IDs de usuario adjuntos. Si la cantidad de usuarios únicos que buscaron 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 PII se conviertan en sugerencias, ya que esas consultas suelen ser únicas. Si no se establece, el valor predeterminado es 3, que se usa en la canalización de generación.
shouldServeContentSuggestions

boolean

Indica si se deben generar y publicar sugerencias de contenido. Esto permite que se publiquen sugerencias de contenido además de las sugerencias de consulta.
filterPiiSuggestionsUsingDlp
(deprecated)

boolean

Obsoleto: Este campo no tiene efecto. A partir de mayo de 2025, el filtrado de sugerencias de PII con DLP siempre estará activado para todos los almacenes de datos y no se podrá configurar por almacén de datos.
enableMode

enum (EnableMode)

El modo de habilitación de las canalizaciones de generación de autocompletar. Si este campo no está configurado, el comportamiento predeterminado del servidor es 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 autocompletar.

Enums
ENABLE_MODE_UNSPECIFIED Cuando el modo de habilitación de AutoComplete no está especificado, se establece de forma predeterminada en el modo AUTOMATIC.
AUTOMATIC AutoComplete se habilitará cuando el almacén de datos cumpla con los criterios.
MANUAL AutoComplete se habilitará independientemente de los requisitos de datos de UCS.