API de Conversational Analytics: Crea agentes de datos y chatea con tus datos

Vista previa

Este producto o función está sujeto a las "Condiciones de la Oferta de la Fase Previa a la DG" en la sección Condiciones Generales del Servicio de las Condiciones Específicas del Servicio. Los productos y las funciones de la fase previa a la DG están disponibles “tal como están” y pueden estar sujetos a asistencia limitada. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

Importante: La API de Data QnA está obsoleta. Si migras desde la API de Data QnA, consulta la guía de migración para obtener una descripción general de las diferencias clave y los pasos de migración necesarios.

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 un 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, le proporcionas a tu agente de datos información y datos comerciales (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.

Como tecnología en etapa inicial, los productos de Gemini para Google Cloud pueden generar resultados que parecen posibles, pero que no son correctos. Te recomendamos que valides todos los resultados de Gemini para los productos de Google Cloud antes de usarlos. Para obtener más información, consulta Gemini para Google Cloud y la IA responsable.

Nota: Las ofertas de Versión Preliminar de Fase Previa a la DG (1) están diseñadas para usarse solo en entornos de prueba y no deben utilizarse en un entorno de producción ni para procesar datos personales o cualquier otro dato sujeto a requisitos de cumplimiento legal o reglamentario, y (2) están sujetas a las Condiciones de las Ofertas de Fase Previa a la DG de las Condiciones Específicas del Servicio y al Anexo de Consentimiento para el Programa de Verificadores de confianza de Gemini para Google Cloud .

Comienza a usar la API de Conversational Analytics

Para comenzar a usar la API de Conversational Analytics, primero puedes revisar la documentación sobre la arquitectura y los 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 los roles de Identity and Access Management (IAM).

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 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 autenticarse 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.

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.
  Nota: No se admite la creación de agentes de datos con HTTP o el SDK de Python, ni la renderización de visualizaciones para las fuentes de datos de bases de datos (AlloyDB, GoogleSQL para Spanner, Cloud SQL y Cloud SQL para PostgreSQL).

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 para los agentes de datos y las conversaciones de la API de Conversational Analytics.
• Soluciona problemas de errores de la API de Conversational Analytics: Soluciona problemas 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	/v1beta/projects/*/locations/*/dataAgents	Crea un agente de datos nuevo.
Crea un agente de forma síncrona	POST	/v1beta/projects/*/locations/*/dataAgents:createSync	Crea un agente de datos nuevo 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 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	/v1beta/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	/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.
Cómo obtener una lista de los agentes a los que puedes acceder	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 devuelve este método: NONE (predeterminado): Muestra todos los agentes de datos a los que puede acceder el usuario, independientemente de quién los haya creado. CREATOR_ONLY: Solo devuelve los agentes de datos a los que puede acceder el usuario y que fueron creados por ese usuario. NOT_CREATOR_ONLY: Solo devuelve los agentes de datos a los que el usuario tiene acceso y que fueron creados por otros.
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.
Cómo crear una conversación	POST	/v1beta/projects/*/locations/*/conversations	Inicia una conversación persistente nueva.
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 del agente asociado. En el caso de 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. 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	/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. 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	/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.
Cómo enumerar los mensajes de una conversación	GET	/v1beta/projects/*/locations/*/conversations/*/messages	Enumera los mensajes 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 de cloudaicompanion.topics.delete para llamar a este endpoint.
Consulta los datos	POST	/v1beta/projects/*/locations/*/conversations:queryData	Consultar datos de 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.

• Cómo enviar un informe de errores
• Solicitar una función