HamidOmarov commited on
Commit
de26ec1
·
1 Parent(s): 26ad320

Docs: README + MIT license + repo .gitignore

Browse files
Files changed (3) hide show
  1. .gitignore +9 -8
  2. LICENSE +6 -0
  3. README.md +20 -10
.gitignore CHANGED
@@ -1,12 +1,13 @@
1
- venv/
2
- .venv/
3
  __pycache__/
4
  *.pyc
5
  *.pyo
6
- *.pyd
7
  *.log
8
- .env
9
- data/uploads/
10
- data/index/
11
- .git
12
- .gitignore
 
 
 
 
1
+ venv/
 
2
  __pycache__/
3
  *.pyc
4
  *.pyo
 
5
  *.log
6
+ *.DS_Store
7
+ /app/.cache/
8
+ /app/data/uploads/
9
+ /app/data/index/
10
+ *.npy
11
+ *.faiss
12
+ faiss.index
13
+ *.pdf
LICENSE ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Hamid Omarov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ ... (MIT m?tni tam) ...
README.md CHANGED
@@ -1,10 +1,20 @@
1
- ---
2
- title: FastAPI RAG API
3
- emoji: 📄
4
- colorFrom: gray
5
- colorTo: blue
6
- sdk: docker
7
- app_file: app.py
8
- app_port: 7860
9
- pinned: false
10
- ---
 
 
 
 
 
 
 
 
 
 
 
1
+ # FastAPI RAG API
2
+
3
+ **Live demo**
4
+ - API (HF Space): https://huggingface.co/spaces/HamidOmarov/FastAPI-RAG-API
5
+ - Dashboard (HF Space): https://huggingface.co/spaces/HamidOmarov/RAG-Dashboard
6
+
7
+ ## What it does
8
+ Ask questions about your PDFs using vector search (FAISS) + sentence embeddings.
9
+ Robust to numeric/table-heavy docs, with AZ>EN translation and fallbacks.
10
+
11
+ ## Quick test
12
+ curl -F "[email protected]" https://<api>/upload_pdf
13
+ curl -H "Content-Type: application/json" ^
14
+ -d "{\"question\":\"What is the document about?\",\"top_k\":5}" https://<api>/ask_question
15
+
16
+ ## Ops
17
+ - GET /health - GET /stats - POST /reset_index
18
+
19
+ ## Stack
20
+ FastAPI � FAISS � sentence-transformers � pdfminer.six � Hugging Face Spaces