Method: projects.locations.collections.dataStores.completeQuery

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

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
dataStore

string

Erforderlich. Der Ressourcenname des übergeordneten Datenspeichers, für den die Vervollständigung ausgeführt wird, z. B. projects/*/locations/global/collections/default_collection/dataStores/default_data_store.

Suchparameter

Parameter
query

string

Erforderlich. Die typeahead-Eingabe, mit der Vorschläge abgerufen werden. Sie darf maximal 128 Zeichen lang sein.
queryModel

string

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

  • document – verwendet Vorschläge aus von Nutzern importierten Dokumenten
  • 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, die als vervollständigbar gekennzeichnet sind

Standardwerte:

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

string

Optional. 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. Die eindeutige Kennung sollte sich nicht ändern, wenn sich Besucher bei der Website an- oder abmelden.

Dieses Feld sollte KEINEN festen Wert wie unknown_visitor enthalten.

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

Das Feld muss einen UTF-8-codierten String mit maximal 128 Zeichen enthalten. 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 passenden Vorschläge für die gesamte Anfrage gibt. Auch wenn der Wert auf „true“ gesetzt ist, werden ggf. vorhandene Vorschläge für die gesamte Anfrage zurückgegeben und keine für den Schlussteil.

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.