Update README.md
Browse files
README.md
CHANGED
|
@@ -21,6 +21,7 @@ Supports production constraints (file limits, caching, logging)
|
|
| 21 |
The project evolved from RAG v1 → RAG v2, adding real-world scalability and observability.
|
| 22 |
|
| 23 |
✨ Key Features (RAG v2)
|
|
|
|
| 24 |
📥 Document Ingestion
|
| 25 |
|
| 26 |
Upload PDF and TXT files
|
|
@@ -98,7 +99,6 @@ Persistent vector store
|
|
| 98 |
|
| 99 |
|
| 100 |
Frontend (HTML / JS)
|
| 101 |
-
|
| 102 |
↓
|
| 103 |
|
| 104 |
FastAPI Backend
|
|
@@ -134,7 +134,9 @@ Answer + Confidence + Citations
|
|
| 134 |
Evaluation Logging + Analytics
|
| 135 |
|
| 136 |
|
|
|
|
| 137 |
🧠 Core Concepts Demonstrated
|
|
|
|
| 138 |
Retrieval-Augmented Generation (RAG)
|
| 139 |
|
| 140 |
Why pure LLMs hallucinate
|
|
@@ -181,6 +183,7 @@ Clean Git hygiene
|
|
| 181 |
|
| 182 |
Incremental system evolution
|
| 183 |
|
|
|
|
| 184 |
🛠️ Tech Stack
|
| 185 |
|
| 186 |
Backend
|
|
@@ -221,6 +224,8 @@ Hugging Face Spaces (deployment)
|
|
| 221 |
|
| 222 |
Virtual Environments (venv)
|
| 223 |
|
|
|
|
|
|
|
| 224 |
⚙️ Setup & Run Locally
|
| 225 |
|
| 226 |
1️⃣ Clone Repository
|
|
@@ -248,6 +253,7 @@ GEMINI_API_KEY=your_api_key_here
|
|
| 248 |
uvicorn main:app --reload
|
| 249 |
|
| 250 |
|
|
|
|
| 251 |
⚠️ Known Limitations
|
| 252 |
|
| 253 |
Scanned/image-only PDFs require OCR (not included)
|
|
@@ -262,6 +268,8 @@ sharding
|
|
| 262 |
|
| 263 |
background workers
|
| 264 |
|
|
|
|
|
|
|
| 265 |
🚀 Live Demo
|
| 266 |
|
| 267 |
👉 Hugging Face Spaces
|
|
|
|
| 21 |
The project evolved from RAG v1 → RAG v2, adding real-world scalability and observability.
|
| 22 |
|
| 23 |
✨ Key Features (RAG v2)
|
| 24 |
+
|
| 25 |
📥 Document Ingestion
|
| 26 |
|
| 27 |
Upload PDF and TXT files
|
|
|
|
| 99 |
|
| 100 |
|
| 101 |
Frontend (HTML / JS)
|
|
|
|
| 102 |
↓
|
| 103 |
|
| 104 |
FastAPI Backend
|
|
|
|
| 134 |
Evaluation Logging + Analytics
|
| 135 |
|
| 136 |
|
| 137 |
+
|
| 138 |
🧠 Core Concepts Demonstrated
|
| 139 |
+
|
| 140 |
Retrieval-Augmented Generation (RAG)
|
| 141 |
|
| 142 |
Why pure LLMs hallucinate
|
|
|
|
| 183 |
|
| 184 |
Incremental system evolution
|
| 185 |
|
| 186 |
+
|
| 187 |
🛠️ Tech Stack
|
| 188 |
|
| 189 |
Backend
|
|
|
|
| 224 |
|
| 225 |
Virtual Environments (venv)
|
| 226 |
|
| 227 |
+
|
| 228 |
+
|
| 229 |
⚙️ Setup & Run Locally
|
| 230 |
|
| 231 |
1️⃣ Clone Repository
|
|
|
|
| 253 |
uvicorn main:app --reload
|
| 254 |
|
| 255 |
|
| 256 |
+
|
| 257 |
⚠️ Known Limitations
|
| 258 |
|
| 259 |
Scanned/image-only PDFs require OCR (not included)
|
|
|
|
| 268 |
|
| 269 |
background workers
|
| 270 |
|
| 271 |
+
|
| 272 |
+
|
| 273 |
🚀 Live Demo
|
| 274 |
|
| 275 |
👉 Hugging Face Spaces
|