mql

MQL

MQL (bahasa kueri saya) adalah alat yang ampuh untuk mengubah kueri bahasa alami menjadi kueri SQL yang dapat dieksekusi. Yang keren adalah bahwa siapa pun dapat menggunakannya, bahkan tanpa mengetahui cara membuat kode. Cukup tambahkan database Anda dengan menghubungkan atau mengunggah skema ke MQL, tanyakan kueri dalam bahasa Anda dan dapatkan SQL.

Mql_query_demo.mp4

Memulai

Mql_getstarted.mp4

Jalankan alat secara lokal menggunakan Docker.

• Pastikan Anda telah menginstal Docker.

• Untuk memulai, klon repositori git ini:

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

• Perbarui Server/DockerFile dengan kunci OPENAI_API_KEY Anda:

   ENV OPENAI_API_KEY YOUR_TOKEN_HERE
  

• Perbarui database_url di file server/.env sesuai dengan aturan berikut:

  • Jika Anda menggunakan Docker untuk menjalankan MQL, Anda dapat menggunakan 'Postgres' sebagai nama host.
  • Jika Anda tidak menggunakan Docker untuk menjalankan MQL, Anda dapat menggunakan 'LocalHost' sebagai nama host.

• Arahkan ke folder repositori dan jalankan perintah berikut:

   make install
  

  Setelah instalasi selesai, Anda dapat mengakses dasbor MQL di: http: // localhost: 3000

---

Jika perlu, Anda juga dapat memulai ulang untuk mencerminkan perubahan lokal, jika ada, menggunakan:

 make restart

Anda juga dapat menghentikan pengaturan lokal menggunakan:

 make down

Anda juga dapat memulai semua wadah yang menggunakan:

 make up

Gunakan email/kata sandi default untuk login untuk menguji MQL

Pengguna default dibuat untuk tujuan login saat menjalankan alat menggunakan Docker.

• Email - [email protected]
• Kata Sandi - Admin

Ingin memproduksi MQL?

Jaga langkah -langkah di bawah ini jika Anda ingin membuatnya hidup

• Hapus Pengguna Default : Untuk menghapus pengguna default ([email protected]), Anda harus terhubung dengan database MQL (MQL-Postgres) dan kemudian menghapusnya dari tabel pengguna.
• Buat pengguna baru :
  • Pergi ke Direktori Root Project
  • Exec in Backend Docker Container: Docker-Compose Exec Backend /Bin /Bash
  • Jalankan skrip create_user: skrip python3/create_user.py
  • Masukkan email, kata sandi, dan nama untuk membuat pengguna Anda sendiri

Database yang didukung

Pada versi saat ini, MQL dirancang untuk bekerja secara eksklusif dengan PostgreSQL.

---

Anda juga dapat menjalankan alat secara lokal tanpa Docker.

• Prasyarat

  Ini adalah paket yang diperlukan yang perlu diinstal untuk menjalankan proyek secara lokal.

1. Python

2. psycopg2

3. Node

4. PostgreSQL 15

5. Ekstensi PGVector untuk PostgreSQL - PGVector

• Pengaturan Basis Data

  Jalankan perintah ini di klien baris perintah postgresql Anda

1. Membuat Peran PostgreSQL

   Buat peran PostgreSQL dengan izin superuser dan kemampuan login:

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

2. Membuat database

   Buat dua database, mql dan mql_test , dengan peran shuru :

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

3. Membuat ekstensi

   Untuk membuat ekstensi vector :

• Terhubung dengan database menggunakan:

  c < databse_name >

• Buat ekstensi vektor:

  CREATE EXTENSION vector;

• Perbarui Env Anda

  Perbarui nilai -nilai ini di 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> "

  Jika database di -host secara lokal maka host akan menjadi localhost

• Jalankan skrip

  Arahkan ke folder repositori dan jalankan perintah di terminal

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

Setelah instalasi selesai, Anda dapat mengakses dasbor MQL di: http: // localhost: 3000

Skor tes akurasi

