Spaces:
Running
Running
Commit ·
b193600
1
Parent(s): 99e045a
fix(hf): add HuggingFace Space README config with docker sdk
Browse files
README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: ResearchPilot API
|
| 3 |
+
emoji: 🔬
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: purple
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_port: 7860
|
| 8 |
+
pinned: false
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
# ResearchPilot API
|
| 12 |
+
|
| 13 |
+
Production RAG system for ML research paper Q&A, powered by:
|
| 14 |
+
- **Retrieval**: Hybrid (Qdrant dense + BM25 sparse) with cross-encoder reranking
|
| 15 |
+
- **Generation**: Groq LLaMA-3.3-70B with streaming support
|
| 16 |
+
- **Embedding**: BAAI/bge-base-en-v1.5
|
| 17 |
+
|
| 18 |
+
## Endpoints
|
| 19 |
+
|
| 20 |
+
| Method | Path | Description |
|
| 21 |
+
|--------|------|-------------|
|
| 22 |
+
| GET | `/health` | Health check + system status |
|
| 23 |
+
| POST | `/query` | Standard (non-streaming) RAG query |
|
| 24 |
+
| POST | `/query/stream` | Streaming SSE RAG query |
|
| 25 |
+
| POST | `/feedback` | Submit user feedback |
|
| 26 |
+
| GET | `/docs` | Swagger UI |
|
| 27 |
+
|
| 28 |
+
## Environment Variables Required
|
| 29 |
+
|
| 30 |
+
Set these in your Space **Settings → Repository Secrets**:
|
| 31 |
+
|
| 32 |
+
- `GROQ_API_KEY` — Groq API key for LLM generation
|
| 33 |
+
- `HF_API_KEY` — HuggingFace API key (for future model fallback)
|