mql

MQL

MQL (Query Language)은 자연어 쿼리를 실행 가능한 SQL 쿼리로 변환하는 강력한 도구입니다. 멋진 것은 코딩 방법을 모르더라도 누구나 사용할 수 있다는 것입니다. 스키마를 MQL에 연결하거나 업로드하여 데이터베이스를 추가하고 언어로 쿼리를 요청하고 SQL을 얻으십시오.

mql_query_demo.mp4

시작하기

mql_getstarted.mp4

Docker를 사용하여 도구를 로컬로 실행하십시오.

• Docker가 설치되어 있는지 확인하십시오.

• 시작하려면이 git 저장소를 복제하십시오.

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

• OPENAI_API_KEY 키로 서버/DockerFile 업데이트 :

   ENV OPENAI_API_KEY YOUR_TOKEN_HERE
  

• 다음 규칙에 따라 서버/.env 파일에서 database_url을 업데이트하십시오.

  • Docker를 사용하여 MQL을 실행하는 경우 'Postgres'를 호스트 이름으로 사용할 수 있습니다.
  • Docker를 사용하여 MQL을 실행하지 않으면 'localhost'를 호스트 이름으로 사용할 수 있습니다.

• 리포지토리 폴더로 이동하여 다음 명령을 실행하십시오.

   make install
  

  설치가 완료되면 http : // localhost : 3000에서 MQL 대시 보드에 액세스 할 수 있습니다.

---

필요한 경우 다시 시작하여 로컬 변경 사항을 반영하여 다음을 사용합니다.

 make restart

또한 다음을 사용하여 로컬 설정을 종료 할 수 있습니다.

 make down

또한 다음을 사용하여 모든 컨테이너를 시작할 수 있습니다.

 make up

로그인하려면 기본 이메일/비밀번호를 사용하여 MQL을 테스트하십시오

Docker를 사용하여 도구를 실행하는 동안 로그인 목적으로 기본 사용자가 생성됩니다.

• 이메일 - [email protected]
• 비밀번호 - 관리자

MQL 제작을 원하십니까?

라이브로 만들려면 아래 단계를 처리하십시오.

• 기본 사용자 삭제 : 기본 사용자 ([email protected])를 삭제하려면 MQL 데이터베이스 (MQL-Postgres)에 연결 한 다음 사용자 테이블에서 제거해야합니다.
• 새 사용자 생성 :
  • 프로젝트의 루트 디렉토리로 이동하십시오
  • 백엔드 Docker 컨테이너의 Exec : Docker-Compose Exec Backend /Bin /Bash
  • Create_user 스크립트를 실행합니다 : Python3 Scripts/Create_user.py
  • 자신의 사용자를 만들려면 이메일, 비밀번호 및 이름을 입력하십시오.

지원되는 데이터베이스

현재 버전에서 MQL은 PostgreSQL과 독점적으로 작동하도록 설계되었습니다.

---

Docker없이 도구를 로컬로 실행할 수도 있습니다.

• 전제 조건

  프로젝트를 로컬로 실행하기 위해 설치 해야하는 필수 패키지입니다.

1. 파이썬

2. psycopg2

3. 마디

4. Postgresql 15

5. postgresql -pgvector에 대한 pgvector 확장

• 데이터베이스 설정

  PostgreSQL 명령 행 클라이언트 에서이 명령을 실행하십시오

1. PostgreSQL 역할 생성

   Superuser 권한 및 로그인 기능을 사용하여 PostgreSQL 역할을 작성하십시오.

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

2. 데이터베이스 생성

   shuru 역할을 가진 두 개의 데이터베이스 인 mql 및 mql_test 만듭니다.

    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

설치가 완료되면 http : // localhost : 3000에서 MQL 대시 보드에 액세스 할 수 있습니다.

정확도 테스트 점수

