Method: projects.locations.chat

Responde a uma pergunta sobre dados gerando uma stream de objetos Message.

Pedido HTTP


POST https://geminidataanalytics.googleapis.com/v1alpha/{parent=projects/*/locations/*}:chat

Os URLs usam a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O valor principal do pedido de chat. Padrão: projects/{project}/locations/{location}

Corpo do pedido

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

Representação JSON 
{
  "project": string,
  "messages": [
    {
      object (Message)
    }
  ],

  // Union field context_provider can be only one of the following:
  "inlineContext": {
    object (Context)
  },
  "conversationReference": {
    object (ConversationReference)
  },
  "dataAgentContext": {
    object (DataAgentContext)
  },
  "clientManagedResourceContext": {
    object (ClientManagedResourceContext)
  }
  // End of list of possible types for union field context_provider.
}
Campos
project
(deprecated)

string

Opcional. O projeto do Google Cloud a usar para a quota e a faturação.
messages[]

object (Message)

Obrigatório. Conteúdo da conversa atual.
Campo de união context_provider. Fornecedor de contexto para o pedido de chat. Pode ser inline_context, que é um contexto fornecido inline no pedido, data_agent, que é uma referência a um recurso de agente de dados, ou conversation_reference, que é uma referência a uma conversa e um contexto persistentes através de conversation_id e agent_id. context_provider só pode ser uma das seguintes opções:
inlineContext

object (Context)

Opcional. Contexto inline para o pedido de chat. Use esta opção para conversar sem estado (sem persistência de conversas geridas e sem um agente) transmitindo todo o contexto inline.
conversationReference

object (ConversationReference)

Opcional. Referência a uma conversa persistente e ao contexto do agente. Use esta opção para conversar no chat com um agente através da persistência de conversas gerida.
dataAgentContext

object (DataAgentContext)

Opcional. Contexto do pedido de chat. Use esta opção para conversar com um agente sem estado, sem persistência de conversas gerida.
clientManagedResourceContext

object (ClientManagedResourceContext)

Opcional. Contexto com recursos geridos pelo cliente. Alguns clientes podem não usar recursos geridos pela GDA, incluindo conversas e agentes. Em alternativa, criam e gerem os seus próprios recursos de conversas e agentes.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma stream de instâncias de Message.

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

  • https://www.googleapis.com/auth/cloud-platform

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

ConversationReference

Referência a uma conversa persistente e ao contexto do agente.

Representação JSON 
{
  "conversation": string,
  "dataAgentContext": {
    object (DataAgentContext)
  }
}
Campos
conversation

string

Obrigatório. Nome do recurso de conversa. Formato: projects/{project}/locations/{location}/conversations/{conversationId}
dataAgentContext

object (DataAgentContext)

Obrigatório. Contexto do pedido de chat através de um agente de dados.

DataAgentContext

Contexto do pedido de chat através de um agente de dados.

Representação JSON 
{
  "dataAgent": string,
  "credentials": {
    object (Credentials)
  },
  "contextVersion": enum (ContextVersion)
}
Campos
dataAgent

string

Obrigatório. O nome do recurso do agente de dados.
credentials

object (Credentials)

Opcional. As credenciais a usar quando chamar a origem de dados do Looker.

Atualmente, suporta credenciais baseadas em chaves API e tokens OAuth, conforme descrito no artigo Autenticação com um SDK.
contextVersion

enum (ContextVersion)

Opcional. Versão do contexto a ser usada pelo DCS (por exemplo, STAGING, PUBLISHED)

ContextVersion

Lista de versões de contexto suportadas pelo DCS. Existem duas versões do contexto. Isto destina-se a manter o controlo de versões do agente de dados.

Enumerações
CONTEXT_VERSION_UNSPECIFIED Não especificado ou não reconhecido.
STAGING Com esta versão, o DCS usa o contexto de preparação mais recente para o agente de dados.
PUBLISHED Com esta versão, o DCS usa o contexto publicado mais recentemente para o agente de dados.

ClientManagedResourceContext

Contexto com recursos geridos pelo cliente. Alguns clientes podem não usar recursos geridos pela GDA, incluindo conversas e agentes. Em alternativa, criam e gerem os seus próprios recursos de conversas e agentes.

Representação JSON 
{
  "inlineContext": {
    object (Context)
  },
  "conversationId": string,
  "agentId": string
}
Campos
inlineContext

object (Context)

Obrigatório. Contexto do pedido de chat. Use esta opção para conversar sem a conversa gerida pela API GDA e a persistência do agente, transmitindo todo o contexto inline.
conversationId

string

Opcional. O ID da conversa gerida pelo cliente.
agentId

string

Opcional. O ID do agente gerido pelo cliente.