Method: projects.locations.chat

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

Solicitação HTTP

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

O URL usa 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 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "credentials": {
    object (Credentials)
  },
  "thinkingMode": enum (ThinkingMode),
  "model": enum (Model),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineContext": {
    object (Context)
  },
  "conversationReference": {
    object (ConversationReference)
  },
  "dataAgentContext": {
    object (DataAgentContext)
  },
  "clientManagedResourceContext": {
    object (ClientManagedResourceContext)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "lookerSettings": {
    object (LookerSettings)
  }
  // End of mutually exclusive fields.
}
Campos
messages[]

object (Message)

Obrigatório. Conteúdo da conversa atual.
credentials

object (Credentials)

Opcional. As credenciais que serão usadas ao chamar as fontes de dados especificadas no contexto.

Esse campo pode ser usado para fornecer credenciais de várias fontes de dados. Por exemplo, ao se conectar ao Looker, ele aceita credenciais baseadas em tokens OAuth e chaves de API, conforme descrito em Autenticação com um SDK.
thinkingMode

enum (ThinkingMode)

Opcional. O modo de pensamento a ser usado no loop do agente. O padrão é THINKING_MODE_UNSPECIFIED se não for especificado.
model

enum (Model)

Opcional. O modelo a ser usado no loop do agente ao processar a solicitação. Essa configuração só tem efeito quando context.options.model não está definido.
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. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
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 da GDA, incluindo conversas e agentes. Em vez disso, eles criam e gerenciam os próprios recursos de conversas e agentes.
Fim dos campos mutuamente exclusivos.
Configurações opcionais para personalizar o comportamento da solicitação, específicas para a fonte de dados de destino. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
lookerSettings

object (LookerSettings)

Opcional. Configurações específicas do Looker.
Fim dos campos mutuamente exclusivos.

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 um dos seguintes escopos do OAuth:

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

Para mais informações, consulte 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,
  "contextVersion": enum (ContextVersion)
}
Campos
dataAgent

string

Obrigatório. O nome do recurso do agente de dados.
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 podem não usar os 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 pelo gerenciamento de APIs GDA e a persistência do agente, 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.

LookerSettings

Mensagem para manter as configurações personalizadas específicas do Looker.

Representação JSON 
{
  "enableDevMode": boolean
}
Campos
enableDevMode

boolean

Opcional. Se é preciso operar no Modo de Desenvolvimento do Looker. Se for verdadeiro, a sessão da API será alternada para o espaço de trabalho "dev", permitindo a interação com as mudanças do LookML na ramificação de desenvolvimento do usuário. Se ela for definida como "false" ou deixada sem definição, a sessão vai permanecer no estado padrão (Modo de Produção). Consulte https://cloud.google.com/looker/docs/dev-mode-prod-mode.

Credenciais

Representa diferentes formas de especificação das credenciais.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of mutually exclusive fields.
}
Campos
É o tipo de credencial. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
oauth

object (OAuthCredentials)

São as credenciais do OAuth.
Fim dos campos mutuamente exclusivos.

OAuthCredentials

Representa as credenciais do OAuth.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "secret": {
    object (SecretBased)
  },
  "token": {
    object (TokenBased)
  }
  // End of mutually exclusive fields.
}
Campos
É o tipo de credencial do OAuth. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
secret

object (SecretBased)

São credenciais do OAuth baseadas em Secrets.
token

object (TokenBased)

São credenciais do OAuth baseadas em tokens.
Fim dos campos mutuamente exclusivos.

SecretBased

É o nome do Secret que contém o token de acesso. Representa as credenciais do OAuth com base em Secrets.

Representação JSON 
{
  "clientId": string,
  "clientSecret": string
}
Campos
clientId

string

Obrigatório. É um ID do cliente do OAuth.
clientSecret

string

Obrigatório. É uma chave secreta do cliente OAuth.

TokenBased

Saiba mais sobre os tokens de acesso do Looker: https://developers.looker.com/api/advanced-usage/looker-api-oauth

Representação JSON 
{
  "accessToken": string
}
Campos
accessToken

string

Obrigatório. É o nome do Secret que contém o token de acesso.

ThinkingMode

Modo de pensamento do agente.

Tipos enumerados
THINKING_MODE_UNSPECIFIED O valor padrão. Para fontes de dados do BigQuery e do Looker, o agente usa o FAST. Para todas as outras fontes de dados, o agente usa THINKING.
FAST Modo rápido, respostas rápidas.
THINKING Modo de raciocínio, resolve problemas complexos.

Modelo

Seleção de modelo para o agente para usuários do BigQuery.

Tipos enumerados
MODEL_UNSPECIFIED Nenhum modelo especificado. É possível usar o modelo de pré-lançamento ou o modelo padrão.
LATEST_GA_MODEL Use o modelo mais atualizado que não seja de pré-lançamento. Isso pode restringir algumas configurações no nível da solicitação.