mql

MQL

MQL（私のクエリ言語）は、自然言語クエリを実行可能な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ファイルでデータベース_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）に接続し、ユーザーテーブルから削除する必要があります。
• 新しいユーザーを作成します：
  • Projectのルートディレクトリに移動します
  • バックエンドのexec dockerコンテナ：docker-compose exec backend /bin /bash
  • create_userスクリプト：python3 scripts/create_user.pyを実行します
  • 電子メール、パスワード、名前を入力して、独自のユーザーを作成する

サポートされているデータベース

現在のバージョンの時点で、MQLはPostgreSQLでのみ動作するように設計されています。

---

Dockerなしでツールをローカルに実行することもできます。

• 前提条件

  これらは、プロジェクトをローカルに実行するためにインストールする必要がある必要なパッケージです。

1. Python

2. psycopg2

3. ノード

4. postgreSQL 15

5. PostgreSQLのPGVector拡張 - pgvector

• データベースのセットアップ

  これらのコマンドをPostgreSQLコマンドラインクライアントで実行します

1. PostgreSQLロールの作成

   スーパーユーザーの許可とログイン機能を使用して、PostgreSQLロールを作成します。

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

2. データベースの作成

   shuru役割で、 mqlとmql_test 2つのデータベースを作成します。

    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

インストールが完了したら、http：// localhost：3000でMQLダッシュボードにアクセスできます。

精度テストスコア

テストプロセスには、ELARNING_SCHEMAファイルなどのリソースと、TEST_DATAフォルダーにあるクエリマッピングのCSVを使用して、MQLプラットフォームを介して50の自然言語クエリを実行することが含まれていました。 MQLは約85％の成功率を達成し、50のクエリのうち43を正確に翻訳しました。ただし、翻訳の精度を考慮すると、クエリの約74％（50のうち37）が完全に実行され、6つのクエリが正しく解釈されましたが、最後にセミコロンがありませんでした。これにより、エラーが発生する7つのクエリが残りました。私たちは、SQL構文生成の精度と完全性の両方を改善するために積極的に拡張に取り組んでおり、プラットフォームの改良を支援するための貢献を歓迎します。

• テスト目的のために、ここからデータベースセットを撮影しました。
• Test_Dataフォルダーをチェックした後、削除できます。

次のステップ/機能

最初のリリース後も構築を続ける予定で、コミュニティからのフィードバックを楽しみにしています。現在のところ、次のリリースに向けて以下の機能が計画されています。

• クエリ実行の実装
• 直接接続されたDBSおよびSQLクエリの結果を改善します
• MySQLデータベースのサポート
• クエリの精度の改善
• 自然言語の反応とデータの視覚化を示します。
• ユーザーは、Slackまたは同様のアプリを統合して、NLクエリの結果を取得できます。
• リツールをテストしてクエリを生成します。

貢献ガイドライン

私たちは各開発者の貢献を大切にし、あなたのアイデア、改善、修正を私たちと共有することをお勧めします。スムーズなコラボレーションプロセスを確保するには、これらのガイドラインに従ってください。

始める前に：

• GitHubアカウントがあることを確認してください。
• Readmeを読んで、問題を調査し、ツールのアーキテクチャとコーディング基準を理解して、プロジェクトに慣れてください。

貢献する方法

バグの報告

バグを報告する前に、

• 問題トラッカーを確認して、バグがまだ報告されていないことを確認してください。
• 問題が報告されていない場合は、次のように新しい問題を作成します。
  • 明確なタイトルと説明。
  • バグを再現する手順。
  • 予想される行動と実際に何が起こったのか。
  • 関連するエラーメッセージまたはスクリーンショット。

強化を提案する私たちは、機能強化のための提案を受けたいと思っています！お願いします：

• まず、拡張がすでに提案されているかどうかを確認します。
• そうでない場合は、新しい問題を開き、強化とそれが有益である理由を説明してください。

コードを寄付する準備ができたリクエストをプルしますか？次の手順に従ってください：

1. フォークリポジトリ - プロジェクトの独自のフォークを作成します。
2. 変更のための新しいブランチを作成します - ブランチを単一の機能またはバグ修正に集中させてください。
3. あなたの変更をコミット - あなたの変更を説明する明確で簡潔なコミットメッセージを書いてください。
4. コーディング標準に従ってください - プロジェクト全体で使用されるコーディング標準にコードが付着していることを確認してください。
5. テストを書き込む - 可能であれば、新しい機能またはバグ修正をカバーするためにテストを書きます。
6. プルリクエストを送信 - 問題と解決策の明確な説明を提供します。該当する場合は、関連する問題番号を含めます。

行為私たちは、すべての人に歓迎的で刺激的なコミュニティを提供することにコミットしています。このプロジェクトに参加することにより、尊敬と協力を促進する行動規範を支持することが期待されています。