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

Remove a sugestão do histórico de pesquisa em um mecanismo para um usuário. Isso vai remover a sugestão dos resultados da AdvancedCompleteQueryResponse.recent_search_suggestions para esse usuário. Se o usuário pesquisar a mesma sugestão de novo, o novo histórico vai substituir e sugerir essa opção novamente.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
completionConfig

string

Obrigatório. O completionConfig do nome do recurso do mecanismo pai para o qual a sugestão do histórico de pesquisa será removida, como projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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

Obrigatório. Um identificador exclusivo para rastrear visitantes. Por exemplo, isso pode ser implementado com um cookie HTTP, que deve ser capaz de identificar um visitante de maneira exclusiva em um único dispositivo. Esse identificador exclusivo não deve mudar se o visitante fizer login ou logout no site.

Esse campo NÃO pode ter um valor fixo, como unknown_visitor.

Precisa ser o mesmo identificador de UserEvent.user_pseudo_id e SearchRequest.user_pseudo_id.

O campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres.
userInfo

object (UserInfo)

Opcional. Informações sobre o usuário final.

Essas informações precisam ser as mesmas de UserEvent.user_info e SearchRequest.user_info.
removeTime

string (Timestamp format)

Obrigatório. Data e hora em que a sugestão foi removida. Se não for definido, a hora atual será usada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
Campo de união suggestion. A sugestão a ser removida. suggestion pode ser apenas de um dos tipos a seguir:
searchHistorySuggestion

string

A sugestão do histórico de pesquisa a ser removida.
removeAllSearchHistorySuggestions

boolean

Remover todas as sugestões do histórico de pesquisa do usuário.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.