Update README.md
Browse files
README.md
CHANGED
|
@@ -1,14 +1,59 @@
|
|
| 1 |
---
|
| 2 |
-
title: TSZ
|
| 3 |
-
emoji:
|
| 4 |
colorFrom: purple
|
| 5 |
-
colorTo:
|
| 6 |
sdk: gradio
|
| 7 |
-
sdk_version:
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
license: apache-2.0
|
| 11 |
-
short_description:
|
| 12 |
---
|
| 13 |
|
| 14 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: TSZ - Thyris Safe Zone Demo
|
| 3 |
+
emoji: 🛡️
|
| 4 |
colorFrom: purple
|
| 5 |
+
colorTo: blue
|
| 6 |
sdk: gradio
|
| 7 |
+
sdk_version: 4.44.0
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
license: apache-2.0
|
| 11 |
+
short_description: PII Detection & Guardrails Engine for LLM Security
|
| 12 |
---
|
| 13 |
|
| 14 |
+
# 🛡️ TSZ (Thyris Safe Zone) - Interactive Demo
|
| 15 |
+
|
| 16 |
+
**TSZ** is an open-source PII detection and guardrails engine that prevents sensitive data from leaking to LLMs and third-party APIs.
|
| 17 |
+
|
| 18 |
+
## What This Demo Does
|
| 19 |
+
|
| 20 |
+
1. **Paste any text** containing sensitive information (emails, phone numbers, credit cards, API keys, etc.)
|
| 21 |
+
2. **Click Analyze** to detect PII entities
|
| 22 |
+
3. **Get redacted output** safe to send to LLMs
|
| 23 |
+
|
| 24 |
+
## Supported Detection Types
|
| 25 |
+
|
| 26 |
+
| Category | Types |
|
| 27 |
+
|----------|-------|
|
| 28 |
+
| **Personal Info** | Email, Phone (US/TR), SSN, TC Kimlik, Date of Birth |
|
| 29 |
+
| **Financial** | Credit Cards, IBAN |
|
| 30 |
+
| **Technical** | IP Addresses, API Keys, AWS Keys, Passwords, JWT Tokens |
|
| 31 |
+
|
| 32 |
+
## Get the Full Version
|
| 33 |
+
|
| 34 |
+
This demo uses a simplified detection engine. The full TSZ includes:
|
| 35 |
+
|
| 36 |
+
- More comprehensive pattern matching with validators
|
| 37 |
+
- Configurable guardrails and policies
|
| 38 |
+
- Allowlist/blocklist management
|
| 39 |
+
- REST API with hot-reloadable rules
|
| 40 |
+
- High-performance Go implementation with Redis caching
|
| 41 |
+
- Docker deployment ready
|
| 42 |
+
|
| 43 |
+
### Quick Start
|
| 44 |
+
|
| 45 |
+
```bash
|
| 46 |
+
git clone https://github.com/thyrisAI/safe-zone.git
|
| 47 |
+
cd safe-zone
|
| 48 |
+
docker-compose up -d
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
## Links
|
| 52 |
+
|
| 53 |
+
- 🔗 **GitHub**: [thyrisAI/safe-zone](https://github.com/thyrisAI/safe-zone)
|
| 54 |
+
- 🌐 **Website**: [thyris.ai](https://thyris.ai)
|
| 55 |
+
- 📄 **License**: Apache 2.0
|
| 56 |
+
|
| 57 |
+
---
|
| 58 |
+
|
| 59 |
+
Built with ❤️ by [Thyris.AI](https://thyris.ai)
|