Update app.py

app.py

@@ -1,9 +1,6 @@
 """
 TSZ (Thyris Safe Zone) - Interactive Demo
 ==========================================
-This demo showcases how TSZ detects and redacts sensitive information
-before it reaches LLMs or third-party APIs.
-
 GitHub: https://github.com/thyrisAI/safe-zone
 Website: https://thyris.ai
 """
@@ -13,13 +10,8 @@ import re
 from dataclasses import dataclass
 from typing import List, Tuple
 
-# ============================================================================
-# PII Detection Patterns (Simplified version of TSZ's detection engine)
-# ============================================================================
-
 @dataclass
 class Detection:
-    """Represents a detected PII entity"""
     type: str
     value: str
     start: int
@@ -27,11 +19,6 @@ class Detection:
     confidence: str
 
 class TSZDetector:
-    """
-    Simplified PII detector that mimics TSZ's detection capabilities.
-    The real TSZ uses more sophisticated pattern matching and validators.
-    """
-    
     PATTERNS = {
         "EMAIL": {
             "pattern": r'\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}\b',
@@ -61,7 +48,7 @@ class TSZDetector:
         "TC_KIMLIK": {
             "pattern": r'\b[1-9][0-9]{10}\b',
             "placeholder": "[TC_KIMLIK]",
-            "description": "Turkish National ID (TC Kimlik)"
+            "description": "Turkish National ID"
         },
         "IBAN": {
             "pattern": r'\b[A-Z]{2}[0-9]{2}[A-Z0-9]{4}[0-9]{7}([A-Z0-9]?){0,16}\b',
@@ -92,34 +79,19 @@ class TSZDetector:
             "pattern": r'\beyJ[A-Za-z0-9-_]+\.eyJ[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\b',
             "placeholder": "[JWT_TOKEN]",
             "description": "JSON Web Tokens"
-        },
-        "DATE_OF_BIRTH": {
-            "pattern": r'\b(?:0[1-9]|[12][0-9]|3[01])[/-](?:0[1-9]|1[0-2])[/-](?:19|20)[0-9]{2}\b',
-            "placeholder": "[DOB]",
-            "description": "Dates of birth"
         }
     }
     
     def detect(self, text: str) -> Tuple[List[Detection], str]:
-        """
-        Detect PII in text and return detections + redacted text.
-        
-        Returns:
-            Tuple of (list of detections, redacted text)
-        """
         detections = []
         redacted_text = text
         
         for pii_type, config in self.PATTERNS.items():
             pattern = config["pattern"]
-            placeholder = config["placeholder"]
-            
             for match in re.finditer(pattern, text, re.IGNORECASE):
                 value = match.group()
-                
                 if pii_type == "TC_KIMLIK" and len(value) != 11:
                     continue
-                    
                 detections.append(Detection(
                     type=pii_type,
                     value=value,
@@ -129,25 +101,16 @@ class TSZDetector:
                 ))
         
         detections.sort(key=lambda x: x.start, reverse=True)
-        
         for det in detections:
             placeholder = self.PATTERNS[det.type]["placeholder"]
             redacted_text = redacted_text[:det.start] + placeholder + redacted_text[det.end:]
-        
         detections.sort(key=lambda x: x.start)
         
         return detections, redacted_text
 
-# ============================================================================
-# Gradio Interface
-# ============================================================================
-
 detector = TSZDetector()
 
 def analyze_text(text: str) -> Tuple[str, str, str]:
-    """
-    Main analysis function for Gradio interface.
-    """
     if not text.strip():
         return "", "Please enter some text to analyze.", ""
     
@@ -157,7 +120,6 @@ def analyze_text(text: str) -> Tuple[str, str, str]:
         return text, "No sensitive information detected.", "**0** PII entities found"
     
     report_lines = ["### Detected Entities\n"]
-    
     by_type = {}
     for det in detections:
         if det.type not in by_type:
@@ -183,84 +145,393 @@ EXAMPLES = [
     ["Merhaba, ben Ahmet Yilmaz. TC Kimlik numaram 12345678901.\nTelefon: 0532 123 45 67\nIBAN: TR330006100519786457841326"],
 ]
 
-with gr.Blocks(title="TSZ - Thyris Safe Zone Demo") as demo:
+with gr.Blocks(title="TSZ - Thyris Safe Zone Demo", theme=gr.themes.Soft()) as demo:
     
     gr.Markdown("""
-    # TSZ (Thyris Safe Zone) - Interactive Demo
+    # 🛡️ TSZ (Thyris Safe Zone)
+    **Enterprise-grade PII detection and guardrails gateway** that prevents sensitive data from leaking to LLMs and third-party APIs.
     
-    **TSZ** is an open-source PII detection and guardrails engine that prevents sensitive data 
-    from leaking to LLMs and third-party APIs.
-    
-    [GitHub](https://github.com/thyrisAI/safe-zone) | [Website](https://thyris.ai) | Apache 2.0 License
+    [![GitHub](https://img.shields.io/badge/GitHub-Repository-black?logo=github)](https://github.com/thyrisAI/safe-zone)
+    [![Website](https://img.shields.io/badge/Website-thyris.ai-blue)](https://thyris.ai)
+    [![License](https://img.shields.io/badge/License-Apache%202.0-green)](https://github.com/thyrisAI/safe-zone/blob/main/LICENSE)
     """)
     
-    with gr.Row():
-        with gr.Column():
-            input_text = gr.Textbox(
-                label="Input Text",
-                placeholder="Paste text containing emails, phone numbers, credit cards, API keys, passwords, etc...",
-                lines=8
-            )
-            
-            analyze_btn = gr.Button("Analyze & Redact", variant="primary")
+    with gr.Tabs():
+        # Tab 1: Interactive Demo
+        with gr.TabItem("🔍 Interactive Demo"):
+            with gr.Row():
+                with gr.Column():
+                    input_text = gr.Textbox(
+                        label="Input Text",
+                        placeholder="Paste text containing emails, phone numbers, credit cards, API keys...",
+                        lines=8
+                    )
+                    analyze_btn = gr.Button("Analyze & Redact", variant="primary")
+                    gr.Markdown("### Try These Examples")
+                    gr.Examples(examples=EXAMPLES, inputs=input_text)
+                
+                with gr.Column():
+                    stats_output = gr.Markdown(label="Statistics")
+                    redacted_output = gr.Textbox(
+                        label="Redacted Output (Safe to send to LLMs)",
+                        lines=8,
+                        interactive=False
+                    )
+                    detection_report = gr.Markdown(label="Detection Report")
             
-            gr.Markdown("### Try These Examples")
-            gr.Examples(
-                examples=EXAMPLES,
-                inputs=input_text
-            )
+            analyze_btn.click(fn=analyze_text, inputs=[input_text], outputs=[redacted_output, detection_report, stats_output])
+            input_text.submit(fn=analyze_text, inputs=[input_text], outputs=[redacted_output, detection_report, stats_output])
         
-        with gr.Column():
-            stats_output = gr.Markdown(label="Statistics")
-            
-            redacted_output = gr.Textbox(
-                label="Redacted Output (Safe to send to LLMs)",
-                lines=8,
-                interactive=False
-            )
-            
-            detection_report = gr.Markdown(label="Detection Report")
-    
-    gr.Markdown("""
-    ---
-    ### Supported Detection Types
-    
-    | Category | Types |
-    |----------|-------|
-    | **Personal Info** | Email, Phone (US/TR), SSN, TC Kimlik, Date of Birth |
-    | **Financial** | Credit Cards, IBAN |
-    | **Technical** | IP Addresses, API Keys, AWS Keys, Passwords, JWT Tokens |
-    
-    ---
-    
-    ### Get the Full Version
-    
-    This demo uses a simplified detection engine. The full **TSZ** includes:
-    - More comprehensive pattern matching with validators
-    - Configurable guardrails and policies  
-    - REST API with hot-reloadable rules
-    - High-performance Go implementation with Redis caching
-    
-    ```bash
-    git clone https://github.com/thyrisAI/safe-zone.git
-    cd safe-zone
-    docker-compose up -d
-    ```
-    
-    Built by [Thyris.AI](https://thyris.ai)
-    """)
-    
-    analyze_btn.click(
-        fn=analyze_text,
-        inputs=[input_text],
-        outputs=[redacted_output, detection_report, stats_output]
-    )
-    
-    input_text.submit(
-        fn=analyze_text,
-        inputs=[input_text],
-        outputs=[redacted_output, detection_report, stats_output]
-    )
+        # Tab 2: API Reference
+        with gr.TabItem("📚 API Reference"):
+            gr.Markdown("""
+## TSZ API Reference
+
+TSZ is an enterprise-grade PII detection and guardrails gateway. It acts as a zero-trust middleware between your applications and external systems (LLMs, SaaS APIs, third-party services).
+
+---
+
+### Base Information
+
+**Base URL (Docker Compose):**
+```
+http://localhost:8080
+```
+
+**Production:**
+```
+https://tsz.your-company.com
+```
+
+**Content Type:** `application/json`
+
+---
+
+### Confidence & Guardrails Model
+
+TSZ uses a hybrid confidence system:
+
+| Confidence | Action |
+|------------|--------|
+| < 0.30 | ALLOW (ignored) |
+| 0.30 – 0.85 | MASK (redact) |
+| ≥ 0.85 | AUTO-BLOCK |
+
+---
+
+### POST /detect
+
+Primary endpoint for PII detection and redaction.
+
+**Request:**
+```json
+{
+  "text": "My email is user@company.com",
+  "rid": "request-123",
+  "guardrails": ["TOXIC_LANGUAGE"]
+}
+```
+
+**Response:**
+```json
+{
+  "redacted_text": "My email is [EMAIL]",
+  "detections": [
+    {
+      "type": "EMAIL",
+      "value": "user@company.com",
+      "placeholder": "[EMAIL]",
+      "start": 12,
+      "end": 28,
+      "confidence_score": "0.78",
+      "confidence_explanation": {
+        "source": "HYBRID",
+        "regex_score": "0.55",
+        "ai_score": "0.90",
+        "final_score": "0.78"
+      }
+    }
+  ],
+  "blocked": false,
+  "contains_pii": true,
+  "overall_confidence": "0.78"
+}
+```
+
+**cURL Example:**
+```bash
+curl -X POST http://localhost:8080/detect \\
+  -H "Content-Type: application/json" \\
+  -d '{
+    "text": "Contact john@example.com",
+    "rid": "req-001",
+    "guardrails": ["TOXIC_LANGUAGE"]
+  }'
+```
+
+---
+
+### POST /v1/chat/completions
+
+OpenAI-compatible LLM Gateway with built-in guardrails.
+
+**Headers:**
+- `X-TSZ-RID`: Request ID for audit logs
+- `X-TSZ-Guardrails`: Comma-separated validators (e.g., `TOXIC_LANGUAGE,PII`)
+- `X-TSZ-Guardrails-Mode`: `final-only` | `stream-sync` | `stream-async`
+- `X-TSZ-Guardrails-OnFail`: `filter` | `halt`
+
+**Request:**
+```bash
+curl -X POST http://localhost:8080/v1/chat/completions \\
+  -H "Content-Type: application/json" \\
+  -H "X-TSZ-Guardrails: TOXIC_LANGUAGE" \\
+  -d '{
+    "model": "gpt-4",
+    "messages": [
+      {"role": "user", "content": "My credit card is 4111111111111111"}
+    ],
+    "stream": false
+  }'
+```
+
+**Python SDK Example:**
+```python
+from openai import OpenAI
+
+client = OpenAI(
+    base_url="http://localhost:8080/v1",
+    api_key="dummy"  # TSZ uses env var
+)
+
+resp = client.chat.completions.create(
+    model="gpt-4",
+    messages=[{"role": "user", "content": "Hello"}],
+    extra_headers={
+        "X-TSZ-Guardrails": "TOXIC_LANGUAGE,PII",
+        "X-TSZ-Guardrails-Mode": "stream-sync"
+    }
+)
+```
+
+---
+
+### Pattern Management
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| `POST` | `/patterns` | Create pattern |
+| `GET` | `/patterns` | List patterns |
+| `DELETE` | `/patterns/{id}` | Delete pattern |
+
+**Create Pattern:**
+```json
+{
+  "Name": "PHONE_NUMBER",
+  "Regex": "\\\\+?[0-9]{10,13}",
+  "Category": "PII",
+  "IsActive": true,
+  "BlockThreshold": 0.9
+}
+```
+
+---
+
+### Allowlist / Blocklist
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| `POST` | `/allowlist` | Add trusted value |
+| `GET` | `/allowlist` | List allowlist |
+| `DELETE` | `/allowlist/{id}` | Remove item |
+| `POST` | `/blacklist` | Add blocked value |
+| `GET` | `/blacklist` | List blocklist |
+| `DELETE` | `/blacklist/{id}` | Remove item |
+
+---
+
+### Validators & Guardrails
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| `POST` | `/validators` | Create validator |
+| `GET` | `/validators` | List validators |
+| `DELETE` | `/validators/{id}` | Delete validator |
+
+**AI Validator Example:**
+```json
+{
+  "name": "TOXIC_LANGUAGE",
+  "type": "AI_PROMPT",
+  "rule": "Is this text toxic? Answer YES or NO.",
+  "expected_response": "NO"
+}
+```
+
+---
+
+### Health & Admin
+
+| Endpoint | Description |
+|----------|-------------|
+| `GET /healthz` | Liveness probe |
+| `GET /ready` | Readiness probe (DB + Redis) |
+| `POST /admin/reload` | Clear caches |
+
+---
+
+### Client SDKs
+
+**Python:**
+```bash
+pip install "tszclient-py @ git+https://github.com/thyrisAI/safe-zone.git@main"
+```
+
+```python
+from tszclient_py import TSZClient
+client = TSZClient("http://localhost:8080")
+result = client.detect("test@example.com")
+```
+
+**Go:**
+```go
+import "github.com/thyrisAI/safe-zone/pkg/tszclient-go"
+client := tszclient.New("http://localhost:8080")
+result, _ := client.Detect("test@example.com")
+```
+
+---
+
+📖 **Full Documentation:** [API_REFERENCE.md](https://github.com/thyrisAI/safe-zone/blob/main/docs/API_REFERENCE.md)
+            """)
+        
+        # Tab 3: Quick Start
+        with gr.TabItem("🚀 Quick Start"):
+            gr.Markdown("""
+## Get Started with TSZ
+
+### Docker (Recommended)
+
+```bash
+git clone https://github.com/thyrisAI/safe-zone.git
+cd safe-zone
+docker-compose up -d
+```
+
+TSZ will be available at `http://localhost:8080`
+
+---
+
+### Environment Variables
+
+```bash
+# LLM Gateway Configuration
+THYRIS_AI_MODEL_URL=https://api.openai.com/v1
+THYRIS_AI_API_KEY=sk-your-key
+THYRIS_AI_MODEL=gpt-4
+
+# Confidence Thresholds
+CONFIDENCE_ALLOW_THRESHOLD=0.30
+CONFIDENCE_BLOCK_THRESHOLD=0.85
+
+# Admin API Key
+ADMIN_API_KEY=your-secure-admin-key
+```
+
+---
+
+### Test the API
+
+```bash
+curl -X POST http://localhost:8080/detect \\
+  -H "Content-Type: application/json" \\
+  -d '{"text": "Email: test@example.com", "rid": "test-001"}'
+```
+
+---
+
+### Architecture
+
+```
+┌─────────────┐     ┌─────────────┐     ┌─────────────┐
+│  Your App   │────▶│     TSZ     │────▶│  LLM API    │
+└─────────────┘     └─────────────┘     └─────────────┘
+                          │
+                    ┌─────▼─────┐
+                    │ Audit Log │
+                    │  + Redis  │
+                    └───────────┘
+```
+
+---
+
+### Key Features
+
+| Feature | Description |
+|---------|-------------|
+| **Hybrid Detection** | Regex + AI-powered confidence scoring |
+| **Real-time Redaction** | Context-preserving placeholders |
+| **LLM Gateway** | OpenAI-compatible proxy with guardrails |
+| **Streaming Support** | sync/async modes for SSE |
+| **Hot-reload Rules** | Update patterns via API |
+| **Audit Trail** | Full logging for compliance |
+
+---
+
+📖 **Documentation:** [github.com/thyrisAI/safe-zone/docs](https://github.com/thyrisAI/safe-zone/tree/main/docs)
+            """)
+        
+        # Tab 4: About
+        with gr.TabItem("ℹ️ About"):
+            gr.Markdown("""
+## About TSZ (Thyris Safe Zone)
+
+Developed by **Thyris.AI** as an open-source enterprise AI security solution.
+
+### Why TSZ?
+
+| Challenge | TSZ Solution |
+|-----------|--------------|
+| PII leaking to LLMs | Real-time detection & redaction |
+| GDPR/KVKK compliance | Data never leaves your perimeter |
+| Toxic content in AI | AI-powered guardrails |
+| Audit requirements | Complete request logging |
+| Integration complexity | OpenAI-compatible gateway |
+
+---
+
+### Detection Types
+
+| Category | Types |
+|----------|-------|
+| **Personal Info** | Email, Phone, SSN, TC Kimlik, DOB |
+| **Financial** | Credit Card, IBAN |
+| **Technical** | API Keys, AWS Keys, Passwords, JWT |
+| **Custom** | User-defined patterns |
+
+---
+
+### Compliance Ready
+
+- ✅ GDPR (EU)
+- ✅ KVKK (Turkey)
+- ✅ CCPA (California)
+- ✅ HIPAA (Healthcare)
+- ✅ PCI-DSS (Payment)
+
+---
+
+### Links
+
+- 🔗 **GitHub:** [thyrisAI/safe-zone](https://github.com/thyrisAI/safe-zone)
+- 🌐 **Website:** [thyris.ai](https://thyris.ai)
+- 📄 **License:** Apache 2.0
+- 📖 **Docs:** [Documentation](https://github.com/thyrisAI/safe-zone/tree/main/docs)
+
+---
+
+Built with ❤️ by [Thyris.AI](https://thyris.ai)
+            """)
 
 if __name__ == "__main__":
     demo.launch()