Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -1,51 +1,21 @@
|
|
| 1 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
|
| 3 |
-
|
| 4 |
|
| 5 |
-
|
| 6 |
-
- **50+ PII entity types** detected via NLP + regex + ML
|
| 7 |
-
- **Real-time scanning** — paste text, upload files, or use the API
|
| 8 |
-
- **Multiple modes** — highlight, redact, mask, or hash sensitive data
|
| 9 |
-
- **Full dashboard** — analytics, scan history, file upload, API key management
|
| 10 |
-
- **REST API** with auto-generated Swagger docs
|
| 11 |
-
- **Zero data stored** — nothing is saved to disk
|
| 12 |
-
|
| 13 |
-
## Quick Start
|
| 14 |
-
|
| 15 |
-
```bash
|
| 16 |
-
# Install dependencies
|
| 17 |
-
pip install -r requirements.txt
|
| 18 |
-
python -m spacy download en_core_web_lg
|
| 19 |
-
|
| 20 |
-
# Run the server
|
| 21 |
-
python server.py
|
| 22 |
-
```
|
| 23 |
-
|
| 24 |
-
Then open http://127.0.0.1:8000
|
| 25 |
-
|
| 26 |
-
## Docker
|
| 27 |
-
|
| 28 |
-
```bash
|
| 29 |
-
docker build -t redactai .
|
| 30 |
-
docker run -p 8000:8000 redactai
|
| 31 |
-
```
|
| 32 |
|
| 33 |
## API Endpoints
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
| POST | `/api/v1/scan/file` | Upload and scan a file |
|
| 40 |
-
| GET | `/api/v1/history` | Get scan history |
|
| 41 |
-
| GET | `/api/v1/stats` | Get analytics |
|
| 42 |
-
| GET | `/api/v1/supported-entities` | List detectable entity types |
|
| 43 |
-
|
| 44 |
-
## Tech Stack
|
| 45 |
-
- **Backend:** FastAPI + Microsoft Presidio + spaCy
|
| 46 |
-
- **Frontend:** Vanilla HTML/CSS/JS (dark-mode glassmorphism)
|
| 47 |
-
- **NLP Model:** en_core_web_lg (spaCy)
|
| 48 |
-
- **License:** MIT
|
| 49 |
-
|
| 50 |
-
## Compliance
|
| 51 |
-
Supports GDPR, HIPAA, PCI DSS, DPDP Act, CCPA, SOC 2 compliance workflows.
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: RedactAI
|
| 3 |
+
emoji: 🛡️
|
| 4 |
+
colorFrom: purple
|
| 5 |
+
colorTo: blue
|
| 6 |
+
sdk: docker
|
| 7 |
+
pinned: false
|
| 8 |
+
license: mit
|
| 9 |
+
app_port: 7860
|
| 10 |
+
---
|
| 11 |
|
| 12 |
+
# RedactAI — AI-Powered PII Detection & Redaction API
|
| 13 |
|
| 14 |
+
Detect and redact sensitive data instantly using Microsoft Presidio + spaCy NLP.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 15 |
|
| 16 |
## API Endpoints
|
| 17 |
+
- `POST /api/v1/scan` — Scan text for PII
|
| 18 |
+
- `POST /api/v1/scan/batch` — Batch scan
|
| 19 |
+
- `POST /api/v1/scan/file` — Upload files
|
| 20 |
+
- `GET /api/v1/supported-entities` — List detectable types
|
| 21 |
+
- `GET /docs` — Swagger API docs
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|