CompletionConfig

Configuração para personalizar a resposta da API Autocomplete para motores e arquivos de dados. Alguns campos aplicam-se 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 consista 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 atualmente suportados:

  • out-of-order
  • exact-prefix

Valor predefinido: exact-prefix.
maxSuggestions

integer

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

maxSuggestions tem de estar dentro do intervalo [1, 20]. Se não for definida ou for definida como 0, é definida como a predefinição de 20 sugestões.
minPrefixLength

integer

O número mínimo de carateres que têm de ser introduzidos para receber sugestões.

minPrefixLength tem de estar dentro do intervalo [1, 20]. Se não estiver definido ou estiver definido como 0, é definido como a predefinição de 1 caráter.
queryModel

string

O modelo de dados de sugestões de consultas para publicação.

Valores atualmente suportados:

  • automatic – O back-end de preenchimento automático seleciona automaticamente ou mistura sugestões de diferentes modelos.
  • document – Usando sugestões geradas a partir de documentos importados pelo utilizador.
  • search-history - Usando sugestões geradas a partir do histórico anterior de chamadas da API SearchService.Search. Não a use quando não houver tráfego para a API Search.
  • user-event – Usando sugestões geradas a partir de eventos de pesquisa importados pelo utilizador.
  • document-completable – Usando sugestões retiradas diretamente dos campos de documentos importados pelos utilizadores marcados como preenchíveis.

Se o modelo de consulta estiver vazio, o serviço aplica o modelo "automático" por predefinição.
queryFrequencyThreshold

integer

Este campo só é significativo para sugestões geradas a partir de eventos do utilizador ou do histórico de pesquisas. Se uma consulta for apresentada menos vezes do que este limiar, pode indicar que a consulta é raramente pesquisada e, por isso, não é gerada como sugestão. Este campo pode ser útil para impedir que as consultas de PII se tornem sugestões, uma vez que essas consultas são normalmente pesquisadas de forma exclusiva. Se não for definido, o valor predefinido é 8, usado no pipeline de geração.
numUniqueUsersThreshold

integer

Este campo só é significativo para sugestões geradas a partir de eventos do utilizador ou do histórico de pesquisas, que podem ter IDs de utilizadores anexados. Se o número de utilizadores únicos que pesquisaram uma consulta for inferior a este limite, a consulta não é gerada como sugestão. Este campo pode ser útil para impedir que as consultas de PII se tornem sugestões, uma vez que essas consultas são normalmente pesquisadas de forma exclusiva. Se não for definido, o valor predefinido é 3, usado no pipeline de geração.
shouldServeContentSuggestions

boolean

Se devem ser geradas e publicadas sugestões de conteúdo. Isto permite que as sugestões de conteúdo sejam publicadas além das sugestões de consultas.
filterPiiSuggestionsUsingDlp

boolean

Se for verdadeiro, tente, com o melhor esforço possível, detetar e remover as sugestões que contenham determinados tipos de informações de PII. Esta deteção é realizada pela DLP em segundo plano.
enableMode

enum (EnableMode)

O modo de ativação dos pipelines de geração de preenchimento automático. Se este campo não for definido, o comportamento do servidor é predefinido para CompletionConfig.EnableMode.AUTOMATIC. Aplica-se apenas ao DataStore. Ignorado para o motor.

EnableMode

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

Enumerações
ENABLE_MODE_UNSPECIFIED Quando o modo de ativação do preenchimento automático não está especificado, é predefinido para o modo AUTOMÁTICO.
AUTOMATIC O preenchimento automático é ativado quando o repositório de dados cumpre os critérios.
MANUAL O preenchimento automático é ativado independentemente dos requisitos de dados do UCS.