Method: projects.locations.dataStores.completeQuery

Conclui 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 de repositório de dados pai 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 comprimento 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: usa sugestões geradas a partir de documentos importados pelo usuário.
  • search-history - usando sugestões geradas a partir do histórico de chamadas de API SearchService.Search. Não use quando não houver tráfego para a API Search.
  • user-event - usando sugestões geradas a partir de eventos de pesquisa importados pelo usuário.
  • document-completable - usa sugestões extraídas diretamente de campos de documentos importados pelo usuário marcados como concluíveis.

Valores padrão:

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

string

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

boolean

Indica se as sugestões finais precisam ser retornadas quando não houver sugestões que correspondam à consulta completa. Mesmo que seja definido como verdadeiro, se houver sugestões que correspondam à consulta completa, elas serão retornadas e nenhuma sugestão final 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.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 dataStore:

  • discoveryengine.dataStores.completeQuery

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