Los desarrolladores pueden usar la API de Conversational Analytics, a la que se accede a través de geminidataanalytics.googleapis.com o extremos regionales, para compilar una interfaz de chat potenciada por inteligencia artificial (IA) o un agente de datos. La API usa lenguaje natural para responder preguntas sobre datos estructurados en BigQuery, Looker y Data 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 método QueryData.
Con la API de Conversational Analytics, le proporcionas a tu agente de datos información de la empresa y datos (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 fluida 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, revisa la siguiente documentación para comprender los enfoques de integración disponibles y los conceptos básicos:
- Arquitectura y conceptos clave: Comprende cómo los agentes de datos procesan las solicitudes, los flujos de trabajo para los creadores y usuarios de agentes, los modos de conversación y los roles de Identity and Access Management (IAM) necesarios.
- Patrones de integración para agentes de datos: Compara enfoques arquitectónicos para determinar el mejor método de conexión para tu aplicación.
- Administración del estado: Obtén información sobre los modos de conversación con estado y sin estado, cómo la API administra el historial de conversaciones y los alcances del estado de la sesión del ADK.
- Seguridad, privacidad, riesgo y cumplimiento: Comprende las opciones de seguridad y cumplimiento de la API de Conversational Analytics.
- Ubicaciones de la API de Conversational Analytics: Proporciona una descripción general de los extremos de la API regionales o multirregionales que te permiten controlar la ubicación geográfica de los recursos, la configuración y los datos de tu agente.
Para comenzar a crear agentes de datos, completa los pasos que se indican en la documentación de configuración y requisitos previos. Para obtener instrucciones guiadas, aplicaciones de ejemplo, SDKs y otras herramientas de desarrollo, consulta Instructivos, demostraciones y 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 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: Proporciona instrucciones para autenticarte en la API y configurar conexiones a tus datos de BigQuery, Lakehouse, Looker, Data 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.
- Restricciones de políticas de la organización: Describe cómo usar las restricciones de políticas de la organización predefinidas para controlar los recursos a nivel de la organización, la carpeta o el proyecto.
Crea un agente de datos y usa sus funciones
Después de completar los pasos anteriores, usa la API de Conversational Analytics para compilar un agente de datos y, luego, interactuar con él. Para ello, sigue estos pasos:
- Crea un agente de datos con HTTP: Proporciona un ejemplo completo de cómo crear un agente de datos y cómo interactuar con él usando 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 y cómo interactuar con él usando 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 del procesamiento de especificaciones de gráficos a partir de respuestas de la API y su renderización como visualizaciones con el SDK de Python y la biblioteca de Vega-Altair.
Prácticas recomendadas
Revisa las siguientes guías para conocer las prácticas recomendadas para usar la API de Conversational Analytics:
- Administra los costos de BigQuery para tus agentes: Obtén información para supervisar y administrar los costos de BigQuery para tus agentes de la API de Conversational Analytics estableciendo límites de inversión a nivel del proyecto, del usuario y de la consulta.
- Haz preguntas eficaces: Aprende a formular preguntas eficaces para que tus agentes aprovechen al máximo la API de Conversational Analytics.
- Retención y eliminación de datos: Obtén información sobre la retención y eliminación de datos de los agentes de datos y las conversaciones de la API de Conversational Analytics.
- Cuotas y límites: Obtén información sobre las cuotas y los límites de 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 búsquedas, los datos, las visualizaciones y las preguntas.
- Cómo renderizar respuestas del agente para fuentes de datos de Looker: Conoce las prácticas recomendadas para renderizar 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 la API de REST de Gemini Data Analytics: Proporciona descripciones detalladas de las versiones, los métodos, los extremos y las definiciones de tipos de la API.
- SDKs and development tools: 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 |
/v1/projects/*/locations/*/dataAgents |
Crea un agente de datos nuevo. |
| Crea un agente de forma síncrona | POST |
/v1/projects/*/locations/*/dataAgents:createSync |
Crea un agente de datos nuevo de forma síncrona. |
| Obtén un agente | GET |
/v1/projects/*/locations/*/dataAgents/* |
Recupera los detalles de un agente de datos específico. |
| Obtén la política de Identity and Access Management | POST |
/v1/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 de propietario del agente de datos pueden llamar a este endpoint para ver la política de Identity and Access Management del agente de datos antes de usar el endpoint setIAMpolicy para compartir un agente de datos con otros usuarios. |
| Establece la política de Identity and Access Management | POST |
/v1/projects/*/locations/*/dataAgents/*:setIamPolicy |
Establece la política de Identity and Access Management para un agente de datos específico. Los usuarios con el rol de propietario del agente de datos deben llamar a este endpoint 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 |
/v1/projects/*/locations/*/dataAgents/* |
Modifica un agente de datos existente. |
| Actualiza un agente de forma síncrona | PATCH |
/v1/projects/*/locations/*/dataAgents/*:updateSync |
Modifica un agente de datos existente de forma síncrona. |
| Mostrar lista de agentes | GET |
/v1/projects/*/locations/*/dataAgents |
Enumera los agentes de datos disponibles en un proyecto. |
| Cómo obtener una lista de los agentes a los que puedes acceder | GET |
/v1/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 devuelve este método:
|
| Borra un agente | DELETE |
/v1/projects/*/locations/*/dataAgents/* |
Quita un agente de datos. |
| Borra un agente de forma síncrona | DELETE |
/v1/projects/*/locations/*/dataAgents/*:deleteSync |
Quita un agente de datos de forma síncrona. |
| Cómo crear una conversación | POST |
/v1/projects/*/locations/*/conversations |
Inicia una conversación persistente nueva. |
| Chatea usando una referencia de conversación | POST |
/v1/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 del 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 |
/v1/projects/*/locations/*:chat |
Envía un mensaje de chat sin estado que hace referencia a un agente de datos guardado para el contexto. En el caso de las conversaciones de varios turnos, tu aplicación debe administrar y proporcionar el historial de conversaciones con cada solicitud. |
| Chatea con contexto intercalado | POST |
/v1/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. En el caso de 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 |
/v1/projects/*/locations/*/conversations/* |
Recupera los detalles de una conversación específica. |
| Mostrar lista de conversaciones | GET |
/v1/projects/*/locations/*/conversations |
Enumera las conversaciones en un proyecto específico. |
| Cómo enumerar los mensajes de una conversación | GET |
/v1/projects/*/locations/*/conversations/*/messages |
Enumera los mensajes dentro de una conversación específica. |
| Borrar una conversación | DELETE |
/v1/projects/*/locations/*/conversations/* |
Borra una conversación específica. Se requiere el rol de administrador de temas de Identity and Access Management o, al menos, el permiso cloudaicompanion.topics.delete de Identity and Access Management para llamar a este endpoint.
|
| 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. |
Asistencia y comentarios
Para obtener ayuda o informar un problema, comunícate con el equipo de Atención al cliente. Sigue las instrucciones que se indican en Crea y administra casos de asistencia para abrir tu caso de asistencia. Sigue estos lineamientos cuando crees tu caso:
- Para obtener asistencia sobre la API de Conversational Analytics con BigQuery, en la lista Selecciona un producto, selecciona BigQuery y, en el campo Función, selecciona IA y aprendizaje automático::API de Conversational Analytics en BigQuery.
- Para obtener asistencia sobre la API de Conversational Analytics con Looker, en la lista Select a product, selecciona Looker (original) y, en el campo Feature, selecciona Gemini en Looker::Conversational Analytics API.
Si tienes preguntas o comentarios generales sobre la API de Conversational Analytics, envía un correo electrónico a conversational-analytics-api-feedback@google.com. No garantizamos una respuesta a las comunicaciones por correo electrónico, pero sí leemos los correos electrónicos y tenemos en cuenta los comentarios durante la planificación de la hoja de ruta.
También puedes presentar una solicitud de función para obtener nuevas funciones de la API de Conversational Analytics.