lvvignesh2122 commited on
Commit
987cf50
Β·
unverified Β·
1 Parent(s): a7badf3

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +32 -1
README.md CHANGED
@@ -2,7 +2,7 @@
2
 
3
  Production-grade Retrieval-Augmented Generation (RAG) backend built with FastAPI, FAISS (ANN), and Google Gemini β€” featuring hybrid retrieval, HNSW indexing, cross-encoder reranking, evaluation logging, and analytics.
4
 
5
- This repository demonstrates how modern AI backend systems are actually built in industry, not toy demos.
6
 
7
  πŸš€ What This Project Is
8
 
@@ -96,30 +96,44 @@ Persistent vector store
96
 
97
  πŸ—οΈ System Architecture
98
 
 
99
  Frontend (HTML / JS)
 
100
  ↓
 
101
  FastAPI Backend
102
  ↓
 
103
  Document Ingestion (PDF / TXT)
104
  ↓
 
105
  Sentence Chunking + Metadata
106
  ↓
 
107
  Embeddings (SentenceTransformers)
108
  ↓
 
109
  FAISS ANN Index (HNSW)
110
  ↓
 
111
  Hybrid Retrieval (Vector + Keyword)
112
  ↓
 
113
  Cross-Encoder Reranking
114
  ↓
 
115
  Prompt Assembly
116
  ↓
 
117
  Google Gemini LLM
118
  ↓
 
119
  Answer + Confidence + Citations
120
  ↓
 
121
  Evaluation Logging + Analytics
122
 
 
123
  🧠 Core Concepts Demonstrated
124
  Retrieval-Augmented Generation (RAG)
125
 
@@ -168,6 +182,7 @@ Clean Git hygiene
168
  Incremental system evolution
169
 
170
  πŸ› οΈ Tech Stack
 
171
  Backend
172
 
173
  Python
@@ -209,14 +224,30 @@ Virtual Environments (venv)
209
  βš™οΈ Setup & Run Locally
210
 
211
  1️⃣ Clone Repository
 
212
  git clone https://github.com/LVVignesh/gemini-rag-fastapi.git
 
213
  cd gemini-rag-fastapi
 
 
 
214
  python -m venv venv
 
215
  venv\Scripts\activate
 
 
 
216
  pip install -r requirements.txt
 
 
 
217
  GEMINI_API_KEY=your_api_key_here
 
 
 
218
  uvicorn main:app --reload
219
 
 
220
  ⚠️ Known Limitations
221
 
222
  Scanned/image-only PDFs require OCR (not included)
 
2
 
3
  Production-grade Retrieval-Augmented Generation (RAG) backend built with FastAPI, FAISS (ANN), and Google Gemini β€” featuring hybrid retrieval, HNSW indexing, cross-encoder reranking, evaluation logging, and analytics.
4
 
5
+ This repository demonstrates how modern AI backend systems are actually built in industry.
6
 
7
  πŸš€ What This Project Is
8
 
 
96
 
97
  πŸ—οΈ System Architecture
98
 
99
+
100
  Frontend (HTML / JS)
101
+
102
  ↓
103
+
104
  FastAPI Backend
105
  ↓
106
+
107
  Document Ingestion (PDF / TXT)
108
  ↓
109
+
110
  Sentence Chunking + Metadata
111
  ↓
112
+
113
  Embeddings (SentenceTransformers)
114
  ↓
115
+
116
  FAISS ANN Index (HNSW)
117
  ↓
118
+
119
  Hybrid Retrieval (Vector + Keyword)
120
  ↓
121
+
122
  Cross-Encoder Reranking
123
  ↓
124
+
125
  Prompt Assembly
126
  ↓
127
+
128
  Google Gemini LLM
129
  ↓
130
+
131
  Answer + Confidence + Citations
132
  ↓
133
+
134
  Evaluation Logging + Analytics
135
 
136
+
137
  🧠 Core Concepts Demonstrated
138
  Retrieval-Augmented Generation (RAG)
139
 
 
182
  Incremental system evolution
183
 
184
  πŸ› οΈ Tech Stack
185
+
186
  Backend
187
 
188
  Python
 
224
  βš™οΈ Setup & Run Locally
225
 
226
  1️⃣ Clone Repository
227
+
228
  git clone https://github.com/LVVignesh/gemini-rag-fastapi.git
229
+
230
  cd gemini-rag-fastapi
231
+
232
+ 2️⃣ Create Virtual Environment
233
+
234
  python -m venv venv
235
+
236
  venv\Scripts\activate
237
+
238
+ 3️⃣ Install Dependencies
239
+
240
  pip install -r requirements.txt
241
+
242
+ 4️⃣ Configure Environment Variables
243
+
244
  GEMINI_API_KEY=your_api_key_here
245
+
246
+ 5️⃣ Run Server
247
+
248
  uvicorn main:app --reload
249
 
250
+
251
  ⚠️ Known Limitations
252
 
253
  Scanned/image-only PDFs require OCR (not included)