우리의 테스트 프로세스에는 eLearning_schema 파일과 같은 리소스와 Test_Data 폴더에있는 CSV의 쿼리 매핑과 같은 MQL 플랫폼을 통해 50 개의 자연어 쿼리를 실행하는 것이 포함되었습니다. MQL은 약 85%의 성공률을 달성하여 50 쿼리 중 43 개를 정확하게 번역했습니다. 그러나 번역의 정밀도를 고려할 때 쿼리의 약 74% (50 개 중 37 개)가 완벽하게 실행되었으며 6 개의 쿼리가 올바르게 해석되었지만 마지막에는 세미콜론이 없습니다. 이로 인해 7 개의 쿼리가 발생하여 오류가 발생했습니다. 우리는 SQL 구문 생성의 정확성과 완전성을 모두 개선하기 위해 향상을 적극적으로 노력하고 있으며 플랫폼을 개선하는 데 도움이되는 기여를 환영합니다.

• 테스트 목적으로 여기에서 데이터베이스를 설정했습니다.
• 테스트 _data 폴더를 확인한 후 제거 할 수 있습니다.

다음 단계/기능

우리는 초기 출시 후 계속 구축 할 계획이며 커뮤니티의 피드백을 기대합니다. 현재 우리는 다음 릴리스를 위해 계획된 다음 기능을 가지고 있습니다.

• 쿼리 실행 구현
• 직접 연결된 DBS 및 SQL 쿼리 결과를 개선하십시오
• MySQL 데이터베이스 지원
• 쿼리 정확도 향상
• 자연어 응답 및 데이터 시각화를 보여줍니다.
• 사용자는 슬랙 또는 이와 유사한 앱을 통합하여 NL 쿼리 결과를 얻을 수 있습니다.
• 쿼리를 생성하기 위해 재고를 테스트하십시오.

기여 지침

우리는 각 개발자의 기여를 소중히 여기며 귀하의 아이디어, 개선 및 수정 사항을 우리와 공유하도록 권장합니다. 원활한 협업 프로세스를 보려면 다음 지침을 따르십시오.

시작하기 전에 :

• GitHub 계정이 있는지 확인하십시오.
• ReadMe를 읽고, 문제를 탐색하며, 도구의 아키텍처 및 코딩 표준을 이해하여 프로젝트에 익숙해 지십시오.

기여하는 방법

보고 버그

버그를보고하기 전에 :

• 버그가 아직보고되지 않았는지 문제 추적기를 확인하십시오.
• 문제 가보고되지 않으면 새로운 문제를 만들어 다음을 제공합니다.
  • 명확한 제목과 설명.
  • 버그를 재현하는 단계.
  • 예상되는 행동과 실제로 일어난 일.
  • 관련 오류 메시지 또는 스크린 샷.

개선을 제안하는 우리는 향상에 대한 제안을받는 것을 좋아합니다! 제발:

• 먼저, 향상이 이미 제안되었는지 확인하십시오.
• 그렇지 않다면, 새로운 문제를 열어 향상과 그것이 유익한 이유를 설명하십시오.

코드를 기여할 수있는 요청을 가져 오 시겠습니까? 다음 단계를 따르십시오.

1. 포크 리포지토리 - 프로젝트 포크를 만듭니다.
2. 변경 사항을위한 새 지점을 만듭니다. 단일 기능 또는 버그 수정에 지점을 집중하십시오.
3. 변경 사항을 커밋하십시오 - 변경 사항을 설명하는 명확하고 간결한 커밋 메시지를 작성하십시오.
4. 코딩 표준에 따라 코드가 프로젝트 전반에 걸쳐 사용되는 코딩 표준을 준수해야합니다.
5. 테스트 작성 - 가능하면 새로운 기능 또는 버그 수정을 다루기 위해 테스트를 작성하십시오.
6. 풀 요청 제출 - 문제와 솔루션에 대한 명확한 설명을 제공하십시오. 해당되는 경우 관련 문제 번호를 포함하십시오.

우리는 모든 사람들에게 환영하고 영감을주는 커뮤니티를 제공하기 위해 최선 을 다하고 있습니다. 이 프로젝트에 참여함으로써 귀하는 존중과 협력을 촉진하는 우리의 행동 강령을지지해야합니다.