Configure Git LFS for FAISS index + HF Spaces Docker deployment

.gitattributes

@@ -0,0 +1,31 @@
+# Git LFS tracking for large binary files
+# Hugging Face Spaces supports Git LFS natively
+
+# FAISS vector index (grows as more documents are indexed)
+faiss_store/faiss.index filter=lfs diff=lfs merge=lfs -text
+faiss_store/*.index filter=lfs diff=lfs merge=lfs -text
+
+# Pickle files (metadata store, grows with index)
+faiss_store/metadata.pkl filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+
+# Common large binary formats (future-proofing)
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.hdf5 filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+
+# Large data files
+*.pdf filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.tar.gz filter=lfs diff=lfs merge=lfs -text
+*.sqlite filter=lfs diff=lfs merge=lfs -text
+*.db filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -20,8 +20,8 @@ src/__pycache__/
 __pycache__/
 *.pyc
 
-# Vector DB
-faiss_store/
+# Vector DB (keep faiss_store/ for deployment — DO NOT ignore)
+# faiss_store/
 vector_store/
 
 # LangGraph

Dockerfile

@@ -1,64 +1,47 @@
-# Modern Multi-stage Dockerfile for RAG System
-FROM python:3.11-slim as builder
+# Hugging Face Spaces - Docker SDK
+# Docs: https://huggingface.co/docs/hub/spaces-sdks-docker
+
+# ── Build stage ──────────────────────────────────────────────
+FROM python:3.11-slim AS builder
 
-# Set environment variables
 ENV PYTHONDONTWRITEBYTECODE=1 \
-    PYTHONUNBUFFERED=1 \
-    POETRY_NO_INTERACTION=1 \
-    POETRY_VENV_IN_PROJECT=1 \
-    POETRY_CACHE_DIR=/tmp/poetry_cache
+    PYTHONUNBUFFERED=1
 
-# Install system dependencies
 RUN apt-get update && apt-get install -y --no-install-recommends \
     build-essential \
-    curl \
     && rm -rf /var/lib/apt/lists/*
 
-# Install Python dependencies
 WORKDIR /app
 COPY requirements.txt .
 RUN pip install --no-cache-dir --upgrade pip && \
     pip install --no-cache-dir -r requirements.txt
 
-# Production stage  
-FROM python:3.11-slim as production
+# ── Production stage ─────────────────────────────────────────
+FROM python:3.11-slim AS production
 
-# Set environment variables
 ENV PYTHONDONTWRITEBYTECODE=1 \
-    PYTHONUNBUFFERED=1 \
-    PYTHONPATH="/app/src:$PYTHONPATH"
+    PYTHONUNBUFFERED=1
 
-# Install runtime dependencies only
-RUN apt-get update && apt-get install -y --no-install-recommends \
-    curl \
-    && rm -rf /var/lib/apt/lists/*
+# HF Spaces requires a user with UID 1000
+RUN useradd -m -u 1000 user
+ENV PATH="/home/user/.local/bin:$PATH"
 
-# Create non-root user
-RUN groupadd -r appuser && useradd -r -g appuser appuser
-
-# Copy Python packages from builder stage
+# Copy installed packages from builder
 COPY --from=builder /usr/local/lib/python3.11/site-packages/ /usr/local/lib/python3.11/site-packages/
 COPY --from=builder /usr/local/bin/ /usr/local/bin/
 
-# Set working directory
 WORKDIR /app
 
-# Copy application code
-COPY --chown=appuser:appuser . .
-
-# Create necessary directories
-RUN mkdir -p /app/faiss_store /app/data /app/logs && \
-    chown -R appuser:appuser /app
+# Copy application code (owned by user)
+COPY --chown=user . /app
 
-# Switch to non-root user 
-USER appuser
+# Ensure necessary directories exist
+RUN mkdir -p /app/faiss_store /app/Data && \
+    chown -R user:user /app
 
-# Health check
-HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \
-    CMD curl -f http://localhost:8000/health || exit 1
+USER user
 
-# Expose port
-EXPOSE 8000
+# HF Spaces requires port 7860
+EXPOSE 7860
 
-# Default command
-CMD ["uvicorn", "app:app", "--host", "0.0.0.0", "--port", "8000", "--workers", "1"]
+CMD ["uvicorn", "app:app", "--host", "0.0.0.0", "--port", "7860"]

README.md

@@ -1 +1,55 @@
-# Langchain-Model
+---
+title: Book Model - RAG QA API
+emoji: 📚
+colorFrom: blue
+colorTo: purple
+sdk: docker
+pinned: false
+license: mit
+app_port: 7860
+---
+
+# Book Model — RAG Question Answering API
+
+A Retrieval-Augmented Generation (RAG) API built with **FastAPI**, **FAISS**, **SentenceTransformers**, and **Groq LLM**.
+
+## API Endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `GET` | `/` | Health message |
+| `GET` | `/health` | Detailed system status |
+| `POST` | `/query` | Ask a question against the indexed documents |
+| `GET` | `/docs` | Interactive Swagger UI |
+
+### Example — Query the API
+
+```bash
+curl -X POST "https://jeevant010-book-model.hf.space/query" \
+  -H "Content-Type: application/json" \
+  -d '{"query": "What is machine learning?", "top_k": 3}'
+```
+
+### Response
+
+```json
+{
+  "query": "What is machine learning?",
+  "answer": "Machine learning is ...",
+  "sources": [
+    {"index": 0, "distance": 0.42, "text": "..."}
+  ]
+}
+```
+
+## Environment Variables
+
+Set `GROQ_API_KEY` as a **Secret** in your Hugging Face Space settings.
+
+## Tech Stack
+
+- **FastAPI** — async web framework
+- **FAISS** — vector similarity search
+- **SentenceTransformers** — embedding model (`all-MiniLM-L6-v2`)
+- **Groq** — LLM inference (`llama-3.1-8b-instant`)
+- **LangChain** — document loading & text splitting

app.py

@@ -125,6 +125,6 @@ if __name__ == "__main__":
     uvicorn.run(
         "app:app",
         host="0.0.0.0",
-        port=int(os.getenv("PORT", "8000")),
+        port=int(os.getenv("PORT", "7860")),
         reload=True
     )

faiss_store/faiss.index

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:99934a79e76336eae73893ceb3e4bd88c83f0af49a9886e8956a9ecce6b16899
+size 3117

faiss_store/metadata.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:15ceff12866c206bb4bc1842aedacc9d616474427811f95016531a89ffaa2653
+size 1101

requirements.txt

@@ -7,15 +7,10 @@ langchain-groq>=0.2.0
 
 # Document processing
 pypdf>=4.0.1
-pymupdf>=1.24.0
 
 # Embeddings and vector databases
 sentence-transformers>=3.0.0
 faiss-cpu>=1.8.0
-chromadb>=0.5.0
-
-# Search and indexing
-typesense>=0.19.0
 
 # Web framework and API
 fastapi>=0.115.0
@@ -23,7 +18,4 @@ uvicorn[standard]>=0.32.0
 pydantic>=2.9.0
 
 # Environment and utilities
-python-dotenv>=1.0.0
-
-# Build tools (only if needed for development)
-setuptools>=75.0.0
+python-dotenv>=1.0.0