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

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

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
completionConfig

string

Obrigatório. O completionConfig do dataStore principal ou do nome do recurso do motor 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 do pedido

O corpo do pedido 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 preenchimento automático usada para obter sugestões. O comprimento máximo é de 128 carateres.

A consulta não pode estar vazia para a maioria dos tipos de sugestões. Se estiver vazio, é devolvido um erro INVALID_ARGUMENT. A exceção é quando suggestionTypes contém apenas o tipo RECENT_SEARCH. Nesse caso, a consulta pode ser uma string vazia. Esta funcionalidade chama-se "prefixo zero" e devolve as consultas pesquisadas recentemente pelo utilizador, dada a consulta vazia.
queryModel

string

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

object (UserInfo)

Opcional. Informações sobre o utilizador final.

Estas devem ser as mesmas informações de identificador que UserEvent.user_info e SearchRequest.user_info.
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.
boostSpec

object (BoostSpec)

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

enum (SuggestionType)

Opcional. Tipos de sugestões a devolver. Se estiver vazio ou não especificado, são devolvidas sugestões de consultas. De momento, apenas é suportado um tipo de sugestão.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

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

string

Opcional. IDs de experiências para este pedido.

Corpo da resposta

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

Â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/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • 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 completionConfig:

  • discoveryengine.completionConfigs.completeQuery

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