CompletionConfig

Konfiguration zum Anpassen der API-Antwort für die automatische Vervollständigung für Engines und für Datenspeicher. Manche Felder gelten nur für eines von 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. Voll qualifizierter Name projects/*/locations/*/dataStores/*/completionConfig, projects/*/locations/*/collections/*/dataStores/*/completionConfig, projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

Die Abgleichreihenfolge für Vorschläge der automatischen Vervollständigung. Beispielsweise würde bei einer Abfrage mit sh und der Angabe out-of-order women's shoes vorgeschlagen. Bei einer Abfrage mit red s und der Angabe exact-prefix würde jedoch 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 automatische Vervollständigung, die pro Begriff zurückgegeben werden.

„MaxSuggestions“ muss im Bereich von [1, 20] liegen. Wenn der Wert nicht festgelegt oder 0 ist, wird er standardmäßig auf 20 Vorschläge gesetzt.
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 0 ist, wird er standardmäßig auf 1 Zeichen gesetzt.
queryModel

string

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

Derzeit unterstützte Werte:

  • automatic – das Backend für automatische Vervollständigung wählt automatisch Vorschläge aus verschiedenen Modellen aus oder kombiniert sie.
  • document – verwendet Vorschläge, die aus von Nutzern importierten Dokumenten generiert werden.
  • search-history – verwendet Vorschläge, die aus dem bisherigen Verlauf von SearchService.Search API-Aufrufen generiert wurden. Sollte nicht verwendet werden, wenn kein Traffic für die Search API vorhanden ist.
  • user-event – verwendet Vorschläge, die aus von Nutzern importierten Suchvorgängen generiert wurden.
  • document-completable – verwendet Vorschläge, die direkt aus von Nutzern importierten Dokumentfeldern entnommen wurden und 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 Abfrage unter diesem Schwellenwert liegt, kann dies darauf hinweisen, dass die Abfrage nur selten gesucht wird und daher nicht als Vorschlag generiert wird. Dieses Feld kann hilfreich sein, um zu verhindern, dass Abfragen mit personenidentifizierbaren Informationen als Vorschläge angezeigt werden, da solche Abfragen in der Regel nur einmalig gesucht werden. Wenn nichts festgelegt ist, wird der Standardwert 8 in der Generierungspipeline verwendet.
numUniqueUsersThreshold

integer

Dieses Feld ist nur für Vorschläge relevant, die aus Nutzerereignissen oder dem Suchverlauf generiert wurden und denen möglicherweise Nutzer-IDs zugeordnet sind. Wenn die Anzahl der einzelnen Nutzer, die nach einem Suchbegriff gesucht haben, unter diesem Schwellenwert liegt, wird der Suchbegriff nicht als Vorschlag generiert. Dieses Feld kann hilfreich sein, um zu verhindern, dass Abfragen mit personenidentifizierbaren Informationen als Vorschläge angezeigt werden, da solche Abfragen in der Regel nur einmalig gesucht werden. Wenn nichts festgelegt ist, wird der Standardwert 3 in der Generierungspipeline verwendet.
shouldServeContentSuggestions

boolean

Gibt an, ob Inhaltsempfehlungen generiert und bereitgestellt werden sollen. So können zusätzlich zu Suchvorschlägen auch Vorschläge für Inhalte angezeigt werden.
filterPiiSuggestionsUsingDlp

boolean

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

enum (EnableMode)

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

EnableMode

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

Enums
ENABLE_MODE_UNSPECIFIED Wenn kein Modus für die automatische Vervollständigung angegeben ist, wird standardmäßig der Modus AUTOMATIC 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.