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 ในไฟล์เซิร์ฟเวอร์/.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 ใน 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 EXTENSION สำหรับ 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 ของคุณ

  อัปเดตค่าเหล่านี้ที่เซิร์ฟเวอร์/. 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 และเรายินดีต้อนรับการมีส่วนร่วมเพื่อช่วยปรับแต่งแพลตฟอร์มของเรา

• เราได้ตั้งค่าฐานข้อมูลจากที่นี่เพื่อจุดประสงค์ในการทดสอบ
• คุณสามารถลบโฟลเดอร์ test_data หลังจากตรวจสอบ

ขั้นตอนต่อไป/คุณสมบัติ

เราวางแผนที่จะสร้างต่อหลังจากการเปิดตัวครั้งแรกและหวังว่าจะได้รับคำติชมจากชุมชน ณ ตอนนี้เรามีคุณสมบัติต่อไปนี้ที่วางแผนไว้สำหรับรุ่นต่อไป

• การดำเนินการตามคำถาม
• ปรับปรุงผลการค้นหา DBS และ SQL ที่เชื่อมต่อโดยตรง
• รองรับฐานข้อมูล MySQL
• การปรับปรุงความแม่นยำในการสืบค้น
• แสดงการตอบสนองภาษาธรรมชาติและการสร้างภาพข้อมูล
• ผู้ใช้สามารถรวมแอพ Slack หรือแอพที่คล้ายกันเพื่อรับผลการค้นหา NL ที่นั่น
• ทดสอบ retool เพื่อสร้างแบบสอบถาม

แนวทางการบริจาค

เราให้ความสำคัญกับการมีส่วนร่วมของนักพัฒนาแต่ละคนและสนับสนุนให้คุณแบ่งปันความคิดการปรับปรุงและแก้ไขกับเรา เพื่อให้แน่ใจว่ากระบวนการทำงานร่วมกันที่ราบรื่นโปรดปฏิบัติตามแนวทางเหล่านี้

ก่อนที่คุณจะเริ่ม:

• ตรวจสอบให้แน่ใจว่าคุณมีบัญชี GitHub
• ทำความคุ้นเคยกับโครงการโดยการอ่าน ReadMe สำรวจปัญหาและทำความเข้าใจกับสถาปัตยกรรมและมาตรฐานการเข้ารหัสของเครื่องมือ

วิธีการมีส่วนร่วม

การรายงานข้อบกพร่อง

ก่อนรายงานข้อผิดพลาดโปรด:

• ตรวจสอบตัวติดตามปัญหาเพื่อให้แน่ใจว่าข้อผิดพลาดยังไม่ได้รับการรายงาน
• หากปัญหาไม่ได้รับการรายงานให้สร้างปัญหาใหม่โดยให้:
  • ชื่อและคำอธิบายที่ชัดเจน
  • ขั้นตอนในการทำซ้ำข้อผิดพลาด
  • พฤติกรรมที่คาดหวังและสิ่งที่เกิดขึ้นจริง
  • ข้อความแสดงข้อผิดพลาดที่เกี่ยวข้องหรือภาพหน้าจอ

แนะนำการปรับปรุงที่ เราชอบที่จะได้รับคำแนะนำสำหรับการปรับปรุง! โปรด:

• ก่อนอื่นให้ตรวจสอบว่ามีการแนะนำการปรับปรุงแล้วหรือไม่
• ถ้าไม่เปิดปัญหาใหม่อธิบายการปรับปรุงและทำไมมันถึงเป็นประโยชน์

ดึงคำขอ พร้อมที่จะมีส่วนร่วมรหัสหรือไม่? ทำตามขั้นตอนเหล่านี้:

1. แยกที่เก็บ - สร้างส้อมของคุณเอง
2. สร้างสาขาใหม่สำหรับการเปลี่ยนแปลงของคุณ - ให้สาขาของคุณมุ่งเน้นไปที่ฟีเจอร์เดียวหรือแก้ไขข้อบกพร่อง
3. กระทำการเปลี่ยนแปลงของคุณ - เขียนข้อความที่ชัดเจนและรัดกุมที่อธิบายการเปลี่ยนแปลงของคุณ
4. ทำตามมาตรฐานการเข้ารหัส - ตรวจสอบให้แน่ใจว่ารหัสของคุณปฏิบัติตามมาตรฐานการเข้ารหัสที่ใช้ตลอดทั้งโครงการ
5. การทดสอบเขียน - ถ้าเป็นไปได้ให้เขียนการทดสอบเพื่อครอบคลุมฟังก์ชันการทำงานใหม่หรือการแก้ไขข้อบกพร่อง
6. ส่งคำขอดึง - ให้คำอธิบายที่ชัดเจนเกี่ยวกับปัญหาและการแก้ปัญหา รวมหมายเลขปัญหาที่เกี่ยวข้องหากมี

ดำเนินการ เรามุ่งมั่นที่จะให้ชุมชนที่เป็นมิตรและเป็นแรงบันดาลใจสำหรับทุกคน โดยการเข้าร่วมในโครงการนี้คุณคาดว่าจะรักษาจรรยาบรรณของเราซึ่งส่งเสริมความเคารพและการทำงานร่วมกัน