CompletionConfig

Configuração para personalizar a resposta da API Autocomplete para mecanismos e repositórios de dados. Alguns campos são aplicáveis apenas a um deles.

Representação 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

Obrigatório. Imutável. Nome totalmente qualificado projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

A ordem de correspondência para sugestões de preenchimento automático. Por exemplo, uma consulta que consiste em sh com out-of-order especificado sugeriria women's shoes, enquanto uma consulta de red s com exact-prefix especificado sugeriria red shoes. Valores aceitos no momento:

  • out-of-order
  • exact-prefix

Valor padrão: exact-prefix.
maxSuggestions

integer

O número máximo de sugestões de preenchimento automático retornadas por termo.

maxSuggestions precisa estar no intervalo de [1, 20]. Se não for definido ou for definido como 0, ele será definido como o padrão de 20 sugestões.
minPrefixLength

integer

O número mínimo de caracteres que precisam ser digitados para receber sugestões.

minPrefixLength precisa estar no intervalo de [1, 20]. Se não for definido ou for definido como 0, ele será definido como o padrão de 1 caractere.
queryModel

string

O modelo de dados de sugestões de consulta para disponibilização.

Valores aceitos no momento:

  • automatic : o back-end de preenchimento automático seleciona ou mistura sugestões de diferentes modelos.
  • document : usa sugestões geradas a partir de documentos importados pelo usuário.
  • search-history : usa sugestões geradas a partir do histórico de chamadas de API SearchService.Search. Não use quando não houver tráfego para a API Search.
  • user-event : usa sugestões geradas a partir de eventos de pesquisa importados pelo usuário.
  • document-completable : usa sugestões extraídas diretamente de campos de documentos importados pelo usuário marcados como completáveis.

Se o modelo de consulta estiver vazio, a disponibilização vai aplicar o modelo "automático" por padrão.
queryFrequencyThreshold

integer

Esse campo só é significativo para sugestões geradas a partir de eventos do usuário ou histórico de pesquisa. Se uma consulta aparecer com menos frequência do que esse limite, isso poderá indicar que a consulta raramente é pesquisada e, portanto, não será gerada como uma sugestão. Esse campo pode ser útil para evitar que consultas de PII se tornem sugestões, já que essas consultas geralmente são pesquisadas de forma exclusiva. Se não for definido, o valor padrão será 8 usado no pipeline de geração.
numUniqueUsersThreshold

integer

Esse campo só é significativo para sugestões geradas a partir de eventos do usuário ou histórico de pesquisa, que podem ter IDs de usuário anexados. Se o número de usuários únicos que pesquisaram uma consulta for menor que esse limite, a consulta não será gerada como uma sugestão. Esse campo pode ser útil para evitar que consultas de PII se tornem sugestões, já que essas consultas geralmente são pesquisadas de forma exclusiva. Se não for definido, o valor padrão será 3 usado no pipeline de geração.
shouldServeContentSuggestions

boolean

Se as sugestões de conteúdo serão geradas e disponibilizadas. Isso permite que as sugestões de conteúdo sejam disponibilizadas além das sugestões de consulta.
filterPiiSuggestionsUsingDlp
(deprecated)

boolean

Desativado: esse campo não tem efeito. A partir de maio de 2025, a filtragem de sugestões de PII usando DLP estará sempre ativada para todos os repositórios de dados e não poderá ser configurada por repositório de dados.
enableMode

enum (EnableMode)

O modo de ativação dos pipelines de geração de preenchimento automático. Se esse campo não estiver definido, o comportamento do servidor será definido como CompletionConfig.EnableMode.AUTOMATIC. Aplicável apenas ao DataStore. Ignorado para o mecanismo.

EnableMode

Especifica o modo de ativação dos pipelines de geração de preenchimento automático.

Tipos enumerados
ENABLE_MODE_UNSPECIFIED Quando o modo de ativação do preenchimento automático não é especificado, ele é definido como o modo AUTOMÁTICO.
AUTOMATIC O preenchimento automático será ativado quando o repositório de dados atender aos critérios.
MANUAL O preenchimento automático será ativado, independentemente dos requisitos de dados do UCS.