This project features a suite of 5 advanced AI-powered agents designed to assist with various SQL database tasks, leveraging OpenAI's LLMs.
- Text-to-SQL Generator: Converts natural language questions into executable SQL queries.
- SQL Query Optimizer: Analyzes existing SQL queries and suggests performance optimizations.
- SQL Explainer: Translates complex SQL queries into plain English explanations.
- Database Documenter: Generates comprehensive markdown documentation for your database schema.
- Data Analysis Assistant: Executes queries and provides AI-driven insights and visualization suggestions based on the results.
-
Clone the repository:
git clone https://github.com/shravyayermalblueprints/Build_SQL_AI_AGENTS_WITH_LLM_Models.git cd Build_SQL_AI_AGENTS_WITH_LLM_Models -
Install dependencies:
pip install -r requirements.txt
-
Configure Environment:
- Create a
.envfile in the root directory. - Add your OpenAI API Key:
OPENAI_API_KEY=your_api_key_here DB_CONNECTION_STRING=sqlite:///sample.db
- Create a
Run the agents using the CLI interface:
python3 -m sql_agents.main text_to_sql --query "Show me all users"python3 -m sql_agents.main optimizer --query "SELECT * FROM users WHERE name = 'Alice'"python3 -m sql_agents.main explainer --query "SELECT count(*) FROM users GROUP BY email"python3 -m sql_agents.main documenterpython3 -m sql_agents.main analyst --query "SELECT * FROM users"sql_agents/agents/: Implementation of each agent.sql_agents/utils/: Utility functions (database connection).sql_agents/main.py: Main CLI entry point.