feat: update rate limit to 1/2s, custom error message, and SEO PNG placeholder

README.md

@@ -19,15 +19,6 @@ tags:
 
 A lightweight PII (Personally Identifiable Information) moderation MVP designed to sanitize sensitive data before it reaches LLM APIs.
 
-## 🚀 Key Features
-
-- **Multi-Language Support**: High-accuracy detection for **English** and **French** using `spaCy` Large models.
-- **Double-Pass Protection**: Combines NLP-based detection with expert Regex patterns for PII coverage.
-- **Expert French Recognizers**: Built-in support for French-specific data: **SIRET**, **NIR** (Social Security), **IBAN**, and addresses.
-- **Balanced Anonymization**: Preserves job titles and document structure to keep texts readable.
-- **Minimal Dashboard**: React-based UI with Risk Assessment visualization.
-- **Custom Theme UI**: Switch between **Premium**, **Minimal Light**, and **Deep Midnight** modes.
-
 ---
 
 ## 🎥 Demo
@@ -43,85 +34,86 @@ Check out Redac in action:
 
 ---
 
-## 🛠️ Architecture
-
-1.  **Core API (`/api`)**: FastAPI server powered by **Microsoft Presidio**.
-2.  **Web Dashboard (`/ui`)**: React + Vite + Tailwind CSS.
+## 📖 API Documentation
+
+The Redac API is open and can be integrated into your own workflows.
+
+### 🏠 Base URL
+`https://lbl-redaction.hf.space/api`
+
+### ⚡ Rate Limiting
+- **1 request every 2 seconds** per IP address to ensure stability.
+- Exceeding this limit will return a `429 Too Many Requests` status code with a helpful message.
+
+### 🔍 Endpoints
+
+#### 1. Redact Text
+Processes a text and returns the anonymized version along with metadata about detected entities.
+
+- **URL**: `/redact`
+- **Method**: `POST`
+- **Headers**: `Content-Type: application/json`
+- **Body**:
+  ```json
+  {
+    "text": "Your sensitive text here",
+    "language": "auto" 
+  }
+  ```
+  *(Options for language: `auto`, `en`, `fr`)*
+
+- **Success Response (200 OK)**:
+  ```json
+  {
+    "original_text": "...",
+    "redacted_text": "My name is <PERSON>",
+    "detected_language": "en",
+    "entities": [
+      {
+        "type": "PERSON",
+        "text": "John Doe",
+        "score": 95,
+        "start": 11,
+        "end": 19
+      }
+    ]
+  }
+  ```
+
+#### 2. System Status
+Checks if the API and NLP engines are online.
+
+- **URL**: `/status`
+- **Method**: `GET`
 
 ---
 
-## 📦 Getting Started (Docker)
-
-### Quick Start with Makefile
-If you have `make` installed, you can use these shortcuts:
-```bash
-make build   # Build containers
-make up      # Start Redac
-make logs    # View logs
-make test    # Run tests
-```
-
-### Manual Docker commands
-```bash
-docker compose up --build
-```
+## 🚀 Key Features
 
-- **API**: `http://localhost:8000/api`
-- **UI Dashboard**: `http://localhost:5173`
+- **Multi-Language Support**: High-accuracy detection for **English** and **French** using `spaCy` Large models.
+- **Double-Pass Protection**: Combines NLP-based detection with expert Regex patterns for PII coverage.
+- **Expert French Recognizers**: Built-in support for French-specific data: **SIRET**, **NIR**, **IBAN**, and addresses.
+- **Balanced Anonymization**: Preserves job titles and document structure to keep texts readable.
+- **Minimal Dashboard**: React-based UI with Risk Assessment visualization.
 
 ---
 
-## 🔌 API Usage
-
-You can interact directly with the Redac API using `curl`.
-
-### Redact Text
-**Request:**
-```bash
-curl -X POST http://localhost:8000/api/redact \
-     -H "Content-Type: application/json" \
-     -d '{"text": "My name is John Doe, call me at 06 12 34 56 78."}'
-```
+## 🛠️ Architecture
 
