enkryptai-sdk 0.1.0__py3-none-any.whl

enkryptai_sdk/__init__.py

@@ -0,0 +1,4 @@
+from .guardrails import GuardrailsClient
+from .guardrails_config import GuardrailsConfig
+
+__all__ = ["GuardrailsClient", "GuardrailsConfig"]

enkryptai_sdk/guardrails.py

@@ -0,0 +1,140 @@
+import requests
+
+class GuardrailsClient:
+    """
+    A client for interacting with Enkrypt AI Guardrails API endpoints.
+    """
+
+    def __init__(self, api_key, base_url="https://api.enkryptai.com"):
+        """
+        Initializes the client.
+
+        Parameters:
+        - api_key (str): Your API key for authenticating with the service.
+        - base_url (str): Base URL of the API (default: "https://api.enkryptai.com").
+        """
+        self.api_key = api_key
+        self.base_url = base_url.rstrip('/')
+        self.session = requests.Session()
+
+    def _request(self, method, endpoint, headers=None, **kwargs):
+        """
+        Internal helper to send an HTTP request.
+
+        Automatically adds the API key to headers.
+        """
+        url = self.base_url + endpoint
+        headers = headers or {}
+        if 'apikey' not in headers:
+            headers['apikey'] = self.api_key
+
+        response = self.session.request(method, url, headers=headers, **kwargs)
+        response.raise_for_status()
+        try:
+            return response.json()
+        except ValueError:
+            return response.text
+
+    # ----------------------------
+    # Basic Guardrails Endpoints
+    # ----------------------------
+
+    def health(self):
+        """
+        Get the health status of the service.
+        """
+        return self._request("GET", "/guardrails/health")
+
+    def status(self):
+        """
+        Check if the API is up and running.
+        """
+        return self._request("GET", "/guardrails/status")
+
+    def models(self):
+        """
+        Retrieve the list of models loaded by the service.
+        """
+        return self._request("GET", "/guardrails/models")
+
+    def detect(self, text, guardrails_config):
+        """
+        Detects prompt injection, toxicity, NSFW content, PII, hallucination, and more.
+
+        Parameters:
+        - text (str): The text to analyze.
+        - guardrails_config (dict or GuardrailsConfig): A configuration for detectors.
+          If a GuardrailsConfig instance is provided, its underlying dictionary will be used.
+
+        Returns:
+        - JSON response from the API.
+        """
+        # Allow passing in either a dict or a GuardrailsConfig instance.
+        if hasattr(guardrails_config, "as_dict"):
+            guardrails_config = guardrails_config.as_dict()
+            
+        payload = {
+            "text": text,
+            "detectors": guardrails_config
+        }
+        return self._request("POST", "/guardrails/detect", json=payload)
+
+    def pii(self, text, mode, key="null"):
+        """
+        Detects Personally Identifiable Information (PII) and can de-anonymize it.
+        """
+        payload = {
+            "text": text,
+            "mode": mode,
+            "key": key
+        }
+        return self._request("POST", "/guardrails/pii", json=payload)
+
+    # ----------------------------
+    # Guardrails Policy Endpoints
+    # ----------------------------
+
+    def add_policy(self, name, description, guardrails_config):
+        """
+        Create a new policy with custom configurations.
+        """
+        payload = {
+            "name": name,
+            "description": description,
+            "detectors": guardrails_config
+        }
+        return self._request("POST", "/guardrails/add-policy", json=payload)
+
+    def get_policy(self, x_enkrypt_policy):
+        """
+        Retrieve an existing policy by providing its header identifier.
+        """
+        headers = {"X-Enkrypt-Policy": x_enkrypt_policy}
+        return self._request("GET", "/guardrails/get-policy", headers=headers)
+
+    def modify_policy(self, x_enkrypt_policy, name, description, guardrails_config):
+        """
+        Modify an existing policy.
+        """
+        headers = {"X-Enkrypt-Policy": x_enkrypt_policy}
+        payload = {
+            "name": name,
+            "description": description,
+            "detectors": guardrails_config
+        }
+        return self._request("PATCH", "/guardrails/modify-policy", headers=headers, json=payload)
+
+    def delete_policy(self, x_enkrypt_policy):
+        """
+        Delete a policy.
+        """
+        headers = {"X-Enkrypt-Policy": x_enkrypt_policy}
+        return self._request("DELETE", "/guardrails/delete-policy", headers=headers)
+
+    def policy_detect(self, x_enkrypt_policy, text):
+        """
+        Apply a specific policy to detect and filter content.
+        """
+        headers = {"X-Enkrypt-Policy": x_enkrypt_policy}
+        payload = {"text": text}
+        return self._request("POST", "/guardrails/policy/detect", headers=headers, json=payload)

enkryptai_sdk/guardrails_config.py

