fortunius commited on
Commit
af6aff9
·
verified ·
1 Parent(s): 2f7096f

[DOCS] v1.5 and v2.0 roadmaps, restore known limitations

Browse files
Files changed (1) hide show
  1. README.md +21 -24
README.md CHANGED
@@ -1,14 +1,3 @@
1
- ---
2
- title: rag-uigreenmetric
3
- emoji: 📚
4
- colorFrom: green
5
- colorTo: blue
6
- sdk: gradio
7
- sdk_version: "6.14.0"
8
- app_file: app.py
9
- pinned: false
10
- ---
11
-
12
  # 📚 RAG — Multi Source Information Retrieval
13
 
14
  > A hybrid Retrieval-Augmented Generation (RAG) project built to learn and implement context injection using the DeepSeek API.
@@ -151,20 +140,28 @@ Sparse added 2.2s latency with no CP gain and degraded G-Eval. Not worth the cos
151
 
152
  ---
153
 
154
- ## 🔮 Future Features
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
155
 
156
- | # | Feature | Description |
157
- |---|---|---|
158
- | 1 | Show retrieved context | Collapsible view of the chunks that fed each answer — full transparency into what the system based its response on |
159
- | 2 | Source citation | Display which data source answered the query (PDF guidelines, Appendix 1, etc.) |
160
- | 3 | Token cost per query | Show exact token usage and estimated cost under each answer |
161
- | 4 | Pipeline timing | Display response generation time to set latency expectations |
162
- | 5 | Route badge color-coding | Green/blue/purple/gray badges for pdf/csv/both/none sources |
163
- | 6 | Welcome + example chips | Clickable sample questions on empty chat for better first impression |
164
- | 7 | Feedback thumbs | ±1 per answer, logged for future evaluation |
165
- | 8 | Markdown rendering | Properly formatted lists, tables, and bold text in answers |
166
- | 9 | Copy answer button | One-click clipboard copy on each response |
167
- | 10 | Dark mode toggle | OS preference detection + manual toggle |
168
  ---
169
 
170
  ## ⚠️ Known Limitations
 
 
 
 
 
 
 
 
 
 
 
 
1
  # 📚 RAG — Multi Source Information Retrieval
2
 
3
  > A hybrid Retrieval-Augmented Generation (RAG) project built to learn and implement context injection using the DeepSeek API.
 
140
 
141
  ---
142
 
143
+ ## 🗺️ v1.5 Roadmap
144
+
145
+ - [ ] Show retrieved context (collapsible view of chunks used per answer)
146
+ - [ ] Source citation (display which data source answered the query)
147
+ - [ ] Token cost per query (exact usage and estimated cost under each answer)
148
+ - [ ] Pipeline timing (response generation time displayed)
149
+ - [ ] Route badge color-coding (green/blue/purple/gray for pdf/csv/both/none)
150
+ - [ ] Markdown rendering (properly formatted lists, tables, bold text)
151
+ - [ ] Copy answer button (clipboard copy on each response)
152
+ - [ ] Welcome + example chips (clickable sample questions on empty chat)
153
+ - [ ] Feedback thumbs (±1 per answer, logged for future evaluation)
154
+ - [ ] Dark mode toggle (OS preference detection + manual toggle)
155
+
156
+ ## 🚀 v2.0 Roadmap
157
+
158
+ - [ ] FastAPI backend (`POST /ask`, `GET /budget`, `GET /health`)
159
+ - [ ] Streaming generator (DeepSeek `stream=True` → `StreamingResponse`)
160
+ - [ ] Conversation history (generator-only, router stays single-query)
161
+ - [ ] Dockerize backend (`Dockerfile` + `docker-compose.yml`)
162
+ - [ ] Svelte chat UI with Vercel AI SDK (replaces Gradio)
163
+ - [ ] Strip Gradio (`app.py`, `gradio` from requirements)
164
 
 
 
 
 
 
 
 
 
 
 
 
 
165
  ---
166
 
167
  ## ⚠️ Known Limitations