Method: projects.locations.dataStores.completionConfig.completeQuery

Conclui a entrada do usuário com sugestões avançadas de palavras-chave.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
completionConfig

string

Obrigatório. O nome do recurso completionConfig do dataStore ou do mecanismo pai para o qual a conclusão é realizada, como projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig 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 
{
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "includeTailSuggestions": boolean,
  "boostSpec": {
    object (BoostSpec)
  },
  "suggestionTypes": [
    enum (SuggestionType)
  ],
  "suggestionTypeSpecs": [
    {
      object (SuggestionTypeSpec)
    }
  ],
  "experimentIds": [
    string
  ]
}
Campos
query

string

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

A consulta não pode estar vazia para a maioria dos tipos de sugestão. Se estiver vazia, um erro INVALID_ARGUMENT será retornado. A exceção é quando suggestionTypes contém apenas o tipo RECENT_SEARCH. Nesse caso, a consulta pode ser uma string vazia. Esse recurso é chamado de "prefixo zero" e retorna as consultas pesquisadas recentemente pelo usuário, considerando a consulta vazia.
queryModel

string

Especifica o modelo de consulta de preenchimento automático, que se aplica apenas ao SuggestionType de QUERY. 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 dos campos de documentos importados pelo usuário marcados como completá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.
userInfo

object (UserInfo)

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

Essas informações de identificação precisam ser as mesmas de UserEvent.user_info e SearchRequest.user_info.
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.
boostSpec

object (BoostSpec)

Opcional. Especificação para aumentar as sugestões que correspondem à condição.
suggestionTypes[]

enum (SuggestionType)

Opcional. Tipos de sugestão a serem retornados. Se estiver vazio ou não especificado, as sugestões de consulta serão retornadas. No momento, apenas um tipo de sugestão é aceito.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

Opcional. Especificação de cada tipo de sugestão.
experimentIds[]

string

IDs de experimentos opcionais para esta solicitação.

Corpo da resposta

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

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • 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.completeQuery

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