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 de ser retornada em AdvancedCompleteQueryResponse.recent_search_suggestions para esse usuário. Se o usuário pesquisar a mesma sugestão novamente, o novo histórico vai substituir e sugerir essa sugestão novamente.

Solicitação HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{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,

  // 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

Obrigatório. Um identificador exclusivo para rastrear visitantes. Por exemplo, isso pode ser implementado com um cookie HTTP, que precisa identificar um visitante em um único dispositivo. Esse identificador exclusivo não muda se o visitante fizer login ou logout do site.

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

Ele precisa ser o mesmo identificador que UserEvent.user_pseudo_id e SearchRequest.user_pseudo_id.

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

object (UserInfo)

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

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

string (Timestamp format)

Obrigatório. 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".
A sugestão a ser removida. A seguir, há uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
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.
Fim dos campos mutuamente exclusivos.

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.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso completionConfig:

  • discoveryengine.completionConfigs.removeSuggestion

Para mais informações, consulte a documentação do IAM.