@@ -0,0 +1,70 @@
+import copy
+
+# Base default configuration for all detectors.
+DEFAULT_CONFIG = {
+    "topic_detector": {"enabled": False, "topic": []},
+    "nsfw": {"enabled": False},
+    "toxicity": {"enabled": False},
+    "pii": {"enabled": False, "entities": []},
+    "injection_attack": {"enabled": False},
+    "keyword_detector": {"enabled": False, "banned_keywords": []},
+    "policy_violation": {"enabled": False, "policy_text": "", "need_explanation": False},
+    "bias": {"enabled": False},
+    "copyright_ip": {"enabled": False},
+    "system_prompt": {"enabled": False, "index": "system"}
+}
+
+
+class GuardrailsConfig:
+    """
+    A helper class to manage Guardrails configuration.
+
+    Users can either use preset configurations or build a custom one.
+    """
+
+    def __init__(self, config=None):
+        # Use a deep copy of the default to avoid accidental mutation.
+        self.config = copy.deepcopy(DEFAULT_CONFIG) if config is None else config
+
+    @classmethod
+    def injection_attack(cls):
+        """
+        Returns a configuration instance pre-configured for injection attack detection.
+        """
+        config = copy.deepcopy(DEFAULT_CONFIG)
+        config["topic_detector"] = {"enabled": True, "topic": ["injection attack"]}
+        config["injection_attack"] = {"enabled": True}
+        return cls(config)
+
+    @classmethod
+    def policy_violation(cls, policy_text: str, need_explanation: bool = False):
+        """
+        Returns a configuration instance pre-configured for policy violation detection.
+        """
+        config = copy.deepcopy(DEFAULT_CONFIG)
+        config["policy_violation"] = {"enabled": True, 
+                                      "policy_text": policy_text, 
+                                      "need_explanation": need_explanation
+                                      }
+        return cls(config)
+
+    def update(self, **kwargs):
+        """
+        Update the configuration with custom values.
+        
+        Only keys that exist in the default configuration can be updated.
+        For example:
+            config.update(nsfw={"enabled": True}, toxicity={"enabled": True})
+        """
+        for key, value in kwargs.items():
+            if key in self.config:
+                self.config[key] = value
+            else:
+                raise ValueError(f"Unknown detector config: {key}")
+        return self
+
+    def as_dict(self):
+        """
+        Return the underlying configuration dictionary.
+        """
+        return self.config

enkryptai_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,96 @@
+Metadata-Version: 2.2
+Name: enkryptai-sdk
+Version: 0.1.0
+Summary: A Python SDK with guardrails and red teaming functionality for API interactions
+Home-page: https://github.com/enkryptai/enkryptai-sdk
+Author: Enkrypt AI Team
+Author-email: software@enkryptai.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-python
+Dynamic: summary
+
+# enkryptai-sdk
+
+A Python SDK with guardrails and red teaming functionality for API interactions.
+
+## Installation
+
+```bash
+pip install enkryptai-sdk
+```
+
+## Usage
+
+```python
+from enkryptai_sdk import GuardrailsClient, GuardrailsConfig
+
+client = GuardrailsClient(api_key="your_api_key", base_url="https://api.enkryptai.com")
+
+config = GuardrailsConfig.injection_attack()
+```
+
+## Guardrails Configs
+
+### Injection Attack
+
+```python
+config = GuardrailsConfig.injection_attack()
+```
+
+### Policy Violation
+
+```python
+config = GuardrailsConfig.policy_violation(policy_text="You must be 18 years or older to use this service.")
+```
+
+### Topic Detection
+
+```python
+config = GuardrailsConfig.topic_detection(topic="injection attack")
+```
+
+### Red Teaming
+
+```python
+config = GuardrailsConfig.red_teaming()
+```
+
+## Guardrails Client
+
+```python
+client = GuardrailsClient(api_key="your_api_key")
+
+```
+
+## Detect Attack
+
+```python
+config = GuardrailsConfig.injection_attack()
+response = client.detect(text="Hello, world!", config=config)
+```
+
+## Detect Policy Violation
+
+```python
+config = GuardrailsConfig.policy_violation(policy_text="No rude content or hate speech allowed")
+response = client.detect(text="I hate everyone", config=config)
+```
+
+## Detect Topic Detection
+
+```python
+config = GuardrailsConfig.topic_detection(topic="finance")
+response = client.detect(text="I am buying $1000 of BTC", config=config)
+```
+

enkryptai_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+enkryptai_sdk/__init__.py,sha256=git4pQzKT36zA-wIDz71crkRhp91FFIYrJXehUcnofg,141
+enkryptai_sdk/guardrails.py,sha256=rxUiHPAvdgIjX00XtAY5jPGde-_OEnpmV51jDxAZOSA,4596
+enkryptai_sdk/guardrails_config.py,sha256=oFhCX2hJGVFQfGcaJqji4enc35gK5dTc95uSWungRPE,2487
+enkryptai_sdk/red_team.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+enkryptai_sdk-0.1.0.dist-info/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+enkryptai_sdk-0.1.0.dist-info/METADATA,sha256=4m42h7ENkvXslzPybV0VOQjyybiyVAKFByXelkJTdiA,2077
+enkryptai_sdk-0.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+enkryptai_sdk-0.1.0.dist-info/top_level.txt,sha256=s2X9UJJwvJamNmr6ZXWyyQe60sXtQGWFuaBYfhgHI_4,14
+enkryptai_sdk-0.1.0.dist-info/RECORD,,

enkryptai_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

enkryptai_sdk-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+enkryptai_sdk