/askSQL

O objetivo principal deste projeto é possibilitar a interação de um usuário com uma IA em linguagem natural. Basta apenas informar o Schema de uma tabela/banco de dados e realizar uma pergunta baseando-se nela.

Primary LanguageTypeScript

ASK SQL

O objetivo principal deste projeto é simplesmente possibilitar a interação de um usuário com uma IA em linguagem natural.

Basta apenas informar o Schema da sua tabela / banco de dados e após isso ele poderá realizar as perguntas.

Vale destacar que a aplicação utiliza uma API da OpenIA, essa API tem determinado período de uso Free. Quando este período se encerrar é necessário comprar um licença. Neste caso, estou utilizando uma licença paga, então algumas limitações foram inseridas, para evitar que a mesma seja "gasta" de forma desnecessária.

Rodando os testes

Para rodar os testes, faça o seguinte:

  • Clone ou baixe o repositório em sua máquina
  • Entre na pasta raiz do projeto e instale as dependências com npm install
  • Crie uma arquivo chamado .env.local e neste arquivo configure o parâmetro OPENAI_API_KEY com a sua KEY gerada no site da OpenIA
  • Após realizar a configuração da KEY, basta rodar o projeto com npm run dev | yarn dev | pnpm dev

Documentação da API

  GET /api/completion
Parâmetro Tipo Descrição
schema string Obrigatório. Schema do banco de dados/tabela
input string Obrigatório. Pergunta para a IA

Aprendizados

Com este projeto, foi possível aprender muitas coisas, principalmente no que diz a respeito da IA, pois no mundo em que vivemos, cada dia é mais comum essa inteligência fazer parte do nosso cotidiano.

Demonstração

Imagem do Projeto Imagem do Projeto versão desktop

Stack utilizada

Etiquetas

MIT License GPLv3 License AGPL License