koreshield 0.1.4__tar.gz → 0.2.0__tar.gz

{koreshield-0.1.4/src/koreshield.egg-info → koreshield-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: koreshield
-Version: 0.1.4
+Version: 0.2.0
 Summary: Python SDK for KoreShield LLM Security Platform
 Author-email: KoreShield Team <team@koreshield.com>
 Maintainer-email: KoreShield Team <team@koreshield.com>
@@ -10,6 +10,7 @@ Project-URL: Documentation, https://docs.koreshield.com
 Project-URL: Repository, https://github.com/koreshield/koreshield.git
 Project-URL: Issues, https://github.com/koreshield/koreshield/issues
 Project-URL: Changelog, https://github.com/koreshield/koreshield/blob/main/koreshield-python-sdk/CHANGELOG.md
+Project-URL: PyPI, https://pypi.org/project/koreshield/
 Keywords: llm,security,ai,safety,prompt-injection,koreshield
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -61,6 +62,16 @@ Dynamic: license-file
 
 A comprehensive Python SDK for integrating KoreShield's LLM security features into your applications with ease.
 
+## New in v0.2.0
+
+- **Enhanced Async Support**: Improved async/await patterns with context managers and performance monitoring
+- **Advanced Batch Processing**: Optimized batch scanning with progress callbacks, concurrency control, and batching
+- **Streaming Content Scanning**: Real-time scanning of long content with overlapping chunks
+- **Security Policies**: Configurable allowlist/blocklist patterns and custom threat rules
+- **Framework Integrations**: Built-in middleware for FastAPI, Flask, and Django
+- **Performance Monitoring**: Comprehensive metrics collection and analytics
+- **Type Safety**: Full Pydantic models for all data structures
+
 ## Supported LLM Providers
 
 KoreShield supports multiple LLM providers through its proxy architecture. Configure your preferred provider in the KoreShield API:
@@ -80,11 +91,11 @@ providers:
   deepseek:
     enabled: true
     base_url: "https://api.deepseek.com/v1"
-  
+
   openai:
     enabled: false
     base_url: "https://api.openai.com/v1"
-  
+
   anthropic:
     enabled: false
     base_url: "https://api.anthropic.com/v1"
@@ -95,7 +106,7 @@ Set the corresponding API key as an environment variable:
 export DEEPSEEK_API_KEY="your-deepseek-key"
 # or
 export OPENAI_API_KEY="your-openai-key"
-# or  
+# or
 export ANTHROPIC_API_KEY="your-anthropic-key"
 ```
 
@@ -130,17 +141,21 @@ result = client.scan_prompt("Hello, how are you?")
 print(f"Safe: {result.is_safe}, Threat Level: {result.threat_level}")
 ```
 
-### Async Usage
+### Enhanced Async Usage
 
 ```python
 import asyncio
 from koreshield_sdk import AsyncKoreShieldClient
 
 async def main():
-    async with AsyncKoreShieldClient(api_key="your-api-key") as client:
+    async with AsyncKoreShieldClient(api_key="your-api-key", enable_metrics=True) as client:
         result = await client.scan_prompt("Tell me a joke")
         print(f"Confidence: {result.confidence}")
 
+        # Get performance metrics
+        metrics = await client.get_performance_metrics()
+        print(f"Total requests: {metrics.total_requests}")
+
 asyncio.run(main())
 ```
 
@@ -177,14 +192,27 @@ response = llm([HumanMessage(content="Hello!")])
 
 ### AsyncKoreShieldClient
 
-#### Methods
+#### Core Methods
 
 - `scan_prompt(prompt: str, **kwargs) -> DetectionResult` (async)
-- `scan_batch(prompts: List[str], parallel=True, max_concurrent=10) -> List[DetectionResult]` (async)
+- `scan_batch(prompts: List[str], parallel=True, max_concurrent=10, progress_callback=None) -> List[DetectionResult]` (async)
+- `scan_stream(content: str, chunk_size=1000, overlap=100, **kwargs) -> StreamingScanResponse` (async)
 - `get_scan_history(limit=50, offset=0, **filters) -> Dict` (async)
 - `get_scan_details(scan_id: str) -> Dict` (async)
 - `health_check() -> Dict` (async)
 
+#### Security Policy Methods
+
+- `set_security_policy(policy: SecurityPolicy) -> None` (async)
+- `get_security_policy() -> SecurityPolicy` (async)
+- `update_security_policy(**updates) -> SecurityPolicy` (async)
+
+#### Performance Monitoring Methods
+
+- `get_performance_metrics() -> PerformanceMetrics` (async)
+- `reset_metrics() -> None` (async)
+- `enable_metrics(enabled: bool = True) -> None` (async)
+
 ### DetectionResult
 
 ```python
@@ -198,6 +226,48 @@ class DetectionResult:
     metadata: Optional[Dict[str, Any]]
 ```
 
+### New Types (v0.2.0)
+
+#### StreamingScanResponse
+
+```python
+class StreamingScanResponse:
+    overall_result: DetectionResult
+    chunk_results: List[ChunkResult]
+    total_chunks: int
+    processing_time_ms: float
+    scan_id: str
+```
+
+#### SecurityPolicy
+
+```python
+class SecurityPolicy:
+    name: str
+    description: Optional[str]
+    threat_threshold: ThreatLevel
+    blocked_detection_types: List[str]
+    allowlist_patterns: List[str]
+    blocklist_patterns: List[str]
+    custom_rules: List[Dict[str, Any]]
+```
+
+#### PerformanceMetrics
+
+```python
+class PerformanceMetrics:
+    total_requests: int
+    total_processing_time: float
+    average_response_time: float
+    min_response_time: float
+    max_response_time: float
+    error_count: int
+    success_rate: float
+    requests_per_second: float
+    start_time: datetime
+    last_request_time: Optional[datetime]
+```
+
 ## Configuration
 
 ### Environment Variables
@@ -242,93 +312,200 @@ for prompt, result in zip(prompts, results):
     print(f"'{prompt}': {result.threat_level} ({result.confidence:.2f})")
 ```
 
+### Advanced Async Features
+
+```python
+import asyncio
+from koreshield_sdk import AsyncKoreShieldClient
+
+async def main():
+    async with AsyncKoreShieldClient(api_key="your-api-key", enable_metrics=True) as client:
+
+        # Enhanced batch processing with progress callback
+        def progress_callback(completed, total, current_result=None):
+            print(f"Progress: {completed}/{total} completed")
+            if current_result:
+                print(f"  Latest result: {current_result.threat_level}")
+
+        prompts = ["Prompt 1", "Prompt 2", "Prompt 3", "Prompt 4", "Prompt 5"]
+        results = await client.scan_batch(
+            prompts,
+            parallel=True,
+            max_concurrent=3,
+            progress_callback=progress_callback
+        )
+
+        # Streaming content scanning for long documents
+        long_content = "Your very long document content here..." * 100
+        stream_result = await client.scan_stream(
+            content=long_content,
+            chunk_size=1000,
+            overlap=100
+        )
+
+        print(f"Overall safe: {stream_result.overall_result.is_safe}")
+        print(f"Chunks processed: {stream_result.total_chunks}")
+
+        # Get performance metrics
+        metrics = await client.get_performance_metrics()
+        print(f"Total requests: {metrics.total_requests}")
+        print(".2f"
+asyncio.run(main())
+```
+
+### Security Policies
+
+```python
+from koreshield_sdk import AsyncKoreShieldClient
+from koreshield_sdk.types import SecurityPolicy, ThreatLevel
+
+async def main():
+    # Create custom security policy
+    policy = SecurityPolicy(
+        name="strict_policy",
+        description="Strict security for sensitive applications",
+        threat_threshold=ThreatLevel.LOW,
+        allowlist_patterns=["safe", "trusted"],
+        blocklist_patterns=["hack", "exploit", "attack"],
+        custom_rules=[
+            {"name": "no_code_execution", "pattern": "exec\\(|eval\\("},
+            {"name": "no_file_operations", "pattern": "open\\(|file\\("}
+        ]
+    )
+
+    async with AsyncKoreShieldClient(
+        api_key="your-api-key",
+        security_policy=policy
+    ) as client:
+
+        # Test against policy
+        test_prompts = [
+            "This is a safe message",
+            "This contains hack attempts",
+            "Let's execute: exec('print(hello)')"
+        ]
+
+        for prompt in test_prompts:
+            result = await client.scan_prompt(prompt)
+            status = "✅ ALLOWED" if result.is_safe else "❌ BLOCKED"
+            print(f"{status}: {prompt}")
+
+asyncio.run(main())
+```
+
 ### FastAPI Integration
 
 ```python
-from fastapi import FastAPI, HTTPException
-from koreshield_sdk import KoreShieldClient
+from fastapi import FastAPI, Request
+from koreshield_sdk.integrations import create_fastapi_middleware
 
 app = FastAPI()
-client = KoreShieldClient(api_key="your-api-key")
 
-@app.post("/chat")
-async def chat(message: str):
-    # Scan user input
-    result = client.scan_prompt(message)
+# Create and add KoreShield middleware
+middleware = create_fastapi_middleware(
+    api_key="your-api-key",
+    scan_request_body=True,
+    threat_threshold="medium",
+    block_on_threat=False,  # Log but don't block
+    exclude_paths=["/health", "/docs"]
+)
 
-    if not result.is_safe and result.threat_level in ["high", "critical"]:
-        raise HTTPException(status_code=400, detail="Unsafe content detected")
+app.middleware("http")(middleware)
+
+@app.post("/chat")
+async def chat(request: Request, message: str):
+    # Request is automatically scanned by middleware
+    # Access scan results from request state if needed
+    scan_result = getattr(request.state, 'koreshield_result', None)
+    if scan_result and not scan_result.is_safe:
+        print(f"Threat detected: {scan_result.threat_level}")
 
     # Process with your LLM
     response = f"Processed: {message}"
-    return {"response": response, "safety": result.dict()}
+    return {"response": response}
 ```
 
 ### Flask Integration
 
 ```python
-from flask import Flask, request, jsonify
-from koreshield_sdk import KoreShieldClient
+from flask import Flask, request, jsonify, g
+from koreshield_sdk.integrations import create_flask_middleware
 
 app = Flask(__name__)
-client = KoreShieldClient(api_key="your-api-key")
+
+# Create and register KoreShield middleware
+middleware = create_flask_middleware(
+    api_key="your-api-key",
+    scan_request_body=True,
+    threat_threshold="high",
+    block_on_threat=True,
+    exclude_paths=["/health"]
+)
+
+app.before_request(middleware)
 
 @app.route("/api/chat", methods=["POST"])
 def chat():
+    # Check if request was blocked by middleware
+    if hasattr(g, 'koreshield_blocked') and g.koreshield_blocked:
+        return jsonify({"error": "Request blocked by security policy"}), 403
+
     data = request.get_json()
     message = data.get("message", "")
 
-    # Scan user input
-    result = client.scan_prompt(message)
-
-    if not result.is_safe:
-        return jsonify({
-            "error": "Unsafe content detected",
-            "threat_level": result.threat_level,
-            "confidence": result.confidence
-        }), 400
+    # Access scan results
+    scan_result = getattr(g, 'koreshield_result', None)
 
     # Process with your LLM
     response = f"Echo: {message}"
-    return jsonify({"response": response})
+    return jsonify({
+        "response": response,
+        "safety": scan_result.dict() if scan_result else None
+    })
 ```
 
 ### Django Integration
 
 ```python
+# settings.py
+KORESHIELD_CONFIG = {
+    'api_key': 'your-api-key',
+    'scan_request_body': True,
+    'threat_threshold': 'medium',
+    'block_on_threat': False,
+    'exclude_paths': ['/health/', '/admin/']
+}
+
+# middleware.py
+from koreshield_sdk.integrations import create_django_middleware
+
+KoreShieldMiddleware = create_django_middleware()
+
 # views.py
 from django.http import JsonResponse
 from django.views.decorators.csrf import csrf_exempt
 from django.utils.decorators import method_decorator
 from django.views import View
 import json
-from koreshield_sdk import KoreShieldClient
-
-client = KoreShieldClient(api_key="your-api-key")
 
 @method_decorator(csrf_exempt, name='dispatch')
 class ChatView(View):
     def post(self, request):
+        # Check if request was blocked by middleware
+        if hasattr(request, 'koreshield_blocked') and request.koreshield_blocked:
+            return JsonResponse({"error": "Request blocked by security policy"}, status=403)
+
         data = json.loads(request.body)
         message = data.get("message", "")
 
-        # Scan user input
-        result = client.scan_prompt(message)
-
-        if not result.is_safe and result.threat_level == "critical":
-            return JsonResponse({
-                "error": "Critical threat detected"
-            }, status=400)
+        # Access scan results
+        scan_result = getattr(request, 'koreshield_result', None)
 
         # Process with your LLM
         response = f"Response to: {message}"
         return JsonResponse({
             "response": response,
-            "safety_check": {
-                "safe": result.is_safe,
-                "threat_level": result.threat_level,
-                "confidence": result.confidence
-            }
+            "safety_check": scan_result.dict() if scan_result else None
         })
 ```
 
@@ -387,6 +564,68 @@ results = await client.scan_batch(
 )
 ```
 
+### Streaming Content Scanning
+
+```python
+# Scan long documents with overlapping chunks
+long_document = "Very long content..." * 1000
+
+result = await client.scan_stream(
+    content=long_document,
+    chunk_size=2000,      # Process in 2000-character chunks
+    overlap=200           # 200-character overlap between chunks
+)
+
+print(f"Overall safe: {result.overall_result.is_safe}")
+print(f"Total chunks: {result.total_chunks}")
+for i, chunk_result in enumerate(result.chunk_results):
+    print(f"Chunk {i+1}: {chunk_result.result.threat_level}")
+```
+
+### Performance Monitoring
+
+```python
+async with AsyncKoreShieldClient(api_key="your-api-key", enable_metrics=True) as client:
+    # Perform operations...
+    await client.scan_prompt("Test prompt")
+    await client.scan_batch(["Prompt 1", "Prompt 2"])
+
+    # Get comprehensive metrics
+    metrics = await client.get_performance_metrics()
+    print(f"Total requests: {metrics.total_requests}")
+    print(".2f"    print(".2f"    print(f"Success rate: {metrics.success_rate:.1%}")
+
+    # Reset metrics if needed
+    await client.reset_metrics()
+```
+
+### Security Policy Management
+
+```python
+from koreshield_sdk.types import SecurityPolicy, ThreatLevel
+
+# Create and apply custom policy
+policy = SecurityPolicy(
+    name="enterprise_policy",
+    threat_threshold=ThreatLevel.MEDIUM,
+    allowlist_patterns=["approved", "safe"],
+    blocklist_patterns=["banned", "dangerous"],
+    custom_rules=[
+        {"name": "no_pii", "pattern": "\\b\\d{3}-\\d{2}-\\d{4}\\b"},  # SSN pattern
+        {"name": "no_emails", "pattern": "\\S+@\\S+\\.\\S+"}
+    ]
+)
+
+await client.set_security_policy(policy)
+
+# Update policy dynamically
+await client.update_security_policy(threat_threshold=ThreatLevel.HIGH)
+
+# Get current policy
+current_policy = await client.get_security_policy()
+print(f"Current threshold: {current_policy.threat_threshold}")
+```
+
 ### Monitoring and Analytics
 
 ```python
@@ -436,7 +675,7 @@ MIT License - see [LICENSE](LICENSE) file for details.
 
 ## Support
 
-- 📖 [Documentation](https://docs.koreshield.com)
-- 🐛 [Issue Tracker](https://github.com/koreshield/koreshield-python-sdk/issues)
-- 💬 [Discussions](https://github.com/koreshield/koreshield-python-sdk/discussions)
-- 📧 [Email Support](mailto:support@koreshield.com)
+- [Documentation](https://docs.koreshield.com)
+- [Issue Tracker](https://github.com/koreshield/koreshield-python-sdk/issues)
+- [Discussions](https://github.com/koreshield/koreshield-python-sdk/discussions)
+- [Email Support](mailto:support@koreshield.com)