mql

MQL

MQL (mon langage de requête) est un outil puissant pour transformer les requêtes en langage naturel en requêtes SQL exécutables. Ce qui est cool, c'est que n'importe qui peut l'utiliser, même sans savoir coder. Ajoutez simplement votre base de données en connectant ou en téléchargeant un schéma à MQL, demandez une requête dans votre langue et obtenez le SQL.

MQL_QUERY_DEMO.MP4

Commencer

Mql_getstarted.mp4

Exécutez l'outil localement à l'aide de Docker.

• Assurez-vous que Docker a installé.

• Pour commencer, clonez ce référentiel git:

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

• Mettez à jour le serveur / dockerfile avec votre touche OPENAI_API_KEY :

   ENV OPENAI_API_KEY YOUR_TOKEN_HERE
  

• Mettez à jour la Database_URL dans le fichier Server / .env en fonction des règles suivantes:

  • Si vous utilisez Docker pour exécuter MQL, vous pouvez utiliser «Postgres» comme nom d'hôte.
  • Si vous n'utilisez pas Docker pour exécuter MQL, vous pouvez utiliser «localhost» comme nom d'hôte.

• Accédez au dossier du référentiel et exécutez la commande suivante:

   make install
  

  Une fois l'installation terminée, vous pouvez accéder au tableau de bord MQL à: http: // localhost: 3000

---

Si nécessaire, vous pouvez également redémarrer pour refléter les modifications locales, le cas échéant, en utilisant:

 make restart

Vous pouvez également terminer la configuration locale en utilisant:

 make down

En outre, vous pouvez démarrer tous les conteneurs en utilisant:

 make up

Utilisez un e-mail / mot de passe par défaut pour la connexion pour tester MQL

Un utilisateur par défaut est créé à des fins de connexion lors de l'exécution de l'outil à l'aide de Docker.

• Courriel - [email protected]
• Mot de passe - Admin

Vous voulez production de MQL?

Prenez soin des étapes ci-dessous si vous cherchez à le faire vivre

• Supprimer l'utilisateur par défaut : pour supprimer l'utilisateur par défaut ([email protected]), vous devez vous connecter avec la base de données MQL (MQL-Postgres), puis la supprimer de la table des utilisateurs.
• Créer un nouvel utilisateur :
  • aller au répertoire racine du projet
  • Exec dans Backend Docker Container: Docker-Compose Exec Backend / Bin / Bash
  • Exécuter le script Create_User: Python3 scripts / create_user.py
  • Entrez le courrier électronique, le mot de passe et le nom pour créer votre propre utilisateur

Bases de données prises en charge

À partir de la version actuelle, MQL est conçu pour fonctionner exclusivement avec PostgreSQL.

---

Vous pouvez également exécuter l'outil localement sans docker.

• Condition préalable

  Ce sont les packages requis qui doivent être installés pour exécuter le projet localement.

1. Python

2. psycopg2

3. Nœud

4. Postgresql 15

5. Extension PGVector pour PostgreSQL - PGVector

• Configuration de la base de données

  Exécutez ces commandes dans votre client de ligne de commande PostgreSQL

1. Création du rôle postgresql

   Créez un rôle postgresql avec les autorisations de superutilisateur et la capacité de connexion:

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

2. Création des bases de données

   Créez deux bases de données, mql et mql_test , avec le rôle shuru :

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

3. Création de l'extension

   Pour créer l'extension vector :

• Connectez-vous avec la base de données en utilisant:

  c < databse_name >

• Créez l'extension vectorielle:

  CREATE EXTENSION vector;

• Mettez à jour votre env

  Mettez à jour ces valeurs sur Server / .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 données est hébergée localement, l'hôte sera localhost

• Exécutez le script

  Accédez au dossier du référentiel et exécutez la commande dans le terminal

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

Une fois l'installation terminée, vous pouvez accéder au tableau de bord MQL à: http: // localhost: 3000

