Spaces:
Build error
Build error
File size: 5,018 Bytes
b6fa51d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 | # π Deep Dive: FastAPI Application Architecture
## π§ Why FastAPI for RAG?
```
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β FASTAPI BENEFITS β
β β
β β
Async support β Efficient I/O for LLM calls β
β β
Automatic docs β Swagger UI at /docs β
β β
Pydantic β Type validation and serialization β
β β
Streaming β SSE for real-time responses β
β β
Production-ready β Used by Netflix, Uber, Microsoft β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
```
---
## π Architecture Overview
```
src/api/
βββ main.py # Application entry point
βββ models.py # Pydantic request/response models
βββ __init__.py
βββ routes/
βββ __init__.py
βββ health.py # Health check endpoints
βββ query.py # Query/RAG endpoints
βββ ingest.py # Document ingestion endpoints
```
---
## π― main.py - Application Entry Point
### FastAPI App Configuration
```python
app = FastAPI(
title="DocuMind AI",
description="RAG-Powered Documentation Assistant API",
version="1.0.0",
docs_url="/docs", # Swagger UI
redoc_url="/redoc", # ReDoc alternative
lifespan=lifespan, # Startup/shutdown events
)
```
### Lifespan Context Manager
```python
@asynccontextmanager
async def lifespan(app: FastAPI):
# Startup
logger.info("Starting DocuMind AI API...")
yield
# Shutdown
logger.info("Shutting down...")
```
### CORS Configuration
```python
app.add_middleware(
CORSMiddleware,
allow_origins=settings.cors_origins, # ["localhost:3000", "localhost:8501"]
allow_credentials=True,
allow_methods=["*"],
allow_headers=["*"],
)
```
---
## π models.py - Pydantic Schemas
### QueryRequest
```python
class QueryRequest(BaseModel):
question: str = Field(..., min_length=1, max_length=2000)
collection_name: str = Field(default="documents")
top_k: int = Field(default=5, ge=1, le=20)
include_sources: bool = Field(default=True)
```
### QueryResponse
```python
class QueryResponse(BaseModel):
answer: str
question: str
sources: Optional[List[SourceDocument]]
num_sources: Optional[int]
```
### IngestResponse
```python
class IngestResponse(BaseModel):
success: bool
message: str
documents_processed: int
chunks_created: int
collection_name: str
```
---
## π£οΈ Routes
### Health Routes (`/health`)
| Endpoint | Method | Purpose |
|----------|--------|---------|
| `/health` | GET | Basic health check |
| `/health/detailed` | GET | Component-level health |
| `/ready` | GET | Kubernetes readiness |
| `/live` | GET | Kubernetes liveness |
### Query Routes (`/api/query`)
| Endpoint | Method | Purpose |
|----------|--------|---------|
| `/api/query` | POST | Standard RAG query |
| `/api/query/stream` | POST | Streaming response |
### Ingest Routes (`/api/ingest`)
| Endpoint | Method | Purpose |
|----------|--------|---------|
| `/api/ingest` | POST | Upload files |
| `/api/ingest/text` | POST | Ingest raw text |
| `/api/ingest/{collection}` | DELETE | Delete collection |
---
## π Query Flow
```
POST /api/query
{
"question": "What is the refund policy?",
"collection_name": "documents",
"top_k": 5,
"include_sources": true
}
β
get_pipeline(collection_name, top_k)
β
pipeline.query(question, include_sources)
β
{
"answer": "Based on the documentation...",
"question": "What is the refund policy?",
"sources": [...],
"num_sources": 3
}
```
---
## π€ Ingest Flow
```
POST /api/ingest
[files: policy.pdf, guide.md]
β
Validate file extensions (.pdf, .md, .txt)
β
Save to temp files
β
MultiFormatDocumentLoader.load_file()
β
DocumentChunker.chunk_documents()
β
VectorStore.add_documents()
β
{
"success": true,
"documents_processed": 2,
"chunks_created": 15
}
```
---
## π Running the API
```bash
# Development
python -m src.api.main
# Or with uvicorn directly
uvicorn src.api.main:app --reload --host 0.0.0.0 --port 8000
```
### Access Points:
- **API**: http://localhost:8000
- **Swagger Docs**: http://localhost:8000/docs
- **ReDoc**: http://localhost:8000/redoc
---
## π Summary
| File | Purpose |
|------|---------|
| `main.py` | App config, CORS, routers |
| `models.py` | Pydantic schemas |
| `routes/health.py` | Health checks |
| `routes/query.py` | RAG query endpoints |
| `routes/ingest.py` | File upload endpoints |
|