-**Response (JSON):**
-```json
-{
-  "original_text": "My name is John Doe, call me at 06 12 34 56 78.",
-  "redacted_text": "My name is <PERSON>, call me at <PHONE_NUMBER>.",
-  "detected_language": "en",
-  "entities": [
-    {
-      "type": "PERSON",
-      "text": "John Doe",
-      "score": 85,
-      "start": 11,
-      "end": 19
-    },
-    {
-      "type": "PHONE_NUMBER",
-      "text": "06 12 34 56 78",
-      "score": 95,
-      "start": 32,
-      "end": 46
-    }
-  ]
-}
-```
+1.  **Core API (`/api`)**: FastAPI server powered by **Microsoft Presidio**.
+2.  **Web Dashboard (`/ui`)**: React + Vite + Tailwind CSS.
 
 ---
 
-## 🧪 Quality Assurance
+## 📦 Local Development
 
-### Using Makefile
+### Manual Docker commands
 ```bash
-make test
+docker compose up --build
 ```
 
-### Manual Docker
-```bash
-# Run the test suite
-docker compose run api python tests/verify_all.py
-```
+- **API**: `http://localhost:8000/api`
+- **UI Dashboard**: `http://localhost:5173`
 
 ---
 

api/main.py

@@ -1,7 +1,7 @@
-from fastapi import FastAPI, HTTPException
+from fastapi import FastAPI, HTTPException, Request
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.staticfiles import StaticFiles
-from fastapi.responses import FileResponse
+from fastapi.responses import FileResponse, JSONResponse
 from pydantic import BaseModel
 from typing import List, Dict, Optional
 import logging
@@ -14,6 +14,9 @@ from presidio_analyzer.nlp_engine import NlpEngineProvider
 from presidio_anonymizer import AnonymizerEngine
 from langdetect import detect, DetectorFactory
 import uvicorn
+from slowapi import Limiter, _rate_limit_exceeded_handler
+from slowapi.util import get_remote_address
+from slowapi.errors import RateLimitExceeded
 
 # Setup logging
 logging.basicConfig(level=logging.INFO)
@@ -21,8 +24,17 @@ logger = logging.getLogger(__name__)
 
 DetectorFactory.seed = 0
 
+# Setup rate limiting
+limiter = Limiter(key_func=get_remote_address)
 app = FastAPI(title="Redac API")
+app.state.limiter = limiter
 
+@app.exception_handler(RateLimitExceeded)
+async def custom_rate_limit_exceeded_handler(request: Request, exc: RateLimitExceeded):
+    return JSONResponse(
+        status_code=429,
+        content={"detail": "Too many requests. Please wait 2 seconds between each analysis to avoid saturating the server."}
+    )
 
 app.add_middleware(
     CORSMiddleware,
@@ -81,7 +93,8 @@ async def api_status():
     return {"status": "online", "mode": "pro-visual"}
 
 @app.post("/api/redact")
-async def redact_text(request: RedactRequest):
+@limiter.limit("1/2seconds")
+async def redact_text(request: RedactRequest, request_raw: Request):
     # ... (rest of the logic)
     try:
         try:

ui/index.html

@@ -19,14 +19,14 @@
     <meta property="og:url" content="https://lbl-redaction.hf.space" />
     <meta property="og:title" content="Redac | AI-Powered PII Data Redaction" />
     <meta property="og:description" content="Securely sanitize your documents. Automated PII detection and redaction for French and English texts." />
-    <meta property="og:image" content="/src/assets/hero.png" />
+    <meta property="og:image" content="/logo.png" />
 
     <!-- Twitter -->
-    <meta property="twitter:card" content="summary_large_image" />
+    <meta property="twitter:card" content="summary" />
     <meta property="twitter:url" content="https://lbl-redaction.hf.space" />
-    <meta property="twitter:title" content="Redac | AI-Powered PII Data Redaction" />
+    <meta property="twitter:title" content="Redac - AI PII Redaction Tool" />
     <meta property="twitter:description" content="Protect sensitive data before sending to LLMs. Fast, secure, and automated PII redaction." />
-    <meta property="twitter:image" content="/src/assets/hero.png" />
+    <meta property="twitter:image" content="/logo.png" />
   </head>
   <body>
     <div id="root"></div>