mql

MQL

MQL (mi lenguaje de consulta) es una herramienta poderosa para transformar las consultas del lenguaje natural en consultas SQL ejecutables. Lo bueno es que cualquiera puede usarlo, incluso sin saber cómo codificar. Simplemente agregue su base de datos conectando o cargando esquema a MQL, solicite una consulta en su idioma y obtenga el SQL.

Mql_query_demo.mp4

Empezando

Mql_getstarted.mp4

Ejecute la herramienta localmente usando Docker.

• Asegúrese de tener instalado Docker.

• Para comenzar, clona este repositorio de git:

  git clone https://github.com/shurutech/mql

• Actualizar servidor/dockerfile con su tecla OPENAI_API_KEY :

   ENV OPENAI_API_KEY YOUR_TOKEN_HERE
  

• Actualice la base de datos_URL en el archivo servidor/.env de acuerdo con las siguientes reglas:

  • Si está utilizando Docker para ejecutar MQL, puede usar 'Postgres' como nombre de host.
  • Si no está utilizando Docker para ejecutar MQL, puede usar 'localhost' como nombre de host.

• Navegue a la carpeta del repositorio y ejecute el siguiente comando:

   make install
  

  Una vez que se completa la instalación, puede acceder al tablero MQL en: http: // localhost: 3000

---

Si es necesario, también puede reiniciar para reflejar los cambios locales, si corresponde, usando:

 make restart

Además, puede finalizar la configuración local usando:

 make down

Además, puede iniciar todos los contenedores usando:

 make up

Use correo electrónico/contraseña predeterminado para iniciar sesión para probar MQL

Se crea un usuario predeterminado para un propósito de inicio de sesión al ejecutar la herramienta usando Docker.

• Correo electrónico - [email protected]
• Contraseña - Administrador

¿Quieres producir MQL?

Cuida los pasos a continuación si estás buscando hacerlo en vivo

• Elimine el usuario predeterminado : para eliminar el usuario predeterminado ([email protected]), debe conectarse con la base de datos MQL (MQL-Postgres) y luego eliminarlo de la tabla de usuarios.
• Crear un nuevo usuario :
  • ir al directorio root del proyecto
  • EXEC en contenedor de Dockend Backend: Docker-Compose Exec Backend /Bin /Bash
  • Ejecutar script create_user: scripts python3/create_user.py
  • Ingrese el correo electrónico, la contraseña y el nombre para crear su propio usuario

Bases de datos compatibles

A partir de la versión actual, MQL está diseñado para funcionar exclusivamente con PostgreSQL.

---

También puede ejecutar la herramienta localmente sin Docker.

• Requisitos previos

  Estos son los paquetes requeridos que deben instalarse para ejecutar el proyecto localmente.

1. Pitón

2. psycopg2

3. Nodo

4. PostgreSQL 15

5. Extensión de PGVector para PostgreSQL - PGVECTOR

• Configuración de la base de datos

  Ejecute estos comandos en su cliente de línea de comandos PostgreSQL

1. Creando el rol PostgreSQL

   Cree un rol PostgreSQL con permisos de superusuario y capacidad de inicio de sesión:

   CREATE ROLE < role_name > WITH superuser;
   ALTER ROLE < role_name > WITH LOGIN PASSWORD ' password ' ;

2. Creando las bases de datos

   Cree dos bases de datos, mql y mql_test , con el rol shuru :

    CREATE DATABASE mql WITH OWNER < role_name > ;
   CREATE DATABASE mql_test WITH OWNER < role_name > ;

3. Creando la extensión

   Para crear la extensión vector :

• Conéctese con la base de datos utilizando:

  c < databse_name >

• Crea la extensión de vector:

  CREATE EXTENSION vector;

• Actualiza tu envío

  Actualizar estos valores en servidor/.env

   DATABASE_URL = " postgresql://<role_name>:<password>@<host>:5432/mql "
  
  TEST_DATABASE_URL = " postgresql://<role_name>:<password>@<host>:5432/mql_test "
  
  OPENAI_API_KEY = " <key> "

  Si la base de datos se aloja localmente, entonces el host será localhost

