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

Quita la sugerencia del historial de la Búsqueda en un motor para un usuario. Esto quitará la sugerencia del AdvancedCompleteQueryResponse.recent_search_suggestions para este usuario. Si el usuario vuelve a buscar la misma sugerencia, el historial nuevo anulará la sugerencia anterior y volverá a sugerir esta sugerencia.

Solicitud HTTP


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

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
completionConfig

string

Obligatorio. Es el completionConfig del nombre del recurso del motor principal para el que se quitará la sugerencia del historial de la Búsqueda, como projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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.
}
Campos
userPseudoId

string

Obligatorio. Es un identificador único para hacer un seguimiento de los visitantes. Por ejemplo, esto se podría implementar con una cookie HTTP, que debería poder identificar de forma única a un visitante en un solo dispositivo. Este identificador único no debe cambiar si el visitante se conecta o desconecta del sitio web.

Este campo NO debe tener un valor fijo, como unknown_visitor.

Debe ser el mismo identificador que UserEvent.user_pseudo_id y SearchRequest.user_pseudo_id.

El campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 128.
userInfo

object (UserInfo)

Es opcional. Es la información sobre el usuario final.

Debe ser la misma información del identificador que UserEvent.user_info y SearchRequest.user_info.
removeTime

string (Timestamp format)

Obligatorio. Fecha y hora en que se quitó la sugerencia. Si no se establece, se usará la hora actual.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
Es la sugerencia que se quitará. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
searchHistorySuggestion

string

Es la sugerencia del historial de la Búsqueda que se quitará.
removeAllSearchHistorySuggestions

boolean

Quita todas las sugerencias del historial de la Búsqueda para el usuario.
Fin de los campos mutuamente excluyentes.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta está vacío.

Alcances de autorización

Se necesita uno de los siguientes permisos de 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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso completionConfig:

  • discoveryengine.completionConfigs.removeSuggestion

Para obtener más información, consulta la documentación de IAM.