Skip to content

Commit 2c4a24a

Browse files
Merge branch 'main' of github.com:DSoftwareArtist/LLM-Natural-Language-SQL-Analytics
2 parents 517871e + eabbb24 commit 2c4a24a

1 file changed

Lines changed: 2 additions & 70 deletions

File tree

README.md

Lines changed: 2 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# LLM Natural Language SQL Analytics - Specification
1+
# LLM Natural Language SQL Analytics
22

33
## Overview
44

55

6-
A system that allows users to query structured databases using natural language. The system converts natural language questions into SQL queries, executes them against connected databases, and returns results. Includes semantic search over database schema documentation using pgvector.
6+
A system that allows users to query structured databases using natural language. The system converts natural language questions into SQL queries, executes, and returns results. Includes semantic search over database schema documentation using pgvector.
77

88
<img width="987" height="749" alt="Screenshot 2026-03-19 at 5 46 10 PM" src="https://github.com/user-attachments/assets/369bb41a-2665-452b-ad1d-712f39da7cb7" />
99

@@ -16,71 +16,3 @@ A system that allows users to query structured databases using natural language.
1616
- **Embeddings:** sentence-transformers >=2.2.2
1717
- **Environment:** python-dotenv >=1.0.0
1818
- **PDF Parsing:** PyPDF2 >=3.0.0
19-
20-
21-
## Setup Instructions
22-
23-
### 1. Prerequisites
24-
25-
- Python 3.9+
26-
- PostgreSQL 15+ with pgvector extension
27-
- Groq API key (free)
28-
29-
### 2. Install Dependencies
30-
31-
```bash
32-
pip install -r requirements.txt
33-
```
34-
35-
### 3. Database Setup
36-
37-
**Option A: Using Docker**
38-
```bash
39-
docker run -d --name postgres-pgvector \
40-
-e POSTGRES_PASSWORD=postgres \
41-
-e POSTGRES_DB=llm_analytics \
42-
-p 5432:5432 \
43-
pgvector/pgvector:pg16
44-
```
45-
46-
**Option B: Local PostgreSQL**
47-
1. Install PostgreSQL
48-
2. Create database: `CREATE DATABASE llm_analytics;`
49-
3. Enable pgvector: `CREATE EXTENSION vector;`
50-
51-
### 4. Configure Environment
52-
53-
Edit `.env` file:
54-
```env
55-
DB_NAME=llm_analytics
56-
DB_USER=postgres
57-
DB_PASSWORD=postgres
58-
DB_HOST=localhost
59-
DB_PORT=5432
60-
GROQ_API_KEY=your_groq_api_key_here
61-
SECRET_KEY=your_django_secret_key
62-
```
63-
64-
**Get Groq API Key (free):**
65-
1. Go to https://console.groq.com/keys
66-
2. Create a new API key
67-
3. Copy it to your `.env` file
68-
69-
### 5. Run Migrations
70-
71-
```bash
72-
python manage.py migrate
73-
```
74-
75-
### 6. Run Development Server
76-
77-
```bash
78-
python manage.py runserver
79-
```
80-
81-
### 7. Access the Application
82-
83-
- Web UI: http://localhost:8000
84-
- Admin: http://localhost:8000/admin
85-
86-

0 commit comments

Comments
 (0)