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

Supprime la suggestion d'historique de recherche dans un moteur pour un utilisateur. La suggestion ne sera plus renvoyée dans AdvancedCompleteQueryResponse.recent_search_suggestions pour cet utilisateur. Si l'utilisateur recherche à nouveau la même suggestion, le nouvel historique remplacera l'ancien et suggérera à nouveau cette suggestion.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
completionConfig

string

Obligatoire. Nom de la ressource completionConfig du moteur parent pour lequel la suggestion d'historique de recherche doit être supprimée, par exemple projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "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.
}
Champs
userPseudoId

string

Obligatoire. Identifiant unique permettant d'effectuer le suivi des visiteurs. Par exemple, cela peut être implémenté avec un cookie HTTP, qui doit pouvoir identifier de manière unique un visiteur sur un seul appareil. Cet identifiant unique ne doit pas changer si le visiteur se connecte ou se déconnecte du site Web.

Ce champ ne doit PAS avoir de valeur fixe, telle que unknown_visitor.

Il doit s'agir du même identifiant que UserEvent.user_pseudo_id et SearchRequest.user_pseudo_id.

Le champ doit être une chaîne encodée au format UTF-8 d'une longueur maximale de 128 caractères.
userInfo

object (UserInfo)

Facultatif. Informations sur l'utilisateur final.

Il doit s'agir des mêmes informations d'identification que UserEvent.user_info et SearchRequest.user_info.
removeTime

string (Timestamp format)

Obligatoire. Heure à laquelle la suggestion a été supprimée. Si aucune valeur n'est définie, l'heure actuelle est utilisée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
Champ d'union suggestion. Suggestion à supprimer. suggestion ne peut être qu'un des éléments suivants :
searchHistorySuggestion

string

Suggestion d'historique de recherche à supprimer.
removeAllSearchHistorySuggestions

boolean

Supprimer toutes les suggestions d'historique de recherche pour l'utilisateur.

Corps de la réponse

Si la requête aboutit, le corps de la réponse est vide.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • 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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource completionConfig :

  • discoveryengine.completionConfigs.removeSuggestion

Pour en savoir plus, consultez la documentation IAM.