Method: projects.locations.collections.dataStores.completionConfig.completeQuery

HTTP-Anfrage
Pfadparameter
Anfragetext
- JSON-Darstellung
Antworttext
Autorisierungsbereiche
IAM-Berechtigungen

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

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter

Parameter
`completionConfig`	`string` Erforderlich. Die „completionConfig“ des übergeordneten Datenspeicher- 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`.

completionConfig

string

Erforderlich. Die „completionConfig“ des übergeordneten Datenspeicher- 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

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

{
  "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. Sie darf maximal 63 Zeichen lang sein. Für die meisten Vorschlagstypen darf die Anfrage nicht leer sein. Wenn sie leer ist, wird ein `INVALID_ARGUMENT`-Fehler zurückgegeben. Eine Ausnahme besteht, wenn die „suggestionTypes“ nur den Typ `RECENT_SEARCH` enthalten. In diesem Fall kann die Anfrage leer sein. Diese Funktion wird als „Null-Präfix“ bezeichnet und gibt die zuletzt vom Nutzer durchgeführten Suchanfragen zurück.
`queryModel`	`string` Gibt das Modell für die automatische Vervollständigung von Suchanfragen an und gilt nur für den SuggestionType QUERY. 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 Datenspeicher. `search-history` ist das Standardmodell für Datenspeicher für Site Search.
`userPseudoId`	`string` Eine eindeutige Kennung für das Tracking von Besuchern. Dies kann beispielsweise mit einem HTTP-Cookie implementiert werden, mit dem Besucher auf einem einzelnen Gerät eindeutig identifiziert werden können. Die eindeutige Kennung sollte sich nicht ändern, wenn sich Besucher auf der Website an- oder abmelden. Dieses Feld sollte KEINEN festen Wert wie `unknown_visitor` enthalten. Es 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.
`userInfo`	`object (UserInfo)` Optional. Informationen zum Endnutzer. Es sollte dieselben Kennungsinformationen wie unter `UserEvent.user_info` und `SearchRequest.user_info` enthalten.
`includeTailSuggestions`	`boolean` Gibt an, ob Vorschläge für den Schlussteil zurückgegeben werden sollen, wenn es keine Vorschläge für die gesamte Anfrage gibt. Auch wenn der Wert auf „true“ gesetzt ist, werden, wenn Vorschläge für die gesamte Anfrage vorhanden sind, diese zurückgegeben und keine für den Schlussteil.
`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. Experiment-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.

Method: projects.locations.collections.dataStores.completionConfig.completeQuery Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.