Method: projects.locations.dataStores.completionConfig.completeQuery

Vervollständigt die Nutzereingabe mit erweiterten Keyword-Vorschlägen.

HTTP-Anfrage

POST https://discoveryengine.googleapis.com/v1/{completionConfig=projects/*/locations/*/dataStores/*/completionConfig}:completeQuery

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
completionConfig

string

Erforderlich. Die completionConfig des übergeordneten dataStore- oder Engine-Ressourcennamens, für den die Vervollständigung ausgeführt wird, z. B. projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "includeTailSuggestions": boolean,
  "boostSpec": {
    object (BoostSpec)
  },
  "suggestionTypes": [
    enum (SuggestionType)
  ],
  "suggestionTypeSpecs": [
    {
      object (SuggestionTypeSpec)
    }
  ],
  "experimentIds": [
    string
  ]
}
Felder
query

string

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

Die Suchanfrage darf für die meisten Vorschlagstypen nicht leer sein. Wenn sie leer ist, wird ein INVALID_ARGUMENT-Fehler zurückgegeben. Die Ausnahme ist, wenn „suggestionTypes“ nur den Typ RECENT_SEARCH enthält. In diesem Fall kann die Abfrage ein leerer String sein. Diese Funktion wird als „Null-Präfix“ bezeichnet. Sie gibt die Suchanfragen zurück, nach denen Nutzer zuletzt gesucht haben, wenn die Suchanfrage leer ist.
queryModel

string

Gibt das Modell für die automatische Vervollständigung von Suchanfragen an, das nur für den SuggestionType QUERY gilt. 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.
userInfo

object (UserInfo)

Optional. Informationen zum Endnutzer.

Das sollten dieselben Kennungsinformationen wie UserEvent.user_info und SearchRequest.user_info sein.
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.
boostSpec

object (BoostSpec)

Optional. Spezifikation, um Vorschläge zu optimieren, die der Bedingung entsprechen.
suggestionTypes[]

enum (SuggestionType)

Optional. Vorschlagstypen, die zurückgegeben werden sollen. Wenn leer oder nicht angegeben, werden Suchvorschläge zurückgegeben. Derzeit wird nur ein Vorschlagstyp unterstützt.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

Optional. Spezifikation der einzelnen Vorschlagstypen.
experimentIds[]

string

Optional. Test-IDs für diese Anfrage.

Antworttext

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

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/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • 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 completionConfig:

  • discoveryengine.completionConfigs.completeQuery

Weitere Informationen finden Sie in der IAM-Dokumentation.