mql

Mql

MQL (My Query Language) ist ein leistungsstarkes Werkzeug, um natürliche Sprachabfragen in ausführbare SQL -Abfragen umzuwandeln. Was cool ist, ist, dass jeder es verwenden kann, auch ohne zu wissen, wie man codiert. Fügen Sie einfach Ihre Datenbank hinzu, indem Sie Schema an MQL verbinden oder hochladen, eine Abfrage in Ihrer Sprache fragen und den SQL erhalten.

Mql_query_demo.mp4

Erste Schritte

Mql_getStarted.mp4

Führen Sie das Tool lokal mit Docker aus.

• Stellen Sie sicher, dass Sie Docker installiert haben.

• Klonen Sie zunächst dieses Git -Repository:

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

• Aktualisieren Sie den Server/Dockerfile mit Ihrem Taste OPENAI_API_KEY :

   ENV OPENAI_API_KEY YOUR_TOKEN_HERE
  

• Aktualisieren Sie die DataBase_url in der Server/.env -Datei gemäß den folgenden Regeln:

  • Wenn Sie Docker zum Ausführen von MQL verwenden, können Sie "Postgres" als Hostnamen verwenden.
  • Wenn Sie Docker nicht zum Ausführen von MQL verwenden, können Sie "Localhost" als Hostnamen verwenden.

• Navigieren Sie zum Repository -Ordner und führen Sie den folgenden Befehl aus:

   make install
  

  Sobald die Installation abgeschlossen ist, können Sie auf das MQL -Dashboard unter: http: // localhost: 3000 zugreifen

---

Bei Bedarf können Sie auch neu starten, um die lokalen Änderungen bei Verwendung von folgenden zu widerspiegeln:

 make restart

Außerdem können Sie das lokale Setup mit:

 make down

Außerdem können Sie alle Container mit:

 make up

Verwenden Sie Standard -E -Mail/Passwort für Anmeldung, um MQL zu testen

Ein Standardbenutzer wird zum Anmeldungszweck erstellt, während das Tool mit Docker ausgeführt wird.

• E -Mail - [email protected]
• Passwort - Admin

Möchten Sie MQL produzieren?

Achten Sie auf die folgenden Schritte, wenn Sie es live machen möchten

• Standardbenutzer löschen : Wenn Sie den Standardbenutzer ([email protected]) löschen, müssen Sie eine Verbindung zur MQL-Datenbank (MQL-Postgres) herstellen und sie dann aus der Benutzertabelle entfernen.
• Erstellen Sie einen neuen Benutzer :
  • Gehen Sie zum Root Directory des Projekts
  • Exec in Backend Docker Container: Docker-Compose Exec Backend /Bin /Bash
  • Rühren Sie create_user script: python3 scripts/create_user.py
  • Geben Sie E -Mail, Passwort und Name ein, um Ihren eigenen Benutzer zu erstellen

Unterstützte Datenbanken

Ab der aktuellen Version ist MQL so konzipiert, dass sie ausschließlich mit PostgreSQL zusammenarbeitet.

---

Sie können das Tool auch ohne Docker ausführen.

• Voraussetzungen

  Dies sind die erforderlichen Pakete, die installiert werden müssen, um das Projekt lokal auszuführen.

1. Python

2. psycopg2

3. Knoten

4. PostgreSQL 15

5. PGVector -Erweiterung für PostgreSQL - PGVector

• Datenbank -Setup

  Führen Sie diese Befehle in Ihrem PostgreSQL -Befehlszeilen -Client aus

1. Erstellen der PostgreSQL -Rolle

   Erstellen Sie eine PostgreSQL -Rolle mit Superuser -Berechtigungen und Anmeldungsfähigkeiten:

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

2. Erstellen der Datenbanken

   Erstellen Sie zwei Datenbanken, mql und mql_test , mit der shuru -Rolle:

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

3. Erstellen der Erweiterung

   So erstellen Sie die vector :

• Verbinden Sie mit der Datenbank mit:

  c < databse_name >

• Erstellen Sie die Vektorerweiterung:

  CREATE EXTENSION vector;

• Aktualisieren Sie Ihre Umwelt

  Aktualisieren Sie diese Werte auf 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> "

  Wenn die Datenbank lokal gehostet wird, ist Host localhost

• Führen Sie das Skript aus

  Navigieren Sie zum Repository -Ordner und führen Sie den Befehl im Terminal aus

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

Sobald die Installation abgeschlossen ist, können Sie auf das MQL -Dashboard unter: http: // localhost: 3000 zugreifen

Genauigkeitstestbewertung

