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

Elimina la sugerencia del historial de búsqueda de un buscador para un usuario. De esta forma, la sugerencia no se devolverá en la AdvancedCompleteQueryResponse.recent_search_suggestions de este usuario. Si el usuario vuelve a buscar la misma sugerencia, el nuevo historial la sobrescribirá y la volverá a sugerir.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
completionConfig

string

Obligatorio. completionConfig del nombre de recurso del motor principal del que se va a eliminar la sugerencia del historial de búsqueda, como projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

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

string

Obligatorio. Identificador único para hacer un seguimiento de los visitantes. Por ejemplo, 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 debería cambiar si el visitante inicia o cierra sesión en el 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 128 caracteres.
userInfo

object (UserInfo)

Opcional. Información sobre el usuario final.

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

string (Timestamp format)

Obligatorio. Hora a la que se ha quitado la sugerencia. Si no se define, se usará la hora actual.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
Campo de unión suggestion. La sugerencia que se va a quitar. suggestion solo puede ser una de estas dos opciones:
searchHistorySuggestion

string

La sugerencia del historial de búsqueda que se va a quitar.
removeAllSearchHistorySuggestions

boolean

Elimina todas las sugerencias del historial de búsqueda del usuario.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, el cuerpo de la respuesta estará vacío.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

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