Os desenvolvedores podem usar a API Conversational Analytics, acessada pelo geminidataanalytics.googleapis.com, para criar uma interface de chat ou um agente de dados com tecnologia de IA que responda a perguntas sobre dados estruturados no BigQuery, no Looker e no Looker Studio usando linguagem natural. Com a API Conversational Analytics, você fornece ao seu agente de dados informações e dados comerciais ("contexto"), além de acesso a ferramentas como SQL, Python e bibliotecas de visualização. Essas respostas do agente são apresentadas ao usuário e podem ser registradas pelo aplicativo cliente, criando uma experiência de chat de dados simples e auditável.
Saiba como e quando o Gemini para Google Cloud usa seus dados.
Começar a usar a API Conversational Analytics
Para configurar seu ambiente e começar a criar e interagir com agentes de dados usando a API Conversational Analytics, comece com os notebooks do Colaboratory para uma experiência guiada ou siga as etapas em Configuração e pré-requisitos para uma experiência independente.
Notebooks interativos do Colaboratory
Para um guia interativo e explicativo sobre como configurar seu ambiente, criar um agente de dados e fazer chamadas de API, consulte os seguintes notebooks do Colaboratory:
- Notebook do Colaboratory HTTP da API Conversational Analytics
- Notebook do Colaboratory do SDK da API Conversational Analytics
Configuração e pré-requisitos
Antes de usar a API ou os exemplos, siga estas etapas:
- Ativar a API Conversational Analytics: descreve os pré-requisitos para ativar a API Conversational Analytics.
- Conceder papéis e permissões do IAM da API Conversational Analytics: descreve os papéis predefinidos do IAM para gerenciar o acesso a agentes de dados.
- Autenticar e se conectar a uma fonte de dados com a API Conversational Analytics: fornece instruções para autenticar a API e configurar conexões com seus dados do BigQuery, do Looker e do Looker Studio.
Criar e interagir com um agente de dados
Depois de concluir as etapas anteriores, use a API Conversational Analytics para criar e interagir com um agente de dados seguindo estas etapas:
- Criar um agente de dados usando HTTP: oferece um exemplo completo de como criar e interagir com um agente de dados usando solicitações HTTP diretas com Python.
- Criar um agente de dados usando o SDK do Python: oferece um exemplo completo de como criar e interagir com um agente de dados usando o SDK do Python.
- Escreva instruções eficazes para o sistema: aprenda a estruturar o conteúdo YAML para o parâmetro
system_instructione orientar o comportamento do agente, além de melhorar a precisão da resposta. - Renderizar uma resposta do agente da API Conversational Analytics como uma visualização: fornece um exemplo de processamento de especificações de gráficos de respostas da API e renderização delas como visualizações usando o SDK do Python e a biblioteca Vega-Altair.
Principais operações da API
A API fornece os seguintes endpoints principais para gerenciar agentes de dados e conversas:
| Operação | Método HTTP | Endpoint | Descrição |
|---|---|---|---|
| Criar um agente | POST |
/v1alpha/projects/*/locations/*/dataAgents |
Cria um novo agente de dados. |
| Obter um agente | GET |
/v1alpha/projects/*/locations/*/dataAgents/* |
Recupera detalhes de um agente de dados específico. |
| Atualizar um agente | PATCH |
/v1alpha/projects/*/locations/*/dataAgents/* |
Modifica um agente de dados. |
| Listar agentes | GET |
/v1alpha/projects/*/locations/*/dataAgents |
Lista os agentes de dados disponíveis em um projeto. |
| Excluir um agente | DELETE |
/v1alpha/projects/*/locations/*/dataAgents/* |
Remove um agente de dados. |
| Criar uma conversa | POST |
/v1alpha/projects/*/locations/*/conversations |
Inicia uma nova conversa persistente. |
| Conversar usando uma referência de conversa | POST |
/v1alpha/projects/*/locations/*:chat |
Continua uma conversa com estado enviando uma mensagem de chat que faz referência a uma conversa e ao contexto do agente associado. Para conversas com várias interações, o Google Cloud armazena e gerencia o histórico da conversa. |
| Usar uma referência de agente de dados para conversar | POST |
/v1alpha/projects/*/locations/*:chat |
Envia uma mensagem de chat sem estado que faz referência a um agente de dados salvo para contexto. Para conversas com várias interações, o aplicativo precisa gerenciar e fornecer o histórico da conversa com cada solicitação. |
| Conversar usando contexto inline | POST |
/v1alpha/projects/*/locations/*:chat |
Envia uma mensagem de chat sem estado fornecendo todo o contexto diretamente na solicitação, sem usar um agente de dados salvo. Para conversas com várias interações, o aplicativo precisa gerenciar e fornecer o histórico da conversa com cada solicitação. |
| Receber uma conversa | GET |
/v1alpha/projects/*/locations/*/conversations/* |
Recupera detalhes de uma conversa específica. |
| Listar conversas | GET |
/v1alpha/projects/*/locations/*/conversations |
Lista as conversas em um projeto específico. |
| Listar mensagens em uma conversa | GET |
/v1alpha/projects/*/locations/*/conversations/*/messages |
Lista as mensagens em uma conversa específica. |
Recurso extra:
- Documentação de referência da API Conversational Analytics: oferece descrições detalhadas de métodos, endpoints e definições de tipo para estruturas de solicitação e resposta.