Metadata repo card added - README.md

README.md

@@ -0,0 +1,32 @@
+---
+title: CompassIA
+emoji: 💬📚  # You can choose other emojis here
+colorFrom: green
+colorTo: blue
+sdk: docker  # This must be 'docker' as you selected
+app_port: 7860 # This is the port your uvicorn app is listening on
+# Optional: You can specify a base image for the Docker SDK if not in Dockerfile directly.
+# base_image: python:3.10-slim-buster
+# pinned: false # Usually not needed unless you want to pin a specific commit
+---
+
+# CompassIA
+
+This Space hosts the backend API for CompassIA, a PDF Question Answering system. CompassIA is a smart agent for MaarifCompass that allows users to ask questions about PDF documents, leveraging advanced AI models for natural language understanding and information retrieval.
+
+It uses:
+- **Python FastAPI** for the web API.
+- **DeepSeek Chat** (via OpenRouter) as the Large Language Model.
+- **BGE-M3** from FlagEmbedding for local, multilingual text embeddings.
+- **ChromaDB** for persistent vector storage.
+- **pdfminer.six** and **PyTesseract (with Poppler)** for robust PDF text extraction and OCR.
+
+## How to Use:
+This Space exposes a `/compassia/` API endpoint. You can interact with it using `curl`, Postman, Insomnia, or by integrating it with your Next.js frontend.
+
+### API Endpoint: `/ask-pdf/` (POST request)
+**Request Body (JSON):**
+```json
+{
+    "question": "Your question about the PDF documents"
+}

app.py

@@ -53,8 +53,8 @@ class QueryRequest(BaseModel):
     question: str
 
 # --- API Endpoint Definition ---
-@app.post("/ask-pdf/")
-async def ask_pdf_endpoint(request: QueryRequest):
+@app.post("/compassia/")
+async def compassia_endpoint(request: QueryRequest):
     """
     Answers a question about the indexed PDF documents using RAG.
     """
@@ -63,13 +63,13 @@ async def ask_pdf_endpoint(request: QueryRequest):
         answer = rag_system.answer_question(request.question, [])
         return {"answer": answer}
     except Exception as e:
-        print(f"Error processing /ask-pdf/ request: {e}")
+        print(f"Error processing /compassia/ request: {e}")
         raise HTTPException(status_code=500, detail=str(e))
 
 # Basic health check endpoint
 @app.get("/")
 async def root():
-    return {"message": "Compassia AI PDF Chat API is running. Use /ask-pdf/ for queries."}
+    return {"message": "CompassIA API is running. Use /compassia/ for queries."}
 
 # You can run this locally for testing:
 # if __name__ == "__main__":