Git Product home page Git Product logo

northwind_nl2sql's Introduction

Northwind NL2SQL

Overview

Northwind NL2SQL is tool designed to bridge the gap between natural language queries and SQL database queries. It takes in user-friendly natural language questions and converts them into structured SQL queries that can be directly executed on a database. This tool aims to simplify the process of querying databases, especially for users who are not familiar with SQL syntax.

Features

  • Natural Language Processing (NLP) Integration: Utilizes state-of-the-art NLP techniques to parse and understand user queries.
  • SQL Generation: Generates SQL queries based on the parsed natural language input.
  • Query Execution: Executes the generated SQL queries on the connected database.

Installation

git clone [email protected]:hzucareli/northwind_nl2sql.git
cd northwind_nl2sql
npm i
node runQuestions.js 

Usage

node runQuestions.js --execute # will execute de queries

Configuration

  • Edit the .env file to specify database connection details and OpenAI Key and optionally the LangSmith key for better monitoring the LangChain.

Contributing

Contributions are welcome! If you'd like to contribute to the project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Commit your changes (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature/your-feature).
  5. Create a new Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Links

  • OpenAI for their language models
  • LangChain The tramework used for this project
  • LangSmith For better control of the LLM lifecycle
  • MySQL The Database used in this project

northwind_nl2sql's People

Contributors

hzucareli avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.