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

Remove a sugestão do histórico de pesquisas num motor para um utilizador. Esta ação remove a sugestão dos resultados devolvidos no AdvancedCompleteQueryResponse.recent_search_suggestions para este utilizador. Se o utilizador pesquisar novamente a mesma sugestão, o novo histórico substitui a sugestão anterior e sugere esta sugestão novamente.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
completionConfig

string

Obrigatório. O completionConfig do nome do recurso do motor principal para o qual a sugestão do histórico de pesquisas vai ser removida, como projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Corpo do pedido

O corpo do pedido 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 acompanhar os visitantes. Por exemplo, isto pode ser implementado com um cookie HTTP, que deve ser capaz de identificar de forma exclusiva um visitante num único dispositivo. Este identificador exclusivo não deve ser alterado se o visitante iniciar ou terminar sessão no Website.

Este campo NÃO deve ter um valor fixo, como unknown_visitor.

Este deve ser o mesmo identificador que UserEvent.user_pseudo_id e SearchRequest.user_pseudo_id.

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

object (UserInfo)

Opcional. Informações sobre o utilizador final.

Estas devem 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 estiver definida, é usada a hora atual.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 remover. suggestion só pode ser uma das seguintes opções:
searchHistorySuggestion

string

A sugestão do histórico de pesquisas a remover.
removeAllSearchHistorySuggestions

boolean

Remover todas as sugestões do histórico de pesquisas do utilizador.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta está vazio.

Âmbitos de autorização

Requer um dos seguintes âmbitos 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 o Authentication Overview.