bhoomika19 commited on
Commit
a62f47b
ยท
1 Parent(s): 0388791

updated readme

Browse files
Files changed (1) hide show
  1. README.md +2 -75
README.md CHANGED
@@ -77,11 +77,8 @@ Add the following variables to your `.env` file:
77
  GEMINI_API_KEY=your_gemini_api_key_here
78
  QDRANT_URL=your_qdrant_cluster_url
79
  QDRANT_API_KEY=your_qdrant_api_key
 
80
 
81
- # Optional configurations
82
- BACKEND_PORT=8000
83
- FRONTEND_PORT=3000
84
- LOG_LEVEL=INFO
85
  ```
86
 
87
  ### Backend Setup
@@ -179,16 +176,6 @@ The backend provides RESTful APIs accessible at `http://localhost:8000/docs` (Sw
179
  - `POST /api/feedback` - Submit user feedback on solutions
180
  - `GET /api/health` - Health check endpoint
181
 
182
- ### Example API Usage
183
-
184
- ```bash
185
- curl -X POST "http://localhost:8000/api/search" \
186
- -H "Content-Type: application/json" \
187
- -d '{"question": "Find the derivative of f(x) = 3x^2 + 2x - 1"}'
188
- ```
189
-
190
- ## ๐Ÿ”ง Configuration
191
-
192
  ### System Configuration
193
 
194
  The system uses a three-tier approach for solving math problems:
@@ -229,37 +216,6 @@ Math-Agentic-RAG/
229
  โ””โ”€โ”€ README.md # This file
230
  ```
231
 
232
- ### Running Tests
233
-
234
- ```bash
235
- # Backend tests
236
- cd backend
237
- python -m pytest
238
-
239
- # Frontend tests
240
- cd frontend
241
- npm test
242
- ```
243
-
244
- ### Contributing
245
-
246
- 1. Fork the repository
247
- 2. Create a feature branch: `git checkout -b feature-name`
248
- 3. Make your changes with proper tests
249
- 4. Commit your changes: `git commit -am 'Add feature'`
250
- 5. Push to the branch: `git push origin feature-name`
251
- 6. Submit a pull request
252
-
253
- ## ๐Ÿ“Š Performance & Analytics
254
-
255
- The system includes comprehensive analytics:
256
-
257
- - **Response time tracking**
258
- - **Confidence score monitoring**
259
- - **Source usage statistics**
260
- - **User feedback collection**
261
- - **Quality assessment metrics**
262
-
263
  ## ๐Ÿ”’ Security & Guardrails
264
 
265
  - **Input validation** prevents malicious content
@@ -267,35 +223,6 @@ The system includes comprehensive analytics:
267
  - **Rate limiting** prevents abuse
268
  - **API key protection** secures external services
269
 
270
- ## ๐Ÿ› Troubleshooting
271
-
272
- ### Common Issues
273
-
274
- **Backend won't start:**
275
- - Check that all environment variables are set
276
- - Verify Python version (3.11+)
277
- - Ensure virtual environment is activated
278
-
279
- **Frontend math not rendering:**
280
- - Check browser console for KaTeX errors
281
- - Verify mathematical expressions are properly formatted
282
- - Clear browser cache
283
-
284
- **No search results:**
285
- - Verify Qdrant connection in backend logs
286
- - Check if database has been ingested with sample data
287
- - Confirm API keys are valid
288
-
289
- ### Getting Help
290
-
291
- - Check the [Issues](https://github.com/bhoomika-254/Math-Agentic-RAG/issues) page
292
- - Review the API documentation at `/docs`
293
- - Check backend logs for detailed error information
294
-
295
- ## ๐Ÿ“„ License
296
-
297
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
298
-
299
  ## ๐Ÿค Acknowledgments
300
 
301
  - **Qdrant** for vector database capabilities
@@ -306,4 +233,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
306
 
307
  ---
308
 
309
- **Built with โค๏ธ for the mathematics education community**
 
77
  GEMINI_API_KEY=your_gemini_api_key_here
78
  QDRANT_URL=your_qdrant_cluster_url
79
  QDRANT_API_KEY=your_qdrant_api_key
80
+ QDRANT_COLLECTION=collection_name
81
 
 
 
 
 
82
  ```
83
 
84
  ### Backend Setup
 
176
  - `POST /api/feedback` - Submit user feedback on solutions
177
  - `GET /api/health` - Health check endpoint
178
 
 
 
 
 
 
 
 
 
 
 
179
  ### System Configuration
180
 
181
  The system uses a three-tier approach for solving math problems:
 
216
  โ””โ”€โ”€ README.md # This file
217
  ```
218
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
219
  ## ๐Ÿ”’ Security & Guardrails
220
 
221
  - **Input validation** prevents malicious content
 
223
  - **Rate limiting** prevents abuse
224
  - **API key protection** secures external services
225
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
226
  ## ๐Ÿค Acknowledgments
227
 
228
  - **Qdrant** for vector database capabilities
 
233
 
234
  ---
235
 
236
+ **Built with โค๏ธ by bhoomi**