Method: projects.locations.dataStores.completeQuery

Completa a entrada do usuário especificada com sugestões de palavras-chave.

Solicitação HTTP

GET https://discoveryengine.googleapis.com/v1beta/{dataStore=projects/*/locations/*/dataStores/*}:completeQuery

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

Parâmetros de caminho

Parâmetros
dataStore

string

Obrigatório. O nome do recurso do repositório de dados principal para o qual a conclusão é realizada, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store.

Parâmetros de consulta

Parâmetros
query

string

Obrigatório. A entrada de typeahead usada para buscar sugestões. O tamanho máximo é de 128 caracteres.
queryModel

string

Especifica o modelo de dados de preenchimento automático. Isso substitui qualquer modelo especificado na seção "Configuração" > "Preenchimento automático" do console do Cloud. Valores aceitos no momento:

  • document: usando sugestões geradas com base em documentos importados pelo usuário.
  • search-history: usando sugestões geradas com base no histórico de chamadas da API SearchService.Search. Não use quando não houver tráfego para a API Search.
  • user-event: usando sugestões geradas com base em eventos de pesquisa importados pelo usuário.
  • document-completable: usando sugestões extraídas diretamente dos campos de documentos importados pelo usuário marcados como completáveis.

Valores padrão:

  • document é o modelo padrão para dataStores regulares.
  • search-history é o modelo padrão para dataStores de pesquisa no site.
userPseudoId

string

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. Caso contrário, um erro INVALID_ARGUMENT será retornado.
includeTailSuggestions

boolean

Indica se as sugestões de cauda devem ser retornadas se não houver sugestões que correspondam à consulta completa. Mesmo que seja definido como "true", se houver sugestões que correspondam à consulta completa, elas serão retornadas, e nenhuma sugestão de cauda será retornada.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de CompleteQueryResponse.

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.

Permissões do IAM

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

  • discoveryengine.dataStores.completeQuery

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