Proses pengujian kami melibatkan menjalankan 50 kueri bahasa alami melalui platform MQL, dengan sumber daya seperti file eLearning_schema, dan CSV pemetaan kueri yang terletak di folder test_data kami. MQL mencapai tingkat keberhasilan sekitar 85% , secara akurat menerjemahkan 43 dari 50 pertanyaan. Namun, ketika mempertimbangkan ketepatan terjemahan, sekitar 74% (37 dari 50) kueri dieksekusi dengan sempurna, dengan 6 kueri ditafsirkan dengan benar tetapi kehilangan semi-kolon pada akhirnya. Ini meninggalkan kami dengan 7 pertanyaan yang mengakibatkan kesalahan. Kami secara aktif bekerja pada peningkatan untuk meningkatkan akurasi dan kelengkapan generasi sintaks SQL, dan kami menyambut kontribusi untuk membantu memperbaiki platform kami.

• Kami telah mengambil set basis data dari sini untuk tujuan pengujian.
• Anda dapat menghapus folder test_data setelah memeriksanya.

Langkah/fitur berikutnya

Kami berencana untuk terus membangun setelah rilis awal dan menantikan umpan balik dari masyarakat. Sampai sekarang kami memiliki fitur berikut yang direncanakan untuk rilis berikutnya.

• Implementasi eksekusi kueri
• Tingkatkan hasil kueri DBS dan SQL yang terhubung langsung
• Dukungan untuk database MySQL
• Peningkatan akurasi kueri
• Tunjukkan respons bahasa alami dan visualisasi data.
• Pengguna dapat mengintegrasikan Slack atau aplikasi serupa untuk mendapatkan hasil kueri NL di sana.
• Uji retool untuk menghasilkan kueri.

Pedoman Kontribusi

Kami menghargai kontribusi masing -masing pengembang dan mendorong Anda untuk berbagi ide, peningkatan, dan perbaikan dengan kami. Untuk memastikan proses kolaborasi yang lancar, silakan ikuti pedoman ini.

Sebelum Anda mulai:

• Pastikan Anda memiliki akun GitHub.
• Biasakan diri Anda dengan proyek dengan membaca ReadMe, mengeksplorasi masalah, dan memahami arsitektur alat dan standar pengkodean.

Bagaimana berkontribusi

Melaporkan bug

Sebelum melaporkan bug, tolong:

• Periksa pelacak masalah untuk memastikan bug belum dilaporkan.
• Jika masalahnya tidak dilaporkan, buat masalah baru, berikan:
  • Judul dan deskripsi yang jelas.
  • Langkah -langkah untuk mereproduksi bug.
  • Perilaku yang diharapkan dan apa yang sebenarnya terjadi.
  • Pesan kesalahan atau tangkapan layar yang relevan.

Menyarankan Peningkatan Kami senang menerima saran untuk peningkatan! Silakan:

• Pertama, periksa apakah peningkatannya sudah disarankan.
• Jika tidak, buka masalah baru, menggambarkan peningkatan dan mengapa itu akan bermanfaat.

Permintaan tarik siap untuk menyumbangkan kode? Ikuti langkah -langkah ini:

1. Fork The Repository - Buat garpu proyek Anda sendiri.
2. Buat cabang baru untuk perubahan Anda - jaga agar cabang Anda fokus pada satu fitur atau perbaikan bug.
3. Komitmen Anda - Tulis pesan komit ringkas yang jelas yang menjelaskan perubahan Anda.
4. Ikuti standar pengkodean - pastikan kode Anda mematuhi standar pengkodean yang digunakan di seluruh proyek.
5. Tulis Tes - Jika memungkinkan, tulis tes untuk mencakup fungsionalitas baru atau perbaikan bug.
6. Kirimkan permintaan tarik - berikan deskripsi yang jelas tentang masalah dan solusi. Sertakan nomor masalah yang relevan jika berlaku.

Perilaku Kami berkomitmen untuk menyediakan komunitas yang ramah dan menginspirasi untuk semua. Dengan berpartisipasi dalam proyek ini, Anda diharapkan untuk menjunjung tinggi kode etik kami, yang mempromosikan rasa hormat dan kolaborasi.