Score de test de précision

Notre processus de test consistait à exécuter 50 requêtes en langage naturel via la plate-forme MQL, avec des ressources comme un fichier eLearning_schema et un CSV de mappages de requête situés dans notre dossier Test_Data. Le MQL a atteint environ 85% le taux de réussite , traduisant avec précision 43 questions sur 50. Cependant, lorsque l'on considère la précision des traductions, environ 74% (37 sur 50) des requêtes ont été parfaitement exécutés, avec 6 requêtes correctement interprétées mais manquant un demi-colon à la fin. Cela nous a laissé 7 requêtes qui ont entraîné des erreurs. Nous travaillons activement sur les améliorations pour améliorer à la fois la précision et l'exhaustivité de la génération de syntaxe SQL, et nous nous réjouissons des contributions pour aider à affiner notre plateforme.

• Nous avons pris un ensemble de bases de données à partir d'ici à des fins de test.
• Vous pouvez supprimer le dossier test_data après l'avoir vérifié.

Étapes / fonctionnalités suivantes

Nous prévoyons de continuer à construire après la libération initiale et nous attendons avec impatience les commentaires de la communauté. À ce jour, nous avons des fonctionnalités suivantes prévues pour les prochaines versions.

• Implémentation de l'exécution de la requête
• Améliorer les résultats de la requête DBS et SQL directement connectés
• Prise en charge de la base de données MySQL
• Améliorations de la précision des requêtes
• Afficher la réponse du langage naturel et la visualisation des données.
• L'utilisateur peut intégrer des applications Slack ou similaires pour y obtenir le résultat de la requête NL.
• Test Retool pour générer les requêtes.

Lignes directrices de contribution

Nous apprécions les contributions de chaque développeur et vous encourageons à partager vos idées, vos améliorations et correctement avec nous. Pour assurer un processus de collaboration fluide, veuillez suivre ces directives.

Avant de commencer:

• Assurez-vous d'avoir un compte GitHub.
• Familiarisez-vous avec le projet en lisant le Readme, en explorant les problèmes et en comprenant l'architecture et les normes de codage de l'outil.

Comment contribuer

Rapports de bugs

Avant de signaler un bogue, s'il vous plaît:

• Vérifiez le tracker du problème pour vous assurer que le bogue n'a pas déjà été signalé.
• Si le problème n'est pas signalé, créez un nouveau problème, à condition:
  • Un titre et une description clairs.
  • Étapes pour reproduire le bug.
  • Comportement attendu et ce qui s'est réellement passé.
  • Tous les messages d'erreur ou captures d'écran pertinents.

Suggérant des améliorations que nous aimons recevoir des suggestions pour les améliorations! S'il te plaît:

• Tout d'abord, vérifiez si l'amélioration a déjà été suggérée.
• Sinon, ouvrez un nouveau problème, décrivant l'amélioration et pourquoi il serait bénéfique.

Tirez les demandes prêtes à contribuer au code? Suivez ces étapes:

1. Fork le référentiel - Créez votre propre fourche du projet.
2. Créez une nouvelle branche pour vos modifications - gardez votre branche concentrée sur une seule fonctionnalité ou correction de bogue.
3. Commissez vos modifications - Écrivez des messages de validation clairs et concis qui expliquent vos modifications.
4. Suivez les normes de codage - Assurez-vous que votre code adhère aux normes de codage utilisées tout au long du projet.
5. Écrire des tests - Si possible, écrivez des tests pour couvrir la nouvelle fonctionnalité ou la correction de bogue.
6. Soumettez une demande de traction - Fournissez une description claire du problème et de la solution. Incluez le numéro d'émission pertinent le cas échéant.

Conduite, nous nous engageons à fournir une communauté accueillante et inspirante pour tous. En participant à ce projet, vous devez maintenir notre code de conduite, qui favorise le respect et la collaboration.