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

Método de consulta de resposta (streaming).

Ele recebe uma AnswerQueryRequest e retorna várias mensagens AnswerQueryResponse em um fluxo.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
servingConfig

string

Obrigatório. O nome do recurso da configuração de veiculaçã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.

Ou o nome do recurso da configuração de veiculação do mecanismo do agente, como: projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer. (usar quando enableAgentInvocation estiver definido como verdadeiro e você tiver um mecanismo de agente AI_MODE personalizado configurado)

Esse campo é usado para identificar o nome da configuração de veiculação, o conjunto de modelos usados para fazer a pesquisa.

Corpo da solicitação

O corpo da solicitação 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 usuário 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.

Oferecemos suporte ao modo de sessão automática: os usuários podem usar o caractere curinga - como ID da sessão. Um novo ID será gerado e atribuído automaticamente.
safetySpec

object (SafetySpec)

Especificação do modelo.
relatedQuestionsSpec

object (RelatedQuestionsSpec)

Especificação de perguntas relacionadas.
groundingSpec

object (GroundingSpec)

Opcional. Especificação de embasamento.
answerGenerationSpec

object (AnswerGenerationSpec)

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

object (SearchSpec)

Especificação de servingConfigs.search.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

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

boolean

Descontinuado: esse campo foi descontinuado. A API Streaming Answer será compatível.

Controle do modo assíncrono.

Se ativado, a resposta será retornada com o nome do recurso de resposta/sessão sem a resposta final. Os usuários da API precisam fazer a pesquisa para receber o status mais recente da resposta/sessão chamando o método ConversationalSearchService.GetAnswer ou ConversationalSearchService.GetSession.
userPseudoId

string

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.

O campo precisa ser uma string codificada em UTF-8 com um limite de comprimento de 128 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.
userLabels

map (key: string, value: string)

Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos:

  • Cada recurso pode ter vários rótulos, até um máximo de 64.
  • Cada rótulo precisa ser um par de chave-valor.
  • As chaves têm um comprimento mínimo de 1 caractere e um máximo de 63 caracteres e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres.
  • As chaves e os valores contêm apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos.
  • A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos.
  • As chaves precisam começar com uma letra minúscula ou um caractere internacional.

Consulte o documento do Google Cloud para mais detalhes.
endUserSpec

object (EndUserSpec)

Opcional. Especificação do usuário final.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter um fluxo de instâncias de AnswerQueryResponse.

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/discoveryengine.serving.readwrite

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso servingConfig:

  • discoveryengine.servingConfigs.answer

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