Method: projects.locations.collections.dataStores.completeQuery

Vervollständigt die angegebene Nutzereingabe mit Keyword-Vorschlägen

HTTP-Anfrage

GET https://discoveryengine.googleapis.com/v1/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:completeQuery

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
dataStore

string

Erforderlich. Der Name der übergeordneten Datenbankspeicherressource, für die die Vervollständigung ausgeführt wird, z. B. projects/*/locations/global/collections/default_collection/dataStores/default_data_store.

Abfrageparameter

Parameter
query

string

Erforderlich. Die Typeahead-Eingabe, mit der Vorschläge abgerufen werden. Die maximale Länge beträgt 128 Zeichen.
queryModel

string

Gibt das Datenmodell für die automatische Vervollständigung an. Dadurch wird jedes Modell überschrieben, das in der Cloud Console unter „Konfiguration“ > „Autovervollständigung“ angegeben ist. Derzeit unterstützte Werte:

  • 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.

Standardwerte:

  • document ist das Standardmodell für reguläre DataStores.
  • search-history ist das Standardmodell für DataStores für die Websitesuche.
userPseudoId

string

Eine eindeutige Kennung für das Tracking von Besuchern. Dies kann beispielsweise mit einem HTTP-Cookie implementiert werden, mit dem ein Besucher auf einem einzelnen Gerät eindeutig identifiziert werden kann. Diese eindeutige Kennung sollte sich nicht ändern, wenn sich der Besucher auf der Website an- oder abmeldet.

Dieses Feld sollte KEINEN festen Wert wie unknown_visitor haben.

Dies sollte dieselbe Kennung wie UserEvent.user_pseudo_id und SearchRequest.user_pseudo_id sein.

Das Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
includeTailSuggestions

boolean

Gibt an, ob Vorschläge für den Schlussteil zurückgegeben werden sollen, wenn es keine Vorschläge gibt, die der vollständigen Anfrage entsprechen. Auch wenn der Wert auf „true“ gesetzt ist, werden Vorschläge, die der vollständigen Anfrage entsprechen, zurückgegeben und keine Vorschläge für den Tail.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von CompleteQueryResponse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource dataStore:

  • discoveryengine.dataStores.completeQuery

Weitere Informationen finden Sie in der IAM-Dokumentation.