Spaces:
Sleeping
Sleeping
Melika Kheirieh
commited on
Commit
·
6430910
1
Parent(s):
df092a2
docs: add README to explain about databases
Browse files
README.md
CHANGED
|
@@ -29,8 +29,53 @@ nl2sql-copilot-prototype/
|
|
| 29 |
├─ .env.example
|
| 30 |
├─ .gitignore
|
| 31 |
└─ README.md
|
|
|
|
|
|
|
|
|
|
| 32 |
```
|
|
|
|
| 33 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
---
|
| 35 |
|
| 36 |
## ⚙️ Requirements
|
|
|
|
| 29 |
├─ .env.example
|
| 30 |
├─ .gitignore
|
| 31 |
└─ README.md
|
| 32 |
+
└─ db/
|
| 33 |
+
├─ Chinook_Sqlite.sqlite
|
| 34 |
+
└─ WMSales.sqlite
|
| 35 |
```
|
| 36 |
+
## 🧩 Database Samples
|
| 37 |
|
| 38 |
+
Two example SQLite databases are included in the `db/` folder for quick testing:
|
| 39 |
+
|
| 40 |
+
| File | Description | Download |
|
| 41 |
+
|------|--------------|-----------|
|
| 42 |
+
| **Chinook_Sqlite.sqlite** | Classic sample DB with artists, albums, and tracks (music store example). | [⬇️ Download](https://github.com/melika-kheirieh/nl2sql-copilot-prototype/raw/main/db/Chinook_Sqlite.sqlite) |
|
| 43 |
+
| **WMSales.sqlite** | Simple sales database (for demoing aggregate and filter queries). | [⬇️ Download](https://github.com/melika-kheirieh/nl2sql-copilot-prototype/raw/main/db/WMSales.sqlite) |
|
| 44 |
+
|
| 45 |
+
You can use them directly in the Gradio UI by uploading one of these files, or reference them in code for local runs.
|
| 46 |
+
|
| 47 |
+
---
|
| 48 |
+
|
| 49 |
+
### 🧠 Sample Questions for *Chinook_Sqlite.sqlite*
|
| 50 |
+
Try asking your copilot questions like:
|
| 51 |
+
|
| 52 |
+
1. “List the top 5 artists by total track count.”
|
| 53 |
+
2. “Which album has the most tracks?”
|
| 54 |
+
3. “Show all tracks longer than 6 minutes.”
|
| 55 |
+
4. “Find the average track length by genre.”
|
| 56 |
+
5. “Show total invoice amount by billing country.”
|
| 57 |
+
6. “Top 10 most popular genres by number of tracks.”
|
| 58 |
+
7. “How many customers have purchased Jazz albums?”
|
| 59 |
+
8. “Show the total revenue by employee (sales support).”
|
| 60 |
+
9. “List customers who spent more than $100.”
|
| 61 |
+
10. “Which customers are from Canada?”
|
| 62 |
+
|
| 63 |
+
|
| 64 |
+
---
|
| 65 |
+
|
| 66 |
+
### 📊 Sample Questions for *WMSales.sqlite*
|
| 67 |
+
You can try:
|
| 68 |
+
|
| 69 |
+
1. “Show total sales per month in 2024.”
|
| 70 |
+
2. “List the top 10 customers by revenue.”
|
| 71 |
+
3. “Which product category had the highest sales this year?”
|
| 72 |
+
4. “Find the average unit price per product.”
|
| 73 |
+
5. “Show all orders placed in the last 30 days.”
|
| 74 |
+
6. “List total sales by region and salesperson.”
|
| 75 |
+
7. “What is the best-selling product overall?”
|
| 76 |
+
8. “Show total discount given per month.”
|
| 77 |
+
9. “Find customers who made more than 5 purchases.”
|
| 78 |
+
10. “What’s the total revenue by payment method?”
|
| 79 |
---
|
| 80 |
|
| 81 |
## ⚙️ Requirements
|