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 в бэкэнд-контейнере Docker: Docker-Compose Exec Backend /Bin /Bash
  • Запустить скрипт create_user: python3 scripts/create_user.py
  • Введите электронное письмо, пароль и имя, чтобы создать своего собственного пользователя

Поддерживаемые базы данных

По состоянию на текущую версию MQL предназначен для работы исключительно с PostgreSQL.

---

Вы также можете запустить инструмент локально без докера.

• Предварительные условия

  Это необходимые пакеты, которые необходимо установить для запуска проекта локально.

1. Питон

2. psycopg2

3. Узел

4. Postgresql 15

5. Расширение PGVector для PostgreSQL - PGVector

• Настройка базы данных

  Запустите эти команды в вашем клиенте командной строки PostgreSQL

1. Создание роли PostgreSQL

   Создайте роль PostgreSQL с разрешениями суперпользователя и возможности входа в систему:

   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> "

  Если база данных будет размещена локально, то host будет 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.
• Проверьте повторную проверку, чтобы генерировать запросы.

Руководящие принципы вклада

Мы ценим вклад каждого разработчика и призываем вас поделиться своими идеями, улучшениями и исправлениями с нами. Чтобы обеспечить плавный процесс сотрудничества, пожалуйста, следуйте этим рекомендациям.

Прежде чем начать:

• Убедитесь, что у вас есть учетная запись GitHub.
• Познакомьтесь с проектом, прочитав Readme, изучив проблемы и понимая архитектуру и стандарты кодирования инструмента.

Как внести свой вклад

Сообщать об ошибках

Прежде чем сообщать об ошибке, пожалуйста:

• Проверьте трекер проблемы, чтобы убедиться, что ошибка еще не сообщила.
• Если проблема не сообщена, создайте новую проблему, предоставив:
  • Четкое название и описание.
  • Шаги, чтобы воспроизвести ошибку.
  • Ожидаемое поведение и то, что на самом деле произошло.
  • Любые соответствующие сообщения об ошибках или скриншоты.

Предлагая усовершенствования, мы любим получать предложения для улучшений! Пожалуйста:

• Во -первых, проверьте, если улучшение уже было предложено.
• Если нет, откройте новую проблему, описывая улучшение и почему это было бы полезно.

Получить запросы , готовые внести код? Следуйте этим шагам:

1. Вилка репозитория - создайте свою собственную вилку проекта.
2. Создайте новую филиал для ваших изменений - сосредоточьтесь на одной функции или исправлении ошибок.
3. Сделайте свои изменения - напишите четкие, краткие сообщения о коммит, которые объясняют ваши изменения.
4. Следуйте стандартам кодирования - убедитесь, что ваш код придерживается стандартов кодирования, используемых на протяжении всего проекта.
5. Запишите тесты - если возможно, напишите тесты, чтобы покрыть новую функциональность или исправление ошибки.
6. Отправьте запрос на привлечение - предоставьте четкое описание проблемы и решения. Включите соответствующий номер выпуска, если применимо.

Поведение мы стремимся предоставить гостеприимное и вдохновляющее сообщество для всех. Принимая участие в этом проекте, вы ожидаете, что наш кодекс поведения, который способствует уважению и сотрудничеству.