Giter VIP home page Giter VIP logo

text2sql's Introduction

Text2SQL

Fetch data from SQL Database using Natural language image

Overview

Text2SQL project is aimed at developing a system that can interpret natural language queries and convert them into equivalent SQL queries and execute them using LLMs. Leveraging natural language processing (NLP) and semantic parsing techniques, Text2SQL bridges the gap between human language and structured query languages. This approach enables users to interact with databases more intuitively.

Getting Started

To run the ChatBot project locally, follow these steps:

  1. Clone the Repository: git clone {repo url}

  2. Install Dependencies: Navigate to the project directory and install the required dependencies: pip install -r requirements.txt

  3. Add Google API Key: Obtain OPENAI API key and add it to the .env file in the project directory: OPENAI_API_KEY=your_openai_api_key

  4. Add DATABASE Details: Obtain Database details like Hostname, Username, password, Database name and add it to the .env file in the project directory.

  5. Run the Project: Launch the chatbot application using Streamlit: streamlit run NL2SQL.py

  6. Interact with the ChatBot: Open your web browser and navigate to the provided URL to interact with ChatBot.

Project Structure

The project structure is organized as follows:

  • NL2SQL.py: Main application file containing the Streamlit user interface and chatbot functionality.

  • requirements.txt: List of Python dependencies required to run the project.

  • .env: Environment configuration file for storing sensitive information (e.g., API keys).

  • README.md: Project documentation file.

text2sql's People

Contributors

alcatraz2141 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.