In unserem Testprozess wurden 50 Abfragen für natürliche Sprache über die MQL -Plattform mit Ressourcen wie einer eLearning_schema -Datei und einem CSV von Abfragebachbörsen in unserem Ordner test_data ausgeführt. Die MQL erreichte eine Erfolgsquote von rund 85% und übersetzte genau 43 von 50 Abfragen. Bei der Betrachtung der Präzision der Übersetzungen wurden jedoch etwa 74% (37 von 50) der Abfragen perfekt ausgeführt, wobei 6 Abfragen korrekt interpretiert, aber am Ende ein Halbkolon fehlten. Dies ließ uns mit 7 Abfragen zurück, die zu Fehlern führten. Wir arbeiten aktiv an Verbesserungen, um sowohl die Genauigkeit als auch die Vollständigkeit der SQL -Syntax -Generation zu verbessern, und begrüßen Beiträge, um unsere Plattform zu verfeinern.

• Wir haben von hier aus Datenbank festgelegt, um den Testzweck zu testen.
• Sie können den Test_Data -Ordner entfernen, nachdem Sie ihn überprüft haben.

Nächste Schritte/Funktionen

Wir planen, nach der ersten Veröffentlichung weiter zu bauen und freuen uns auf das Feedback der Community. Ab sofort haben wir folgende Funktionen für die nächsten Veröffentlichungen geplant.

• Implementierung der Abfrageausführung
• Verbessern Sie direkt verbundene DBS- und SQL -Abfrageergebnisse
• Unterstützung für die MySQL -Datenbank
• Verbesserungen der Abfragegenauigkeit
• Zeigen Sie natürliche Sprachantwort und Datenvisualisierung.
• Der Benutzer kann Slack oder ähnliche Apps integrieren, um dort NL -Abfrageergebnis zu erzielen.
• Testen Sie die Umrüstung, um die Abfragen zu generieren.

Beitragsrichtlinien

Wir schätzen die Beiträge jedes Entwicklers und ermutigen Sie, Ihre Ideen, Verbesserungen und Behebung mit uns zu teilen. Um einen reibungslosen Zusammenarbeitsprozess zu gewährleisten, befolgen Sie diese Richtlinien bitte.

Bevor Sie beginnen:

• Stellen Sie sicher, dass Sie ein Github -Konto haben.
• Machen Sie sich mit dem Projekt vertraut, indem Sie die Readme lesen, die Probleme untersuchen und die Architektur- und Codierungsstandards des Tools verstehen.

Wie man beiträgt

Meldung von Fehler

Vor dem Melden eines Fehlers bitte:

• Überprüfen Sie den Ausgabe -Tracker, um sicherzustellen, dass der Fehler noch nicht gemeldet wurde.
• Wenn das Problem nicht gemeldet ist, erstellen Sie ein neues Problem, sofern:
  • Ein klarer Titel und eine klare Beschreibung.
  • Schritte zur Reproduktion des Fehlers.
  • Erwartetes Verhalten und was tatsächlich passiert ist.
  • Alle relevanten Fehlermeldungen oder Screenshots.

Wenn wir Verbesserungen vorschlagen, erhalten wir Vorschläge für Verbesserungen! Bitte:

• Überprüfen Sie zunächst, ob die Verbesserung bereits vorgeschlagen wurde.
• Wenn nicht, öffnen Sie ein neues Problem, um die Verbesserung zu beschreiben und warum dies von Vorteil wäre.

Anfragen ziehen , um Code beizutragen? Folgen Sie folgenden Schritten:

1. Geben Sie das Repository aus - Erstellen Sie Ihre eigene Gabel des Projekts.
2. Erstellen Sie eine neue Filiale für Ihre Änderungen - Halten Sie Ihre Filiale auf eine einzelne Funktion oder Fehlerbehebung konzentriert.
3. Bestimmen Sie Ihre Änderungen - Schreiben Sie klare, präzise Feststellmeldungen, die Ihre Änderungen erklären.
4. Befolgen Sie die Codierungsstandards - Stellen Sie sicher, dass Ihr Code die im Projekt verwendeten Codierungsstandards anhält.
5. Schreiben Sie Tests - Wenn möglich, schreiben Sie Tests, um die neue Funktionalität oder die Fehlerbehebung zu decken.
6. Senden Sie eine Pull -Anfrage - geben Sie eine klare Beschreibung des Problems und der Lösung. Fügen Sie gegebenenfalls die entsprechende Ausgabennummer ein.

Verhaltensweisen Wir sind bestrebt, für alle eine einladende und inspirierende Gemeinschaft zu bieten. Wenn Sie an diesem Projekt teilnehmen, wird erwartet, dass Sie unseren Verhaltenskodex aufrechterhalten, der Respekt und Zusammenarbeit fördert.