CompletionConfig

Konfiguration zum Anpassen der Autocomplete API-Antwort für beide Engines und Datenspeicher. Einige Felder gelten nur für eine der beiden.

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

string

Erforderlich. Nicht veränderbar. Vollständig qualifizierter Name projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

Die Reihenfolge, in der Autocomplete-Vorschläge angezeigt werden.Bei einer Anfrage, die aus sh mit out-of-order besteht, wird beispielsweise women's shoes vorgeschlagen. Bei einer Anfrage, die aus red s mit exact-prefix besteht, wird red shoes vorgeschlagen. Derzeit unterstützte Werte:

  • out-of-order
  • exact-prefix

Standardwert: exact-prefix.
maxSuggestions

integer

Die maximale Anzahl der Vorschläge für die automatische Vervollständigung, die pro Begriff zurückgegeben werden.

„maxSuggestions“ muss im Bereich von [1, 20] liegen. Wenn der Wert nicht festgelegt oder auf 0 gesetzt ist, wird der Standardwert von 20 Vorschlägen verwendet.
minPrefixLength

integer

Die Mindestanzahl an Zeichen, die eingegeben werden müssen, um Vorschläge zu erhalten.

minPrefixLength muss im Bereich [1, 20] liegen. Wenn der Wert nicht festgelegt oder auf 0 gesetzt ist, wird der Standardwert von 1 Zeichen verwendet.
queryModel

string

Das Datenmodell für die Bereitstellung von Abfragevorschlägen.

Derzeit unterstützte Werte:

  • automatic: Das Backend für die automatische Vervollständigung wählt automatisch Vorschläge aus verschiedenen Modellen aus oder kombiniert sie.
  • document – Vorschläge aus von Nutzern importierten Dokumenten verwenden
  • search-history – Vorschläge verwenden, die anhand des bisherigen Verlaufs von SearchService.Search-API-Aufrufen generiert wurden. Verwenden Sie sie nicht, wenn kein Traffic für die Search API vorhanden ist.
  • user-event – Es werden Vorschläge verwendet, die aus von Nutzern importierten Suchvorgängen generiert wurden.
  • document-completable: Vorschläge werden direkt aus den vom Nutzer importierten Dokumentfeldern übernommen, die als „Vervollständigbar“ gekennzeichnet sind.

Wenn das Abfragemodell leer ist, wird standardmäßig das Modell „automatic“ verwendet.
queryFrequencyThreshold

integer

Dieses Feld ist nur für Vorschläge relevant, die aus Nutzerereignissen oder dem Suchverlauf generiert werden. Wenn eine Suchanfrage weniger als diesen Grenzwert erreicht, wird sie möglicherweise nur selten gesucht und daher nicht als Vorschlag generiert. Dieses Feld kann hilfreich sein, um zu verhindern, dass Anfragen mit personenbezogenen Daten zu Vorschlägen werden, da diese Anfragen in der Regel nur einmal gesucht werden. Wenn nicht festgelegt, wird der Standardwert 8 verwendet.
numUniqueUsersThreshold

integer

Dieses Feld ist nur für Vorschläge relevant, die aus Nutzerereignissen oder dem Suchverlauf generiert werden und denen Nutzer-IDs zugewiesen sein können. Wenn die Anzahl der einzelnen Nutzer, die nach einer Suchanfrage gesucht haben, unter diesem Schwellenwert liegt, wird die Suchanfrage nicht als Vorschlag generiert. Dieses Feld kann hilfreich sein, um zu verhindern, dass Anfragen mit personenbezogenen Daten zu Vorschlägen werden, da diese Anfragen in der Regel nur einmal gesucht werden. Wenn nicht festgelegt, wird der Standardwert 3 in der Generierungspipeline verwendet.
shouldServeContentSuggestions

boolean

Ob Inhaltsempfehlungen generiert und bereitgestellt werden sollen. So können neben Suchvorschlägen auch Vorschläge für Inhalte angezeigt werden.
filterPiiSuggestionsUsingDlp

boolean

Wenn „true“, wird versucht, Vorschläge mit bestimmten Arten von personenidentifizierbaren Informationen zu erkennen und zu entfernen. Diese Erkennung wird im Hintergrund von DLP durchgeführt.
enableMode

enum (EnableMode)

Der Aktivierungsmodus von Pipelines für die automatische Vervollständigung. Wenn dieses Feld nicht festgelegt ist, wird standardmäßig CompletionConfig.EnableMode.AUTOMATIC verwendet. Gilt nur für DataStore. Für Engine ignoriert.

EnableMode

Gibt den Aktivierungsmodus von Pipelines für die automatische Vervollständigung an.

Enums
ENABLE_MODE_UNSPECIFIED Wenn der Modus für die automatische Vervollständigung nicht angegeben ist, wird standardmäßig der AUTOMATIC-Modus verwendet.
AUTOMATIC Die automatische Vervollständigung wird aktiviert, wenn der Datenspeicher die Kriterien erfüllt.
MANUAL Die automatische Vervollständigung wird unabhängig von den UCS-Datenanforderungen aktiviert.