Los desarrolladores pueden usar la API Conversational Analytics, a la que se accede a través de geminidataanalytics.googleapis.com
, para crear una interfaz de chat o un agente de datos basados en inteligencia artificial (IA) que responda a preguntas sobre datos estructurados en BigQuery, Looker y Looker Studio mediante lenguaje natural. Con la API 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 fluida y auditable.
Consulta cómo y cuándo Gemini Google Cloud usa tus datos.
Empezar a usar la API Conversational Analytics
Para empezar a usar la API Conversational Analytics, primero puedes consultar la documentación sobre la arquitectura y los conceptos clave para entender cómo procesan las solicitudes los agentes, los flujos de trabajo para los creadores y usuarios de agentes, los modos de conversación y los roles de gestión de identidades y accesos (IAM). Después, para empezar a crear agentes de datos, puedes elegir entre una experiencia guiada con los cuadernos de Colaboratory o un enfoque autónomo siguiendo los pasos de Configuración y requisitos previos.
Cuadernos interactivos de Colaboratory
Para obtener una guía interactiva paso a paso sobre cómo configurar tu entorno, crear un agente de datos y hacer llamadas a la API, consulta los siguientes cuadernos de Colaboratory:
- Notebook de Colaboratory HTTP de la API Conversational Analytics
- Notebook de Colaboratory del SDK de la API Conversational Analytics
Configuración y requisitos previos
Antes de usar la API o los ejemplos, sigue estos pasos:
- Habilitar la API Conversational Analytics: se describen los requisitos previos para habilitar la API Conversational Analytics.
- Conceder roles y permisos de gestión de identidades y accesos de la API Conversational Analytics: describe los roles de gestión de identidades y accesos predefinidos para gestionar el acceso a los agentes de datos.
- Autenticar y conectar con una fuente de datos mediante la API Conversational Analytics: se proporcionan instrucciones para autenticar la API y configurar conexiones con los datos de BigQuery, Looker y Looker Studio.
Crear e interactuar con un agente de datos
Después de completar los pasos anteriores, use la API Conversational Analytics para crear un agente de datos e interactuar con él siguiendo estos pasos:
- Crear un agente de datos mediante HTTP: proporciona un ejemplo completo de cómo crear e interactuar con un agente de datos mediante solicitudes HTTP directas con Python.
- Crear un agente de datos con el SDK de Python: proporciona un ejemplo completo de cómo crear un agente de datos e interactuar con él mediante el SDK de Python.
- Escribir instrucciones del sistema eficaces: descubre cómo estructurar el contenido YAML del parámetro
system_instruction
para guiar el comportamiento del agente y mejorar la precisión de las respuestas. También puedes ver ejemplos de instrucciones del sistema en las fuentes de datos de BigQuery y en las fuentes de datos de Looker. - Representar como visualización la respuesta de un agente de la API Conversational Analytics: proporciona un ejemplo de cómo procesar especificaciones de gráficos a partir de respuestas de la API y representarlas como visualizaciones mediante el SDK de Python y la biblioteca Vega-Altair.
Prácticas recomendadas
- Gestionar los costes de BigQuery de tus agentes: consulta cómo monitorizar y gestionar los costes de BigQuery de tus agentes de la API Conversational Analytics definiendo límites de gasto a nivel de proyecto, de usuario y de consulta.
Operaciones de API clave
La API proporciona los siguientes endpoints principales para gestionar agentes de datos y conversaciones:
Operación | Método HTTP | Endpoint | Descripción |
---|---|---|---|
Crear un agente | POST |
/v1beta/projects/*/locations/*/dataAgents |
Crea un nuevo agente de datos. |
Obtener un agente | GET |
/v1beta/projects/*/locations/*/dataAgents/* |
Obtiene los detalles de un agente de datos específico. |
Obtener política de gestión de identidades y accesos | POST |
/v1beta/projects/*/locations/*/dataAgents/*:getIamPolicy |
Obtiene los permisos de gestión de identidades y accesos asignados a cada usuario para un agente de datos específico. Los usuarios con el rol de propietario de agente de datos pueden llamar a este endpoint para ver la política de gestión de identidades y accesos del agente de datos antes de usar el endpoint setIAMpolicy para compartir un agente de datos con otros usuarios. |
Definir la política de gestión de identidades y accesos | POST |
/v1beta/projects/*/locations/*/dataAgents/*:setIamPolicy |
Define la política de Gestión de Identidades y Accesos de un agente de datos específico. Los usuarios con el rol de propietario de agente de datos deben llamar a este endpoint para compartir un agente de datos con otros usuarios, lo que actualiza de forma eficaz los permisos de gestión de identidades y accesos de esos usuarios. |
Actualizar un agente | PATCH |
/v1beta/projects/*/locations/*/dataAgents/* |
Modifica un agente de datos. |
Mostrar agentes | GET |
/v1beta/projects/*/locations/*/dataAgents |
Muestra los agentes de datos disponibles en un proyecto. |
Mostrar agentes accesibles | GET |
/v1beta/projects/*/locations/*/dataAgents:listaccessible |
Muestra los agentes de datos accesibles de 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 gestionar qué agentes devuelve este método:
|
Eliminar un agente | DELETE |
/v1beta/projects/*/locations/*/dataAgents/* |
Elimina un agente de datos. |
Crear una conversación | POST |
/v1beta/projects/*/locations/*/conversations |
Inicia una conversación nueva y persistente. |
Chatear usando 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 y al contexto del agente asociados. En las conversaciones de varios turnos, Google Cloud almacena y gestiona el historial de la conversación. |
Chatear usando 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 obtener contexto. En las conversaciones de varios turnos, tu aplicación debe gestionar y proporcionar el historial de la conversación con cada solicitud. |
Chatear usando el contexto insertado | 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 guardados. En las conversaciones de varios turnos, tu aplicación debe gestionar y proporcionar el historial de la conversación con cada solicitud. |
Obtener una conversación | GET |
/v1beta/projects/*/locations/*/conversations/* |
Obtiene los detalles de una conversación específica. |
Mostrar conversaciones | GET |
/v1beta/projects/*/locations/*/conversations |
Muestra las conversaciones de un proyecto específico. |
Listar los mensajes de una conversación | GET |
/v1beta/projects/*/locations/*/conversations/*/messages |
Lista los mensajes de una conversación específica. |
Enviar comentarios
Usa los siguientes enlaces para informar de un error o solicitar una función.
Recursos adicionales
- Documentación de referencia de la API Conversational Analytics: proporciona descripciones detalladas de los métodos, los endpoints y las definiciones de tipo de las estructuras de solicitud y respuesta.
- Solucionar problemas relacionados con errores de la API Conversation Analytics: soluciona problemas habituales de la API Conversation Analytics.