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

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

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
completionConfig

string

Obrigatório. O completionConfig do dataStore pai ou o nome do recurso do mecanismo para o qual o preenchimento é realizado, 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 tamanho máximo é de 128 caracteres.

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

string

Especifica o modelo de consulta de preenchimento automático, que só se aplica ao SuggestionType QUERY. 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.
userInfo

object (UserInfo)

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

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

object (BoostSpec)

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

enum (SuggestionType)

Opcional. Tipos de sugestões a serem retornadas. Se estiver em branco ou não for 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

Opcional. IDs de experimentos 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/discoveryengine.readwrite
  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • 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 completionConfig:

  • discoveryengine.completionConfigs.completeQuery

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