mql

MQL

MQL (لغة الاستعلام الخاصة بي) هي أداة قوية لتحويل استعلامات اللغة الطبيعية إلى استعلامات SQL القابلة للتنفيذ. ما هو رائع هو أنه يمكن لأي شخص استخدامه ، حتى دون معرفة كيفية الترميز. فقط أضف قاعدة البيانات الخاصة بك عن طريق توصيل المخطط أو تحميله إلى MQL ، واسأل استعلامًا بلغتك واحصل على SQL.

mql_query_demo.mp4

ابدء

mql_getstarted.mp4

قم بتشغيل الأداة محليًا باستخدام Docker.

• تأكد من تثبيت Docker.

• للبدء ، استنساخ هذا المستودع git:

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

• تحديث الخادم/dockerfile مع مفتاح OPENAI_API_KEY الخاص بك:

   ENV OPENAI_API_KEY YOUR_TOKEN_HERE
  

• قم بتحديث DATABASE_URL في ملف Server/.env وفقًا للقواعد التالية:

  • إذا كنت تستخدم Docker لتشغيل MQL ، فيمكنك استخدام "Postgres" كاسم المضيف.
  • إذا كنت لا تستخدم Docker لتشغيل MQL ، فيمكنك استخدام "LocalHost" كاسم المضيف.

• انتقل إلى مجلد المستودع وقم بتشغيل الأمر التالي:

   make install
  

  بمجرد اكتمال التثبيت ، يمكنك الوصول إلى لوحة معلومات MQL على: http: // localhost: 3000

---

إذا لزم الأمر ، يمكنك أيضًا إعادة التشغيل لتعكس التغييرات المحلية ، إن وجدت ، باستخدام:

 make restart

أيضًا ، يمكنك إنهاء الإعداد المحلي باستخدام:

 make down

أيضًا ، يمكنك بدء جميع الحاويات باستخدام:

 make up

استخدم البريد الإلكتروني/كلمة المرور الافتراضية لتسجيل الدخول لاختبار MQL

يتم إنشاء مستخدم افتراضي لغرض تسجيل الدخول أثناء تشغيل الأداة باستخدام Docker.

• البريد الإلكتروني - [email protected]
• كلمة المرور - المسؤول

تريد إنتاج MQL؟

اعتني بالخطوات أدناه إذا كنت تتطلع إلى جعله مباشرًا

• حذف المستخدم الافتراضي : لحذف المستخدم الافتراضي ([email protected]) ، تحتاج إلى الاتصال بقاعدة بيانات MQL (MQL-Postgres) ثم إزالته من جدول المستخدمين.
• إنشاء مستخدم جديد :
  • انتقل إلى دليل الجذر للمشروع
  • Exec in Backend Docker Container: Docker-Compose Exec Backend /Bin /Bash
  • قم بتشغيل البرنامج النصي Create_user: Python3 Scripts/create_user.py
  • أدخل البريد الإلكتروني وكلمة المرور والاسم لإنشاء المستخدم الخاص بك

قواعد البيانات المدعومة

اعتبارًا من الإصدار الحالي ، تم تصميم MQL للعمل بشكل حصري مع PostgreSQL.

---

يمكنك أيضًا تشغيل الأداة محليًا بدون Docker.

• المتطلبات الأساسية

  هذه هي الحزم المطلوبة التي يجب تثبيتها لتشغيل المشروع محليًا.

1. بيثون

2. PSYCOPG2

3. العقدة

4. postgresql 15

5. امتداد PGVector لـ PostgreSQL - PGVector

• إعداد قاعدة البيانات

  قم بتشغيل هذه الأوامر في عميل سطر أوامر PostgreSQL الخاص بك

1. إنشاء دور postgresql

   قم بإنشاء دور postgresql مع أذونات Superuser وقدرة تسجيل الدخول:

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

2. إنشاء قواعد البيانات

   قم بإنشاء قواعد بيانات ، mql و mql_test ، مع دور shuru :

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

3. إنشاء الامتداد

   لإنشاء ملحق vector :

• تواصل مع قاعدة البيانات باستخدام:

  c < databse_name >

• قم بإنشاء ملحق المتجه:

  CREATE EXTENSION vector;

• قم بتحديث ENV الخاص بك

  قم بتحديث هذه القيم في 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> "

  إذا تم استضافة قاعدة البيانات محليًا ، فسيكون المضيف localhost

• تشغيل البرنامج النصي

  انتقل إلى مجلد المستودع وقم بتشغيل الأمر في المحطة

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

بمجرد اكتمال التثبيت ، يمكنك الوصول إلى لوحة معلومات MQL على: http: // localhost: 3000

