SQL Agent Project

Overview

The SQL Agent project is an AI-powered tool that allows users to interact with SQL databases using natural language. Instead of writing complex SQL queries, users can simply ask questions in plain English, and the AI will handle the query processing. The project leverages a multi-agent system to intelligently route queries to the appropriate processing agent, either SQL or RAG (Retrieval Augmented Generation).

Features

• Natural Language Queries: Users can ask questions about their data in plain English.
• SQL Transparency: View the generated SQL queries for each response.
• Database Schema Understanding: The AI automatically analyzes your database structure.
• Intelligent Query Routing: Uses a Supervisor Agent to determine the best way to answer your questions.

How It Works

1. Upload your SQLite Database File: Users start by uploading their SQLite database file through the web interface.
2. Ask Questions in Natural Language: Users input queries in natural language via the chat interface.
3. Supervisor Agent Decision: The Supervisor Agent analyzes the query to decide whether to use SQL or RAG to answer the question.
4. Query Processing:
   • SQL Agent: If the query is straightforward and can be directly translated into SQL, the SQL Agent handles it.
   • RAG Agent: For queries requiring contextual understanding or complex reasoning, the RAG Agent is used.
5. Get Comprehensive Answers: The system provides comprehensive answers with the option to view the underlying SQL queries.

Flowchart

Below is a flowchart illustrating the decision logic of the Supervisor Agent:

Installation

1. Clone the Repository:

   git clone <repository-url>
   cd Sql_Agent

2. Run the Setup Script: Execute the run.sh script to set up the environment and start the application.

   ./run.sh

Demo Video

Watch the demo video to see SQL Agent in action:

Usage

• Running the Application: The application is started by executing the run.sh script, which sets up the environment and runs the main application script run.py.
• Environment Variables: Ensure that the .env file is updated with your actual Google API key.

Project Structure

• run.sh: Bash script to set up the environment and run the application.
• templates/: Directory for storing HTML templates.
• uploads/: Directory for file uploads.
• agents/: Directory containing agent-related scripts.
• database/: Directory for database files.

Configuration

• .env File: Contains environment variables such as API keys. Ensure this file is not tracked by Git by adding it to .gitignore.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any enhancements or bug fixes.

License

This project is licensed under the MIT License.

Contact

For any questions or issues, please contact diptarupchakravorty794@gmail.com].