CompletionConfig

Configurazione per personalizzare la risposta dell'API Autocomplete per motori e datastore. Alcuni campi sono applicabili solo a uno di questi.

Rappresentazione JSON 
{
  "name": string,
  "matchingOrder": string,
  "maxSuggestions": integer,
  "minPrefixLength": integer,
  "queryModel": string,
  "queryFrequencyThreshold": integer,
  "numUniqueUsersThreshold": integer,
  "shouldServeContentSuggestions": boolean,
  "filterPiiSuggestionsUsingDlp": boolean,
  "enableMode": enum (EnableMode)
}
Campi
name

string

Obbligatorio. Immutabile. Nome completo projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

L'ordine di corrispondenza per i suggerimenti di completamento automatico, ad esempio una query composta da sh con out-of-order specificato suggerirebbe women's shoes, mentre una query di red s con exact-prefix specificato suggerirebbe red shoes. Valori attualmente supportati:

  • out-of-order
  • exact-prefix

Valore predefinito: exact-prefix.
maxSuggestions

integer

Il numero massimo di suggerimenti di completamento automatico restituiti per termine.

maxSuggestions deve essere compreso nell'intervallo [1, 20]. Se non viene impostato o è impostato su 0, verrà impostato sul valore predefinito di 20 suggerimenti.
minPrefixLength

integer

Il numero minimo di caratteri da digitare per ricevere suggerimenti.

minPrefixLength deve essere compreso nell'intervallo [1, 20]. Se non viene impostato o è impostato su 0, verrà impostato sul valore predefinito di 1 carattere.
queryModel

string

Il modello dei dati dei suggerimenti per le query per la pubblicazione.

Valori attualmente supportati:

  • automatic - il backend di completamento automatico seleziona o combina automaticamente i suggerimenti di modelli diversi.
  • document - utilizzo dei suggerimenti generati dai documenti importati dall'utente.
  • search-history - utilizzo dei suggerimenti generati dalla cronologia passata delle chiamate API SearchService.Search. Non utilizzarlo quando non c'è traffico per l'API Search.
  • user-event - utilizzo dei suggerimenti generati dagli eventi di ricerca importati dall'utente.
  • document-completable - utilizzo dei suggerimenti presi direttamente dai campi dei documenti importati dall'utente contrassegnati come completabili.

Se il modello di query è vuoto, la pubblicazione applica il modello "automatico" per impostazione predefinita.
queryFrequencyThreshold

integer

Questo campo è significativo solo per i suggerimenti generati da eventi utente o dalla cronologia delle ricerche. Se una query viene visualizzata meno di questa soglia, potrebbe indicare che la query viene cercata raramente e quindi non verrà generata come suggerimento. Questo campo può essere utile per impedire che le query PII diventino suggerimenti, poiché queste query vengono in genere cercate in modo univoco. Se non viene impostato, il valore predefinito è 3 utilizzato nella pipeline di generazione.
numUniqueUsersThreshold

integer

Questo campo è significativo solo per i suggerimenti generati da eventi utente o dalla cronologia delle ricerche, a cui potrebbero essere associati ID utente. Se il numero di utenti unici che hanno cercato una query è inferiore a questa soglia, la query non verrà generata come suggerimento. Questo campo può essere utile per impedire che le query PII diventino suggerimenti, poiché queste query vengono in genere cercate in modo univoco. Se non viene impostato, il valore predefinito è 3 utilizzato nella pipeline di generazione.
shouldServeContentSuggestions

boolean

Indica se generare e pubblicare suggerimenti sui contenuti. In questo modo, i suggerimenti sui contenuti possono essere pubblicati in aggiunta ai suggerimenti per le query.
filterPiiSuggestionsUsingDlp

boolean

Se è true, prova a rilevare e rimuovere i suggerimenti contenenti determinati tipi di informazioni PII. Questo rilevamento viene eseguito da DLP in background.
enableMode

enum (EnableMode)

La modalità di attivazione delle pipeline di generazione del completamento automatico. Se questo campo non è impostato, il comportamento predefinito del server è CompletionConfig.EnableMode.AUTOMATIC. Si applica solo a DataStore. Ignorato per Engine.

EnableMode

Specifica la modalità di attivazione delle pipeline di generazione del completamento automatico.

Enum
ENABLE_MODE_UNSPECIFIED Quando la modalità di attivazione di AutoComplete non è specificata, viene utilizzata la modalità AUTOMATIC per impostazione predefinita.
AUTOMATIC AutoComplete verrà attivato quando il datastore soddisfa i criteri.
MANUAL AutoComplete verrà attivato indipendentemente dai requisiti dei dati UCS.