Method: projects.locations.collections.dataStores.servingConfigs.answer

Método de consulta de respostas.

Pedido HTTP

POST https://discoveryengine.googleapis.com/v1/{servingConfig=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:answer

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

Parâmetros de caminho

Parâmetros
servingConfig

string

Obrigatório. O nome do recurso da configuração de publicação servingConfigs.search, como projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config ou projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config. Este campo é usado para identificar o nome da configuração de publicação, o conjunto de modelos usados para fazer a pesquisa.

Corpo do pedido

O corpo do pedido contém dados com a seguinte estrutura:

Representação JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "safetySpec": {
    object (SafetySpec)
  },
  "relatedQuestionsSpec": {
    object (RelatedQuestionsSpec)
  },
  "groundingSpec": {
    object (GroundingSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },
  "searchSpec": {
    object (SearchSpec)
  },
  "queryUnderstandingSpec": {
    object (QueryUnderstandingSpec)
  },
  "asynchronousMode": boolean,
  "userPseudoId": string,
  "userLabels": {
    string: string,
    ...
  },
  "endUserSpec": {
    object (EndUserSpec)
  }
}
Campos
query

object (Query)

Obrigatório. Consulta do utilizador atual.
session

string

O nome do recurso da sessão. Não é obrigatório.

Quando o campo de sessão não está definido, a API está no modo sem sessão.

Suportamos o modo de sessão automática: os utilizadores podem usar o símbolo de caráter universal - como ID da sessão. É gerado e atribuído automaticamente um novo ID.
safetySpec

object (SafetySpec)

Especificação do modelo.
relatedQuestionsSpec

object (RelatedQuestionsSpec)

Especificação de perguntas relacionadas.
groundingSpec

object (GroundingSpec)

Opcional. Especificação de superfície de referência.
answerGenerationSpec

object (AnswerGenerationSpec)

Especificação de geração de respostas.
searchSpec

object (SearchSpec)

servingConfigs.search specification.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

Especificação de compreensão de consultas.
asynchronousMode
(deprecated)

boolean

Descontinuado: este campo foi descontinuado. A API Streaming Answer vai ser suportada.

Controlo do modo assíncrono.

Se estiver ativada, a resposta é devolvida com o nome do recurso de resposta/sessão sem a resposta final. Os utilizadores da API têm de fazer a sondagem para obter o estado mais recente da resposta/sessão chamando o método ConversationalSearchService.GetAnswer ou ConversationalSearchService.GetSession.
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.

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

map (key: string, value: string)

As etiquetas de utilizador aplicadas a um recurso têm de cumprir os seguintes requisitos:

  • Cada recurso pode ter várias etiquetas, até um máximo de 64.
  • Cada etiqueta tem de ser um par chave-valor.
  • As chaves têm um comprimento mínimo de 1 carater e um comprimento máximo de 63 carateres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 carateres.
  • As chaves e os valores só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. Todos os carateres têm de usar a codificação UTF-8, e são permitidos carateres internacionais.
  • A parte da chave de uma etiqueta tem de ser exclusiva. No entanto, pode usar a mesma chave com vários recursos.
  • As chaves têm de começar com uma letra minúscula ou um caráter internacional.

Consulte o documento do Google Cloud para ver mais detalhes.
endUserSpec

object (EndUserSpec)

Opcional. Especificação do utilizador final.

Corpo da resposta

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

Â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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

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

  • discoveryengine.servingConfigs.answer

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