Explain SQL results

Explain SQL results es un componente sencillo que convierte los resultados de una consulta SQL en una explicación fácil de leer. No necesitas saber nada de bases de datos ni de programación; simplemente introduces la respuesta de la consulta, la petición del usuario y el idioma, y el componente te devuelve un texto descriptivo.

¿Cómo funciona?

El componente recibe cuatro entradas:

1. LLM – El modelo de lenguaje que se usará para generar la explicación.
2. User request – La pregunta o petición original del usuario.
3. User Language – El idioma en el que debe entregarse la explicación.
4. Result from the execution of SQL query – Los datos devueltos por la consulta SQL (normalmente una tabla o un conjunto de filas).

Internamente el componente construye un prompt de sistema que le indica al LLM que actúe como experto en bases de datos y que explique los resultados en relación con la petición del usuario. El LLM procesa el prompt y devuelve un mensaje de texto que se entrega como salida Explanation results.

Entradas

• LLM
  El modelo de lenguaje que generará la explicación.
• User request
  La pregunta o solicitud que el usuario hizo antes de ejecutar la consulta.
• User Language
  El idioma en el que se debe redactar la explicación.
• Result from the execution of SQL query
  Los datos que devuelve la consulta SQL (por ejemplo, una tabla con filas y columnas).

Salidas

• Explanation results
  Un mensaje de texto que contiene una explicación clara y concisa de los resultados de la consulta, adaptada a la petición del usuario y al idioma seleccionado. Este texto puede usarse directamente en el dashboard, enviarse por correo, mostrarse en un panel de informes, etc.

Ejemplo de Uso

1. Usuario: “¿Cuántas ventas se realizaron en el último mes?”
2. Consulta SQL (ejecutada por otro componente):

   SELECT COUNT(*) AS total_sales, SUM(amount) AS total_amount
   FROM sales
   WHERE sale_date >= DATE_SUB(CURDATE(), INTERVAL 1 MONTH);

3. Resultado de la consulta (entrada al componente):

   total_sales | total_amount
   -------------|-------------
   125          |  47,500.00

4. Entrada al componente:
   • LLM: OpenAI GPT‑4
   • User request: “¿Cuántas ventas se realizaron en el último mes?”
   • User Language: “es”
   • Result from the execution of SQL query: (tabla anterior)
5. Salida:

   En el último mes se registraron 125 ventas, con un total de ingresos de 47,500.00 unidades monetarias.

Componentes Relacionados

• SQLQuery – Ejecuta la consulta SQL que produce los datos que se pasan a Explain SQL results.
• DataFormatter – Convierte los resultados de la consulta en formatos compatibles (JSON, CSV, etc.) antes de enviarlos al componente de explicación.

Consejos y Mejores Prácticas

• Mantén la consulta simple: Cuanto más legible sea la tabla de resultados, más precisa será la explicación.
• Especifica el idioma: Asegúrate de que el campo User Language coincida con el idioma que deseas en la respuesta.
• Revisa la salida: Aunque el LLM es muy competente, verifica que la explicación sea coherente con los datos reales.
• Protege la información sensible: Si la tabla contiene datos confidenciales, considera anonimizar o limitar la información antes de enviarla al LLM.

Consideraciones de Seguridad

• El LLM procesa los datos de la tabla, por lo que es importante asegurarse de que la información no contenga datos personales sensibles o confidenciales que no deban compartirse con el modelo.
• Utiliza modelos que cumplan con las políticas de privacidad de tu organización y, si es necesario, emplea un modelo local o privado.