Method: projects.locations.chat

Responde a uma pergunta sobre dados gerando um fluxo de objetos Message.

Solicitação HTTP


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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O valor pai da solicitação de chat. Padrão: projects/{project}/locations/{location}

Corpo da solicitação

O corpo da solicitação 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 ser usado para cota e faturamento.

messages[]

object (Message)

Obrigatório. Conteúdo da conversa atual.

Campo de união context_provider. O provedor de contexto da solicitação de conversa. Pode ser inline_context, que é um contexto informado inline na solicitação; data_agent, uma referência a um recurso de agente de dados; ou conversation_reference, uma referência a uma conversa e um contexto permanentes usando conversation_id e agent_id. context_provider pode ser apenas de um dos tipos a seguir:
inlineContext

object (Context)

Opcional. O contexto inline da solicitação de conversa. Use isso para conversar sem estado (sem permanência de conversa gerenciada e sem um agente) transmitindo todo o contexto inline.

conversationReference

object (ConversationReference)

Opcional. Referência a uma conversa e um contexto de agente permanentes. Use isso para conversar com um agente usando a permanência de conversa gerenciada.

dataAgentContext

object (DataAgentContext)

Opcional. O contexto da solicitação de conversa. Use isso para conversar com um agente sem estado, sem permanência de conversa gerenciada.

clientManagedResourceContext

object (ClientManagedResourceContext)

Opcional. Contexto com recursos gerenciados pelo cliente. Alguns clientes não usam recursos gerenciados pelo GDA, incluindo conversas e agentes. Em vez disso, eles criam e gerenciam os próprios recursos de conversas e agentes.

Corpo da resposta

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

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Saiba mais em Authentication Overview.

ConversationReference

Referência a uma conversa e um contexto de agente permanentes.

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

string

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

dataAgentContext

object (DataAgentContext)

Obrigatório. O contexto da solicitação de conversa usando um agente de dados.

DataAgentContext

O contexto da solicitação de conversa usando 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 serem usadas ao chamar a fonte de dados do Looker.

Atualmente, são aceitas credenciais baseadas em tokens OAuth e chaves de API, conforme descrito em Autenticação com um SDK.

contextVersion

enum (ContextVersion)

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

ContextVersion

Lista das versões de contexto compatíveis com o DCS. Há duas versões de contexto. Isso é para manter o controle de versões do agente de dados.

Tipos enumerados
CONTEXT_VERSION_UNSPECIFIED Não especificado ou não reconhecido.
STAGING Com essa versão, o DCS vai usar o contexto de preparação mais recente para o agente de dados.
PUBLISHED Com essa versão, o DCS vai usar o contexto publicado mais recente para o agente de dados.

ClientManagedResourceContext

Contexto com recursos gerenciados pelo cliente. Alguns clientes não usam recursos gerenciados pelo GDA, incluindo conversas e agentes. Em vez disso, eles criam e gerenciam os próprios recursos de conversas e agentes.

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

object (Context)

Obrigatório. O contexto da solicitação de conversa. Use isso para conversar sem a conversa gerenciada e a permanência do agente da API GDA transmitindo todo o contexto inline.

conversationId

string

Opcional. O ID da conversa gerenciada pelo cliente.

agentId

string

Opcional. O ID do agente gerenciado pelo cliente.