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 sugere women's shoes, enquanto uma consulta de red s com exact-prefix especificado sugere 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 [1, 20]. Se não for definido ou for definido como 0, o padrão será 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 [1, 20]. Se não for definido ou for definido como 0, ele será definido como o padrão de um caractere.
queryModel

string

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

Valores aceitos no momento:

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

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

integer

Esse campo só é relevante para sugestões geradas com base em eventos do usuário ou no histórico de pesquisa. Se uma consulta aparecer menos do que esse limite, isso pode indicar que ela 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 elas 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ó é relevante para sugestões geradas com base em 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, ela não será gerada como sugestão. Esse campo pode ser útil para evitar que consultas de PII se tornem sugestões, já que elas 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 veiculadas. Isso permite que as sugestões de conteúdo sejam veiculadas além das sugestões de consulta.
filterPiiSuggestionsUsingDlp

boolean

Se for verdadeiro, com o máximo de esforço, tente detectar e remover as sugestões que contêm determinados tipos de informações de identificação pessoal. Essa detecção é realizada pelo DLP nos bastidores.
enableMode

enum (EnableMode)

O modo de ativação dos pipelines de geração de preenchimento automático. Se esse campo não for definido, o comportamento padrão do servidor será CompletionConfig.EnableMode.AUTOMATIC. Válido apenas para o 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 AutoComplete não é especificado, o padrão é o modo AUTOMATIC.
AUTOMATIC O preenchimento automático será ativado quando o repositório de dados atender aos critérios.
MANUAL O preenchimento automático será ativado, independente dos requisitos de dados do UCS.