• Ejecutar el guión

  Navegue a la carpeta del repositorio y ejecute el comando en terminal

  chmod +x ./setup.sh && ./setup.sh

Una vez que se completa la instalación, puede acceder al tablero MQL en: http: // localhost: 3000

Puntaje de prueba de precisión

Nuestro proceso de prueba implicó ejecutar 50 consultas de lenguaje natural a través de la plataforma MQL, con recursos como un archivo Elearning_Schema y un CSV de asignaciones de consultas ubicadas en nuestra carpeta TEST_DATA. El MQL alcanzó una tasa de éxito del 85% , traduciendo con precisión 43 de 50 consultas. Sin embargo, al considerar la precisión de las traducciones, aproximadamente el 74% (37 de 50) de las consultas se ejecutaron perfectamente, con 6 consultas interpretadas correctamente pero faltaban un semi-colon al final. Esto nos dejó con 7 consultas que resultaron en errores. Estamos trabajando activamente en mejoras para mejorar tanto la precisión como la integridad de la generación de sintaxis SQL, y agradecemos contribuciones para ayudar a refinar nuestra plataforma.

• Hemos tomado bases de datos desde aquí para fines de prueba.
• Puede eliminar la carpeta test_data después de verificarla.

Siguientes pasos/características

Planeamos continuar construyendo después del lanzamiento inicial y esperamos los comentarios de la comunidad. A partir de ahora tenemos las siguientes características planificadas para los próximos lanzamientos.

• Implementación de la ejecución de consultas
• Mejorar los resultados de la consulta DBS y SQL directamente conectados
• Soporte para la base de datos MySQL
• Mejoras en la precisión de la consulta
• Mostrar respuesta del lenguaje natural y visualización de datos.
• El usuario puede integrar aplicaciones Slack o similares para obtener el resultado de la consulta NL allí.
• Pruebe el reasentado para generar las consultas.

Pautas de contribución

Valoramos las contribuciones de cada desarrollador y lo alentamos a compartir sus ideas, mejoras y soluciones con nosotros. Para garantizar un proceso de colaboración suave, siga estas pautas.

Antes de comenzar:

• Asegúrese de tener una cuenta de GitHub.
• Familiarícese con el proyecto leyendo el ReadMe, explorando los problemas y entendiendo los estándares de arquitectura y codificación de la herramienta.

Cómo contribuir

Informes de informes

Antes de informar un error, por favor:

• Verifique el rastreador de problemas para asegurarse de que el error no se haya informado.
• Si el problema no se informa, cree un nuevo problema, proporcionando:
  • Un título y descripción claros.
  • Pasos para reproducir el error.
  • Comportamiento esperado y lo que realmente sucedió.
  • Cualquier mensaje de error relevante o captura de pantalla.

¡Sugeriendo mejoras, nos encanta recibir sugerencias para mejoras! Por favor:

• Primero, verifique si la mejora ya se ha sugerido.
• Si no, abra un nuevo problema, describiendo la mejora y por qué sería beneficioso.

¿Solicitar las solicitudes listas para contribuir con código? Sigue estos pasos:

1. Bifurca el repositorio: cree su propia bifurcación del proyecto.
2. Cree una nueva rama para sus cambios: mantenga su rama enfocada en una sola característica o corrección de errores.
3. Comprometer sus cambios: escriba mensajes claros y concisos de confirmación que expliquen sus cambios.
4. Siga los estándares de codificación: asegúrese de que su código se adhiera a los estándares de codificación utilizados en todo el proyecto.
5. Escribe pruebas: si es posible, escriba pruebas para cubrir la nueva funcionalidad o corrección de errores.
6. Envíe una solicitud de extracción: proporcione una descripción clara del problema y la solución. Incluya el número de emisión relevante si corresponde.

Conducta Estamos comprometidos a proporcionar una comunidad acogedora e inspiradora para todos. Al participar en este proyecto, se espera que mantenga nuestro código de conducta, lo que promueve el respeto y la colaboración.