CompletionConfig

Configurazione per personalizzare la risposta dell'API Autocomplete sia per i motori che per i datastore. Alcuni campi sono applicabili solo a uno dei due.

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 rientrare nell'intervallo [1, 20]. Se non viene impostato o viene 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 rientrare nell'intervallo [1, 20]. Se non è 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 dagli utenti.
  • search-history: utilizza i suggerimenti generati dalla cronologia passata delle chiamate API SearchService.Search. Non utilizzarlo quando non c'è traffico per l'API Search.
  • user-event: utilizzo di suggerimenti generati da eventi di ricerca importati dagli utenti.
  • document-completable: utilizzo di suggerimenti presi direttamente dai campi dei documenti importati dagli utenti 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 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 generalmente cercate in modo univoco. Se non viene impostato, viene utilizzato il valore predefinito 8 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 allegati 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 generalmente cercate in modo univoco. Se non viene impostato, il valore predefinito è 3, utilizzato nella pipeline di generazione.
shouldServeContentSuggestions

boolean

Se generare e pubblicare suggerimenti sui contenuti. In questo modo, oltre ai suggerimenti per le query, vengono visualizzati anche suggerimenti sui contenuti.
filterPiiSuggestionsUsingDlp

boolean

Se è vero, con il massimo impegno, prova a rilevare e rimuovere i suggerimenti contenenti determinati tipi di informazioni PII. Questo rilevamento viene eseguito in background dalla DLP.
enableMode

enum (EnableMode)

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

EnableMode

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

Enum
ENABLE_MODE_UNSPECIFIED Se la modalità di attivazione del completamento automatico non è specificata, viene impostata la modalità AUTOMATICA per impostazione predefinita.
AUTOMATIC Il completamento automatico verrà attivato quando il datastore soddisfa i criteri.
MANUAL Il completamento automatico verrà attivato indipendentemente dai requisiti dei dati UCS.