Skip to content

Latest commit

 

History

History
83 lines (54 loc) · 2.21 KB

README.md

File metadata and controls

83 lines (54 loc) · 2.21 KB
Raw

SQL Chat

License

Welcome to SQL Chat! This is an interactive chat application that allows you to connect to your MySQL database and ask questions in natural language. It leverages the power of LangChain, ChatGroq, and Streamlit to provide a seamless conversational experience.

Table of Contents

Features

  • Connect to a MySQL database using user-provided connection details.
  • Chat with your MySQL database using natural language queries.
  • Leverage LangChain's capabilities to generate SQL queries based on user questions.
  • Convert SQL responses into natural language for easy understanding.
  • Persistent conversation history throughout the chat session.

Installation

  1. Clone the repository:

    git clone https://github.com/Soumya-Kushwaha/SQL-Chat.git

  2. Navigate to the project directory:

    cd SQL-Chat

  3. Create a virtual environment and activate it:

    python3 -m venv venv
source venv/bin/activate  # For macOS/Linux
# OR
venv\Scripts\activate.bat  # For Windows

  4. Install the required dependencies:

    pip install -r requirements.txt

  5. Create a .env file in the root directory with your Groq Free API:

    GROQ_API_KEY = "groq api key"

Configuration

The project requires configuration for MySQL connection, by manually entering the connection details in the sidebar within the app.

Usage

  1. Launch the application:

    streamlit run app.py

  2. Connect to your MySQL database using the sidebar in the app.

  3. Start asking questions about your database in natural language using the chat input box.

  4. The application will provide SQL queries and natural language responses to your questions.

Contributing

Contributions to the project are welcome! Please open an issue or submit a pull request if you find any bugs or have ideas for improvements.

License

This project is licensed under the MIT License.