mql

MQL

O MQL (minha linguagem de consulta) é uma ferramenta poderosa para transformar consultas de linguagem natural em consultas SQL executáveis. O que é legal é que qualquer um pode usá -lo, mesmo sem saber como codificar. Basta adicionar seu banco de dados conectando ou carregando o esquema ao MQL, solicite uma consulta no seu idioma e obtenha o SQL.

MQL_QUERY_DEMO.MP4

Começando

Mql_getstarted.mp4

Execute a ferramenta localmente usando o Docker.

• Verifique se você está instalado no Docker.

• Para começar, clonar este repositório Git:

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

• Atualizar servidor/Dockerfile com sua tecla OPENAI_API_KEY :

   ENV OPENAI_API_KEY YOUR_TOKEN_HERE
  

• Atualize o Database_url no arquivo servidor/.env de acordo com as seguintes regras:

  • Se você estiver usando o Docker para executar o MQL, poderá usar o 'PostGres' como nome do host.
  • Se você não estiver usando o Docker para executar o MQL, poderá usar 'localhost' como nome do host.

• Navegue até a pasta do repositório e execute o seguinte comando:

   make install
  

  Depois que a instalação estiver concluída, você pode acessar o painel MQL em: http: // localhost: 3000

---

Se necessário, você também pode reiniciar para refletir as alterações locais, se houver, usando:

 make restart

Além disso, você pode encerrar a configuração local usando:

 make down

Além disso, você pode iniciar todos os contêineres usando:

 make up

Use email/senha padrão para fazer login para testar MQL

Um usuário padrão é criado para fins de login ao executar a ferramenta usando o Docker.

• E -mail - [email protected]
• Senha - Admin

Quer produzir MQL?

Cuide das etapas abaixo se você quiser fazê -lo viver

• Exclua o usuário padrão : para excluir o usuário padrão ([email protected]), você precisa se conectar ao banco de dados MQL (MQL-POSTGRES) e removê-lo da tabela de usuários.
• Crie um novo usuário :
  • Vá para o diretório raiz do projeto
  • Exec em contêiner de back-end: Docker-Compomose Exec Backend /Bin /Bash
  • Run Create_user Script: Python3 Scripts/create_user.py
  • Digite email, senha e nome para criar seu próprio usuário

Bancos de dados suportados

Na versão atual, o MQL foi projetado para funcionar exclusivamente com o PostgreSQL.

---

Você também pode executar a ferramenta localmente sem o Docker.

• Pré -requisitos

  Estes são os pacotes necessários que precisam ser instalados para executar o projeto localmente.

1. Python

2. Psycopg2

3. Nó

4. PostGresql 15

5. Extensão PGVector para PostgreSQL - PGVector

• Configuração do banco de dados

  Execute esses comandos em seu cliente de linha de comando PostGresql

1. Criando a função PostGresql

   Crie uma função PostGresql com permissões de superusuário e capacidade de login:

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

2. Criando os bancos de dados

   Crie dois bancos de dados, mql e mql_test , com a função shuru :

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

3. Criando a extensão

   Para criar a extensão vector :

• Conecte -se com o banco de dados usando:

  c < databse_name >

• Crie a extensão vetorial:

  CREATE EXTENSION vector;

• Atualize seu env

  Atualize esses valores no servidor/.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> "

  Se o banco de dados estiver hospedado localmente, o host será localhost

• Execute o script

  Navegue até a pasta do repositório e execute o comando no terminal

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

Depois que a instalação estiver concluída, você pode acessar o painel MQL em: http: // localhost: 3000

Pontuação do teste de precisão

Nosso processo de teste envolveu a execução de 50 consultas de linguagem natural através da plataforma MQL, com recursos como um arquivo de eLearning_schema e um CSV de mapeamentos de consulta localizado em nossa pasta test_data. O MQL alcançou cerca de 85% de taxa de sucesso , traduzindo com precisão 43 das 50 consultas. No entanto, ao considerar a precisão das traduções, cerca de 74% (37 em 50) das consultas foram executadas perfeitamente, com 6 consultas corretamente interpretadas, mas perdendo um semi-colon no final. Isso nos deixou com 7 consultas que resultaram em erros. Estamos trabalhando ativamente em aprimoramentos para melhorar a precisão e a integridade da geração de sintaxe do SQL, e agradecemos contribuições para ajudar a refinar nossa plataforma.

• Tomamos o banco de dados definido daqui para fins de teste.
• Você pode remover a pasta Test_data depois de verificar.

Próximas etapas/recursos

Planejamos continuar construindo após o lançamento inicial e esperamos o feedback da comunidade. A partir de agora, temos os seguintes recursos planejados para os próximos lançamentos.

• Implementação da execução de consulta
• Melhore os resultados diretamente conectados de consulta DBS e SQL
• Suporte ao banco de dados MySQL
• Melhorias na precisão da consulta
• Mostrar resposta à linguagem natural e visualização de dados.
• O usuário pode integrar o Slack ou aplicativos semelhantes para obter o resultado da consulta NL lá.
• Teste o retool para gerar as consultas.

Diretrizes de contribuição

Valorizamos as contribuições de cada desenvolvedor e o incentivamos a compartilhar suas idéias, melhorias e correções conosco. Para garantir um processo de colaboração suave, siga estas diretrizes.

Antes de começar:

• Verifique se você tem uma conta do GitHub.
• Familiarize -se com o projeto lendo o ReadMe, explorando os problemas e entendendo os padrões de arquitetura e codificação da ferramenta.

Como contribuir

Relatórios de bugs

Antes de relatar um bug, por favor:

• Verifique o rastreador de problemas para garantir que o bug ainda não tenha sido relatado.
• Se o problema não for relatado, crie um novo problema, fornecendo:
  • Um título e descrição claros.
  • Etapas para reproduzir o bug.
  • Comportamento esperado e o que realmente aconteceu.
  • Quaisquer mensagens de erro relevantes ou capturas de tela.

Sugerindo aprimoramentos que adoramos receber sugestões para aprimoramentos! Por favor:

• Primeiro, verifique se o aprimoramento já foi sugerido.
• Caso contrário, abra um novo problema, descrevendo o aprimoramento e por que seria benéfico.

Puxar solicitações prontas para contribuir com código? Siga estas etapas:

1. Garra o repositório - crie seu próprio garfo do projeto.
2. Crie uma nova ramificação para suas alterações - mantenha sua filial focada em um único recurso ou correção de bug.
3. Compreenda suas alterações - escreva mensagens claras e concisas que expliquem suas alterações.
4. Siga os padrões de codificação - verifique se o seu código adere aos padrões de codificação usados ​​ao longo do projeto.
5. Testes de gravação - Se possível, escreva testes para cobrir a nova funcionalidade ou correção de bug.
6. Envie uma solicitação de tração - forneça uma descrição clara do problema e da solução. Inclua o número da questão relevante, se aplicável.

Conduta Estamos comprometidos em fornecer uma comunidade acolhedora e inspiradora para todos. Ao participar deste projeto, espera -se que você defenda nosso código de conduta, que promove respeito e colaboração.