Los desarrolladores pueden usar la API de Conversational Analytics, a la que se accede a través de geminidataanalytics.googleapis.com, para compilar una interfaz de chat potenciada por inteligencia artificial (IA) o agente de datos. La API usa lenguaje natural para responder preguntas sobre datos estructurados en BigQuery, Looker y Looker Studio, y también admite la consulta de datos de AlloyDB, GoogleSQL para Spanner, Cloud SQL y Cloud SQL para PostgreSQL a través del nuevo método QueryData. Con la API de Conversational Analytics, proporcionas a tu agente de datos información y datos empresariales (contexto), así como acceso a herramientas como SQL, Python y bibliotecas de visualización. Estas respuestas del agente se presentan al usuario y la aplicación cliente puede registrarlas, lo que crea una experiencia de chat de datos sin inconvenientes y auditable.
Descubre cómo y cuándo Gemini para Google Cloud usa tus datos.
Comienza a usar la API de Conversational Analytics
Para comenzar a usar la API de Conversational Analytics, primero puedes revisar la documentación de arquitectura y conceptos clave para comprender cómo los agentes procesan las solicitudes, los flujos de trabajo para los creadores y usuarios de agentes, los modos de conversación y las funciones de Identity and Access Management (IAM).
Para comenzar a compilar agentes de datos, completa los pasos de la documentación de configuración y requisitos previos. Para obtener instrucciones guiadas, aplicaciones de muestra, SDKs y otras herramientas de desarrollo, consulta los instructivos, las demostraciones y las herramientas de la API de Conversational Analytics.
Configuración y requisitos previos
Antes de usar la API o los ejemplos, completa los siguientes pasos:
- Habilita la API de Conversational Analytics: Describe los requisitos previos para habilitar la API de Conversational Analytics.
- Control de acceso a la API de Conversational Analytics con IAM: Describe cómo usar Identity and Access Management para compartir y administrar el acceso a los agentes de datos.
- Autentica y conéctate a una fuente de datos con la API de Conversational Analytics: Proporciona instrucciones para autenticarte en la API y configurar conexiones a tus datos de BigQuery, Looker, Looker Studio y Cloud Databases (AlloyDB, GoogleSQL para Spanner, Cloud SQL y Cloud SQL para PostgreSQL).
- Claves de encriptación administradas por el cliente (CMEK): Describe cómo usar tus propias claves de encriptación en Cloud Key Management Service para proteger los agentes de datos y las conversaciones que usan fuentes de datos de Looker.
Compila un agente de datos e interactúa con él
Después de completar los pasos anteriores, usa la API de Conversational Analytics para compilar un agente de datos e interactuar con él siguiendo estos pasos:
- Compila un agente de datos con HTTP: Proporciona un ejemplo completo de cómo compilar un agente de datos e interactuar con él mediante solicitudes HTTP directas con Python.
- Compila un agente de datos con el SDK de Python: Proporciona un ejemplo completo de cómo compilar un agente de datos e interactuar con él mediante el SDK de Python.
- Guía el comportamiento del agente con contexto creado: Aprende a proporcionar contexto creado para guiar el comportamiento del agente y mejorar la exactitud de las respuestas. También puedes ver ejemplos de contexto creado con fuentes de datos de BigQuery y con fuentes de datos de Looker.
- Renderiza una respuesta del agente de la API de Conversational Analytics como una visualización: Proporciona un ejemplo de cómo procesar las especificaciones del gráfico de las respuestas de la API y renderizarlas como visualizaciones con el SDK de Python y la biblioteca Vega-Altair.
Prácticas recomendadas
Revisa las siguientes guías para obtener información sobre las prácticas recomendadas para usar la API de Conversational Analytics:
- Administra los costos de BigQuery para tus agentes: Aprende a supervisar y administrar los costos de BigQuery para tus agentes de la API de Conversational Analytics estableciendo límites de gasto a nivel del proyecto, del usuario y de la consulta.
- Haz preguntas efectivas: Aprende a formular preguntas efectivas para tus agentes y aprovechar al máximo la API de Conversational Analytics.
- Soluciona errores de la API de Conversational Analytics: Soluciona errores comunes de la API de Conversational Analytics.
- Limitaciones conocidas: Proporciona información detallada sobre las limitaciones conocidas de la API de Conversational Analytics, incluidas las limitaciones de las consultas, los datos, las visualizaciones y las preguntas.
- Renderiza las respuestas del agente para las fuentes de datos de Looker: Aprende las prácticas recomendadas para renderizar las respuestas de la API de Conversational Analytics en una interfaz de usuario cuando usas fuentes de datos de Looker.
Bibliotecas cliente y referencia de la API
- Referencia de REST de Gemini Data Analytics: Proporciona descripciones detalladas de los métodos, los extremos y las definiciones de tipos.
- SDKs y herramientas de desarrollo: Enumera las bibliotecas cliente específicas del lenguaje.
Operaciones clave de la API
La API proporciona los siguientes extremos principales para administrar agentes de datos y conversaciones:
| Operación | Método HTTP | Extremo | Descripción |
|---|---|---|---|
| Crea un agente | POST |
/v1beta/projects/*/locations/*/dataAgents |
Crea un nuevo agente de datos. |
| Crea un agente de forma síncrona | POST |
/v1beta/projects/*/locations/*/dataAgents:createSync |
Crea un nuevo agente de datos de forma síncrona. |
| Obtén un agente | GET |
/v1beta/projects/*/locations/*/dataAgents/* |
Recupera los detalles de un agente de datos específico. |
| Obtén la política de Identity and Access Management | POST |
/v1beta/projects/*/locations/*/dataAgents/*:getIamPolicy |
Obtiene los permisos de Identity and Access Management que se asignan a cada usuario para un agente de datos específico. Los usuarios con el rol Propietario del agente de datos pueden llamar a este extremo para ver la política de Identity and Access Management del agente de datos antes de usar el extremo setIAMpolicy para compartir un agente de datos con otros usuarios. |
| Configura la política de Identity and Access Management | POST |
/v1beta/projects/*/locations/*/dataAgents/*:setIamPolicy |
Configura la política de Identity and Access Management para un agente de datos específico. Los usuarios con el rol Propietario del agente de datos deben llamar a este extremo para compartir un agente de datos con otros usuarios, lo que actualiza de manera efectiva los permisos de Identity and Access Management de esos usuarios. |
| Actualiza un agente | PATCH |
/v1beta/projects/*/locations/*/dataAgents/* |
Modifica un agente de datos existente. |
| Actualiza un agente de forma síncrona | PATCH |
/v1beta/projects/*/locations/*/dataAgents/*:updateSync |
Modifica un agente de datos existente de forma síncrona. |
| Mostrar lista de agentes | GET |
/v1beta/projects/*/locations/*/dataAgents |
Enumera los agentes de datos disponibles en un proyecto. |
| Enumera los agentes accesibles | GET |
/v1beta/projects/*/locations/*/dataAgents:listaccessible |
Enumera los agentes de datos accesibles en un proyecto. Se considera que un agente de datos es accesible si el usuario que invoca esta API tiene el permiso get en el agente. Puedes usar el campo creator_filter para administrar qué agentes muestra este método:
|
| Borra un agente | DELETE |
/v1beta/projects/*/locations/*/dataAgents/* |
Quita un agente de datos. |
| Borra un agente de forma síncrona | DELETE |
/v1beta/projects/*/locations/*/dataAgents/*:deleteSync |
Quita un agente de datos de forma síncrona. |
| Crea una conversación | POST |
/v1beta/projects/*/locations/*/conversations |
Inicia una conversación nueva y persistente. |
| Chatea con una referencia de conversación | POST |
/v1beta/projects/*/locations/*:chat |
Continúa una conversación con estado enviando un mensaje de chat que hace referencia a una conversación existente y a su contexto de agente asociado. Para las conversaciones de varios turnos, Google Cloud almacena y administra el historial de conversaciones. |
| Chatea con una referencia de agente de datos | POST |
/v1beta/projects/*/locations/*:chat |
Envía un mensaje de chat sin estado que hace referencia a un agente de datos guardado para el contexto. Para las conversaciones de varios turnos, tu aplicación debe administrar y proporcionar el historial de conversaciones con cada solicitud. |
| Chatea con contexto intercalado | POST |
/v1beta/projects/*/locations/*:chat |
Envía un mensaje de chat sin estado proporcionando todo el contexto directamente en la solicitud, sin usar un agente de datos guardado. Para las conversaciones de varios turnos, tu aplicación debe administrar y proporcionar el historial de conversaciones con cada solicitud. |
| Obtén una conversación | GET |
/v1beta/projects/*/locations/*/conversations/* |
Recupera los detalles de una conversación específica. |
| Mostrar lista de conversaciones | GET |
/v1beta/projects/*/locations/*/conversations |
Enumera las conversaciones en un proyecto específico. |
| Enumera los mensajes en una conversación | GET |
/v1beta/projects/*/locations/*/conversations/*/messages |
Enumera los mensajes dentro de una conversación específica. |
| Borrar una conversación | DELETE |
/v1beta/projects/*/locations/*/conversations/* |
Borra una conversación específica. Se requiere el rol de Identity and Access Management de administrador de temas o, al menos, el permiso de Identity and Access Management cloudaicompanion.topics.delete para llamar a este extremo.
|
| Consulta los datos | POST |
/v1beta/projects/*/locations/*/conversations:queryData |
Consulta datos de las bases de datos de AlloyDB, GoogleSQL para Spanner, Cloud SQL y Cloud SQL para PostgreSQL con lenguaje natural. |
Enviar comentarios
Usa los siguientes vínculos para informar un error o solicitar una función.