- Solicitação HTTP
- Parâmetros do caminho
- Corpo da solicitação
- Corpo de resposta
- Escopos de autorização
- Referência de Conversação
- Contexto do Agente de Dados
- ContextVersion
Responde a uma pergunta de dados gerando um fluxo de objetos Message
.
Solicitação HTTP
POST https://geminidataanalytics.googleapis.com/v1alpha/{parent=projects/*/locations/*}:chat
A URL usa a sintaxe de transcodificação gRPC .
Parâmetros do caminho
Parâmetros | |
---|---|
parent | Obrigatório. O valor pai para solicitação de bate-papo. 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 ( |
Campos | |
---|---|
project | Opcional. O Google Cloud projeto a ser utilizado para cota e faturamento. |
messages[] | Obrigatório. Conteúdo da conversa atual. |
Campo de união context_provider . Provedor de contexto para a solicitação de bate-papo. Pode ser: inline_context, que é um contexto fornecido em linha na solicitação; data_agent, que é uma referência a um recurso do agente de dados; conversation_reference, que é uma referência a uma conversa e contexto persistentes usando conversation_id e agent_id. context_provider pode ser apenas um dos seguintes: | |
inlineContext | Opcional. Contexto em linha para a solicitação de bate-papo. Use isso para bater papo sem estado (sem persistência de conversa gerenciada e sem um agente), passando todo o contexto em linha. |
conversationReference | Opcional. Referência a uma conversa persistente e ao contexto do agente. Use isto para conversar com um agente usando persistência de conversa gerenciada. |
dataAgentContext | Opcional. Contexto para a solicitação de bate-papo. Use isto para bater papo com um agente sem estado, sem persistência de conversa gerenciada. |
Corpo de resposta
Se bem-sucedido, o corpo da resposta conterá um fluxo de instâncias Message
.
Escopos de autorização
Requer o seguinte escopo OAuth:
-
https://www.googleapis.com/auth/cloud-platform
Para mais informações, consulte oAuthentication Overview .
Referência de Conversação
Referência a uma conversa persistente e contexto de agente.
Representação JSON |
---|
{
"conversation": string,
"dataAgentContext": {
object ( |
Campos | |
---|---|
conversation | Obrigatório. Nome do recurso de conversação. Formato: projects/{project}/locations/{location}/conversations/{conversationId} |
dataAgentContext | Obrigatório. Contexto para a solicitação de bate-papo usando um agente de dados. |
Contexto do Agente de Dados
Contexto para a solicitação de bate-papo usando um agente de dados.
Representação JSON |
---|
{ "dataAgent": string, "credentials": { object ( |
Campos | |
---|---|
dataAgent | Obrigatório. O nome do recurso do agente de dados. |
credentials | Opcional. As credenciais a serem usadas ao chamar a fonte de dados do Looker Atualmente, oferece suporte a credenciais baseadas em tokens OAuth e chaves de API, conforme descrito em https://cloud.google.com/looker/docs/api-auth#authentication_with_an_sdk |
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. Há duas versões de contexto. Isso serve para manter o controle de versão do agente de dados.
Enumerações | |
---|---|
CONTEXT_VERSION_UNSPECIFIED | Não especificado ou não reconhecido. |
STAGING | Usando esta versão, o DCS usará o contexto de preparação mais recente para o agente de dados. |
PUBLISHED | Usando esta versão, o DCS usará o contexto publicado mais recente para o agente de dados. |
- Solicitação HTTP
- Parâmetros do caminho
- Corpo da solicitação
- Corpo de resposta
- Escopos de autorização
- Referência de Conversação
- Contexto do Agente de Dados
- ContextVersion
Responde a uma pergunta de dados gerando um fluxo de objetos Message
.
Solicitação HTTP
POST https://geminidataanalytics.googleapis.com/v1alpha/{parent=projects/*/locations/*}:chat
A URL usa a sintaxe de transcodificação gRPC .
Parâmetros do caminho
Parâmetros | |
---|---|
parent | Obrigatório. O valor pai para solicitação de bate-papo. 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 ( |
Campos | |
---|---|
project | Opcional. O Google Cloud projeto a ser utilizado para cota e faturamento. |
messages[] | Obrigatório. Conteúdo da conversa atual. |
Campo de união context_provider . Provedor de contexto para a solicitação de bate-papo. Pode ser: inline_context, que é um contexto fornecido em linha na solicitação; data_agent, que é uma referência a um recurso do agente de dados; conversation_reference, que é uma referência a uma conversa e contexto persistentes usando conversation_id e agent_id. context_provider pode ser apenas um dos seguintes: | |
inlineContext | Opcional. Contexto em linha para a solicitação de bate-papo. Use isso para bater papo sem estado (sem persistência de conversa gerenciada e sem um agente), passando todo o contexto em linha. |
conversationReference | Opcional. Referência a uma conversa persistente e ao contexto do agente. Use isto para conversar com um agente usando persistência de conversa gerenciada. |
dataAgentContext | Opcional. Contexto para a solicitação de bate-papo. Use isto para bater papo com um agente sem estado, sem persistência de conversa gerenciada. |
Corpo de resposta
Se bem-sucedido, o corpo da resposta conterá um fluxo de instâncias Message
.
Escopos de autorização
Requer o seguinte escopo OAuth:
-
https://www.googleapis.com/auth/cloud-platform
Para mais informações, consulte oAuthentication Overview .
Referência de Conversação
Referência a uma conversa persistente e contexto de agente.
Representação JSON |
---|
{
"conversation": string,
"dataAgentContext": {
object ( |
Campos | |
---|---|
conversation | Obrigatório. Nome do recurso de conversação. Formato: projects/{project}/locations/{location}/conversations/{conversationId} |
dataAgentContext | Obrigatório. Contexto para a solicitação de bate-papo usando um agente de dados. |
Contexto do Agente de Dados
Contexto para a solicitação de bate-papo usando um agente de dados.
Representação JSON |
---|
{ "dataAgent": string, "credentials": { object ( |
Campos | |
---|---|
dataAgent | Obrigatório. O nome do recurso do agente de dados. |
credentials | Opcional. As credenciais a serem usadas ao chamar a fonte de dados do Looker Atualmente, oferece suporte a credenciais baseadas em tokens OAuth e chaves de API, conforme descrito em https://cloud.google.com/looker/docs/api-auth#authentication_with_an_sdk |
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. Há duas versões de contexto. Isso serve para manter o controle de versão do agente de dados.
Enumerações | |
---|---|
CONTEXT_VERSION_UNSPECIFIED | Não especificado ou não reconhecido. |
STAGING | Usando esta versão, o DCS usará o contexto de preparação mais recente para o agente de dados. |
PUBLISHED | Usando esta versão, o DCS usará o contexto publicado mais recente para o agente de dados. |