Skip to content

Latest commit

 

History

History
196 lines (149 loc) · 6.05 KB

README.md

File metadata and controls

196 lines (149 loc) · 6.05 KB

Banner

Made with Azure OpenAI Built with Streamlit Database

🎯 Transform natural language into powerful SQL queries with ease!

Magnifying Glass Turn your words into SQL magic Chart Visualize your data dynamically Tabs Multi-database support

✨ Features

🎯 Core Features
  • Natural Language to SQL 🗣️ → 📝
    • Convert text queries into SQL commands using Azure OpenAI models
    • Intelligent query interpretation with detailed decision logs
    • Step-by-step reasoning for query generation
  • Multi-Database Support 🗄️
    • SQLite compatibility with file upload
    • PostgreSQL integration with secure connection
    • Dynamic schema exploration
  • Interactive Data Explorer 🔍
    • Real-time data filtering and exploration
    • Comprehensive query results with summary statistics
    • Advanced table views with sorting and filtering
📊 Visualization & Analytics
  • Dynamic Visualizations 📈
    • Multiple chart types (Bar, Line, Scatter, Area, Histogram)
    • Interactive chart configuration
    • AI-powered visualization recommendations
  • Summary Statistics 📋
    • Detailed numeric analysis
    • Categorical data insights
    • Distribution analysis
    • Statistical measures (mean, median, mode, skewness, kurtosis)
🛡️ Security & Management
  • Safe SQL Execution 🔒
    • Strict query validation
    • SQL injection prevention
    • Comprehensive error handling and feedback
  • Query History 📚
    • Searchable query log
    • Query reusability
    • Multiple export formats (CSV, Excel, JSON)

🚀 Getting Started

graph LR
    A[User Input] --> B[Azure OpenAI]
    B --> C[SQL Generator]
    C --> D[Database]
    D --> E[Results]
    E --> F[Visualization]
Loading

Installation

1️⃣ Clone the Repository

git clone https://github.com/lohitkolluri/NLP2SQLL.git
cd NLP2SQL

2️⃣ Set Up Environment

# Create .env file
cat << EOF > .env
OPENAI_ENDPOINT="https://[ENDPOINT_NAME].openai.azure.com"
OPENAI_API_VERSION="2024-08-01-preview"
OPENAI_API_KEY="YOUR AZURE OPENAI API KEY"
MODEL_NAME="YOUR AZURE OPENAI MODEL NAME"
EOF

3️⃣ Install Dependencies

pip install -r requirements.txt

4️⃣ Launch the App

streamlit run app/NLP2SQL.py

🎨 Built With

Technology Purpose
Streamlit Web Interface
Azure OpenAI NLP Processing
PostgreSQL PostgreSQL DB
SQLite SQLite DB
Altair Visualizations

🌟 Key Features

mindmap
  root((NLP2SQL))
    Query Processing
      Natural Language Input
      Decision Logging
      Detailed Reasoning
    Visualization
      Interactive Charts
      Summary Statistics
      Data Distribution
    Database
      PostgreSQL
      SQLite
      Schema Analysis
    Security
      Query Validation
      Error Handling
      Safe Execution
Loading

💡 How It Works

  1. Query Input ➡️ User enters natural language query
  2. Processing ➡️ Azure OpenAI analyzes and generates SQL with reasoning
  3. Validation ➡️ Query is validated for safety and correctness
  4. Execution ➡️ Query runs against selected database
  5. Analysis ➡️ Results are processed with summary statistics
  6. Visualization ➡️ Data is presented with AI-recommended charts
  7. Export ➡️ Results can be downloaded in multiple formats

📊 Supported Visualizations

  • Bar Chart: Comparing categorical data
  • Line Chart: Time-series and trend analysis
  • Scatter Plot: Relationship between variables
  • Area Chart: Cumulative totals and trends
  • Histogram: Distribution analysis

🔒 Security Features

  • Strict SQL query validation
  • Prevention of harmful SQL operations
  • Secure database connections
  • Protected sensitive information
  • Input sanitization

📈 Data Analysis

  • Comprehensive summary statistics
  • Distribution analysis
  • Correlation detection
  • Trend identification
  • Outlier detection

License © Lohit Kolluri