Method: projects.locations.dataStores.completeQuery

Conclui a entrada do utilizador especificada com sugestões de palavras-chave.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
dataStore

string

Obrigatório. O nome do recurso da loja 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 preenchimento automático usada para obter sugestões. O comprimento máximo é de 128 carateres.
queryModel

string

Especifica o modelo de dados de preenchimento automático. Isto substitui qualquer modelo especificado na secção Configuração > Preenchimento automático da Cloud Console. Valores atualmente suportados:

  • document – Usando sugestões geradas a partir de documentos importados pelo utilizador.
  • search-history - Usando sugestões geradas a partir do histórico anterior de chamadas da API SearchService.Search. Não a 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 utilizador.
  • document-completable – Usando sugestões retiradas diretamente dos campos de documentos importados pelos utilizadores marcados como preenchíveis.

Valores predefinidos:

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

string

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 128 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
includeTailSuggestions

boolean

Indica se devem ser devolvidas sugestões finais se não existirem sugestões que correspondam à consulta completa. Mesmo que esteja definido como verdadeiro, se existirem sugestões que correspondam à consulta completa, estas são devolvidas e não são devolvidas sugestões finais.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de CompleteQueryResponse.

Â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.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso dataStore:

  • discoveryengine.dataStores.completeQuery

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