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

Rimuove il suggerimento della cronologia delle ricerche in un motore per un utente. Il suggerimento non verrà più visualizzato in AdvancedCompleteQueryResponse.recent_search_suggestions per questo utente. Se l'utente cerca di nuovo lo stesso suggerimento, la nuova cronologia lo sovrascriverà e lo suggerirà di nuovo.

Richiesta HTTP


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

Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
completionConfig

string

Obbligatorio. Il completionConfig del nome risorsa del motore padre per cui deve essere rimossa il suggerimento della cronologia delle ricerche, ad esempio projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "searchHistorySuggestion": string,
  "removeAllSearchHistorySuggestions": boolean
  // End of mutually exclusive fields.
}
Campi
userPseudoId

string

Obbligatorio. Un identificatore univoco per il monitoraggio dei visitatori. Ad esempio, questa operazione può essere implementata con un cookie HTTP, che dovrebbe essere in grado di identificare in modo univoco un visitatore su un singolo dispositivo. Questo identificatore univoco non deve cambiare se il visitatore si connette o si disconnette dal sito web.

Questo campo NON deve avere un valore fisso come unknown_visitor.

Deve essere lo stesso identificatore di UserEvent.user_pseudo_id e SearchRequest.user_pseudo_id.

Il campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri.

userInfo

object (UserInfo)

Facoltativo. Informazioni sull'utente finale.

Queste informazioni sull'identificatore devono essere le stesse di UserEvent.user_info e SearchRequest.user_info.

removeTime

string (Timestamp format)

Obbligatorio. L'ora in cui è stato rimosso il suggerimento. Se non viene impostato, verrà utilizzato l'orario attuale.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Il suggerimento da rimuovere. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
searchHistorySuggestion

string

Il suggerimento della cronologia delle ricerche da rimuovere.

removeAllSearchHistorySuggestions

boolean

Rimuovi tutti i suggerimenti della cronologia delle ricerche per l'utente.

Fine dei campi che si escludono a vicenda.

Corpo della risposta

In caso di esito positivo, il corpo della risposta è vuoto.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa completionConfig:

  • discoveryengine.completionConfigs.removeSuggestion

Per saperne di più, consulta la documentazione di IAM.