درجة اختبار الدقة

تضمنت عملية الاختبار الخاصة بنا تشغيل 50 استعلامات لغة طبيعية من خلال منصة MQL ، مع موارد مثل ملف elearning_schema ، و CSV من تعيينات الاستعلام الموجودة في مجلد Test_Data الخاص بنا. حققت MQL حوالي 85 ٪ معدل نجاح ، وترجم بدقة 43 من أصل 50 استعلام. ومع ذلك ، عند النظر في دقة الترجمات ، تم تنفيذ حوالي 74 ٪ (37 من أصل 50) من الاستعلامات بشكل مثالي ، مع تفسير 6 استعلامات بشكل صحيح ولكن في عداد المفقودين في النهاية في النهاية. ترك هذا مع 7 استفسارات أسفرت عن أخطاء. نحن نعمل بنشاط على تحسينات لتحسين كل من دقة واكتمال توليد SQL SQL ، ونرحب بالمساهمات للمساعدة في تحسين منصتنا.

• لقد أخذنا مجموعة قاعدة البيانات من هنا للاختبار الغرض.
• يمكنك إزالة مجلد Test_Data بعد التحقق منه.

الخطوات/الميزات التالية

نخطط لمواصلة البناء بعد الإصدار الأولي ونتطلع إلى التعليقات من المجتمع. اعتبارا من الآن لدينا الميزات التالية المخطط لها للإصدارات التالية.

• تنفيذ تنفيذ الاستعلام
• تحسين نتائج استعلام DBS و SQL المتصلة مباشرة
• دعم قاعدة بيانات MySQL
• تحسينات في دقة الاستعلام
• إظهار استجابة اللغة الطبيعية وتصور البيانات.
• يمكن للمستخدم دمج Slack أو تطبيقات مماثلة للحصول على نتيجة استعلام NL هناك.
• اختبار إعادة تجديد لتوليد الاستعلامات.

إرشادات المساهمة

نحن نقدر مساهمات كل مطور ونشجعك على مشاركة أفكارك وتحسيناتك وإصلاحاتك. لضمان عملية تعاون سلسة ، يرجى اتباع هذه الإرشادات.

قبل أن تبدأ:

• تأكد من أن لديك حساب github.
• تعرف على المشروع من خلال قراءة ReadMe ، واستكشاف القضايا ، وفهم معايير الهندسة المعمارية والترميز.

كيفية المساهمة

الإبلاغ عن الأخطاء

قبل الإبلاغ عن خطأ ، من فضلك:

• تحقق من تعقب المشكلة لضمان عدم الإبلاغ عن الخطأ بالفعل.
• إذا لم يتم الإبلاغ عن المشكلة ، فقم بإنشاء مشكلة جديدة ، وتوفير:
  • عنوان واضح ووصف.
  • خطوات لإعادة إنتاج الخلل.
  • السلوك المتوقع وما حدث بالفعل.
  • أي رسائل خطأ ذات صلة أو لقطات شاشة.

مما يشير إلى تحسينات نحن نحب تلقي اقتراحات للتحسينات! لو سمحت:

• أولاً ، تحقق مما إذا كان قد تم اقتراح التعزيز بالفعل.
• إذا لم يكن الأمر كذلك ، افتح مشكلة جديدة ، واصفًا التعزيز ولماذا سيكون مفيدًا.

سحب طلبات جاهزة للمساهمة رمز؟ اتبع هذه الخطوات:

1. شوكة المستودع - قم بإنشاء شوكة المشروع الخاصة بك.
2. قم بإنشاء فرع جديد للتغييرات الخاصة بك - حافظ على تركيز فرعك على ميزة واحدة أو إصلاح الأخطاء.
3. ارتكب تغييراتك - اكتب رسائل ملزمة واضحة وموجزة تشرح تغييراتك.
4. اتبع معايير الترميز - تأكد من أن الكود الخاص بك يلتزم بمعايير الترميز المستخدمة في جميع أنحاء المشروع.
5. اكتب اختبارات - إن أمكن ، اكتب اختبارات لتغطية الوظائف الجديدة أو إصلاح الأخطاء.
6. إرسال طلب سحب - قدم وصفًا واضحًا للمشكلة والحل. قم بتضمين رقم الإصدار ذي الصلة إن أمكن.

السلوك نحن ملتزمون بتوفير مجتمع ترحيب وملهم للجميع. من خلال المشاركة في هذا المشروع ، من المتوقع أن تدعم مدونة قواعد سلوكنا ، والتي تعزز الاحترام والتعاون.