Method: projects.locations.collections.engines.completionConfig.removeSuggestion

Entfernt den Vorschlag aus dem Suchverlauf in einer Engine für einen Nutzer. Dadurch wird der Vorschlag für diesen Nutzer nicht mehr in AdvancedCompleteQueryResponse.recent_search_suggestions angezeigt. Wenn der Nutzer noch einmal nach demselben Vorschlag sucht, wird der neue Verlauf überschrieben und dieser Vorschlag wird noch einmal angezeigt.

HTTP-Anfrage

POST https://discoveryengine.googleapis.com/v1beta/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:removeSuggestion

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
completionConfig

string

Erforderlich. Die CompletionConfig des übergeordneten Engine-Ressourcennamens, für die der Vorschlag für den Suchverlauf entfernt werden soll, z. B. projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "removeTime": string,

  // Union field suggestion can be only one of the following:
  "searchHistorySuggestion": string,
  "removeAllSearchHistorySuggestions": boolean
  // End of list of possible types for union field suggestion.
}
Felder
userPseudoId

string

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

removeTime

string (Timestamp format)

Erforderlich. Zeitpunkt, zu dem der Vorschlag entfernt wurde. Wenn nicht festgelegt, wird die aktuelle Uhrzeit verwendet.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

Union-Feld suggestion. Der zu entfernende Vorschlag. Für suggestion ist nur einer der folgenden Werte zulässig:
searchHistorySuggestion

string

Der Vorschlag aus dem Suchverlauf, der entfernt werden soll.

removeAllSearchHistorySuggestions

boolean

Entfernen Sie alle Vorschläge aus dem Suchverlauf für den Nutzer.

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

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.