enkryptai-sdk 1.0.19__py3-none-any.whl → 1.0.22__py3-none-any.whl

enkryptai_sdk/dto/guardrails.py

@@ -1625,4 +1625,117 @@ class GuardrailsPolicyAtomizerResponse(BaseDTO):
             f"Total Rules: {self.total_rules}\n"
             f"Message: {self.message}"
         )
+
+
+@dataclass
+class GuardrailsViolation(BaseDTO):
+    unsafe_content: str
+    chunk_type: str
+    triggered_detectors: List[str]
+    guardrails_result: Dict[str, Any]
+    _extra_fields: Dict[str, Any] = field(default_factory=dict)
+    
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "GuardrailsViolation":
+        return cls(
+            unsafe_content=data.get("unsafe_content", ""),
+            chunk_type=data.get("chunk_type", ""),
+            triggered_detectors=data.get("triggered_detectors", []),
+            guardrails_result=data.get("guardrails_result", {})
+        )
     
+    def to_dict(self) -> Dict[str, Any]:
+        result = {
+            "unsafe_content": self.unsafe_content,
+            "chunk_type": self.chunk_type,
+            "triggered_detectors": self.triggered_detectors,
+            "guardrails_result": self.guardrails_result
+        }
+        result.update(self._extra_fields)
+        return result
+
+
+@dataclass
+class GuardrailsScanUrlResponse(BaseDTO):
+    url: str
+    violations: List[GuardrailsViolation]
+    combined_highlight_url: str
+    _extra_fields: Dict[str, Any] = field(default_factory=dict)
+    
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "GuardrailsScanUrlResponse":
+        violations_data = data.get("violations", [])
+        violations = [GuardrailsViolation.from_dict(violation) for violation in violations_data]
+        
+        return cls(
+            url=data.get("url", ""),
+            violations=violations,
+            combined_highlight_url=data.get("combined_highlight_url", "")
+        )
+    
+    def to_dict(self) -> Dict[str, Any]:
+        result = {
+            "url": self.url,
+            "violations": [violation.to_dict() for violation in self.violations],
+            "combined_highlight_url": self.combined_highlight_url
+        }
+        result.update(self._extra_fields)
+        return result
+
+    def has_violations(self) -> bool:
+        """
+        Check if any detectors found violations in the URL content.
+        
+        Returns:
+            bool: True if any violations were detected, False otherwise
+        """
+        return len(self.violations) > 0
+    
+    def get_violations(self) -> List[str]:
+        """
+        Get a list of detector names that found violations.
+        
+        Returns:
+            List[str]: Names of detectors that reported violations
+        """
+        triggered_detectors = []
+        for violation in self.violations:
+            triggered_detectors.extend(violation.triggered_detectors)
+        # Remove duplicates while preserving order
+        return list(dict.fromkeys(triggered_detectors))
+
+    def is_safe(self) -> bool:
+        """
+        Check if the URL content is safe (no violations detected).
+        
+        Returns:
+            bool: True if no violations were detected, False otherwise
+        """
+        return not self.has_violations()
+    
+    def is_attack(self) -> bool:
+        """
+        Check if the URL content is attacked (violations detected).
+        
+        Returns:
+            bool: True if violations were detected, False otherwise
+        """
+        return self.has_violations()
+    
+    def __str__(self) -> str:
+        """
+        String representation of the response.
+        
+        Returns:
+            str: A formatted string showing URL, violations and status
+        """
+        violations = self.get_violations()
+        status = "UNSAFE" if violations else "SAFE"
+        
+        if violations:
+            violation_str = f"Violations detected: {', '.join(violations)}"
+        else:
+            violation_str = "No violations detected"
+            
+        return f"URL Scan Result for {self.url}\nStatus: {status}\n{violation_str}"
+

enkryptai_sdk/dto/red_team.py

@@ -422,6 +422,7 @@ class RedTeamTestConfigurations(BaseDTO):
     reliability_and_observability_test: TestConfig = field(default=None)
     agent_behaviour_test: TestConfig = field(default=None)
     access_control_and_permissions_test: TestConfig = field(default=None)
+    tool_extraction_test: TestConfig = field(default=None)
     _extra_fields: Dict[str, Any] = field(default_factory=dict)
 
     @classmethod
@@ -799,6 +800,50 @@ class RedTeamRiskMitigationSystemPromptResponse(BaseDTO):
             "message": self.message,
         }
 
+@dataclass
+class RedTeamKeyFinding(BaseDTO):
+    text: str
+    _extra_fields: Dict[str, Any] = field(default_factory=dict)
+    
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "RedTeamKeyFinding":
+        return cls(
+            text=data.get("text", "")
+        )
+    
+    def to_dict(self) -> Dict[str, Any]:
+        result = {
+            "text": self.text
+        }
+        result.update(self._extra_fields)
+        return result
+
+
+@dataclass
+class RedTeamFindingsResponse(BaseDTO):
+    key_findings: List[RedTeamKeyFinding] = field(default_factory=list)
+    message: str = ""
+    _extra_fields: Dict[str, Any] = field(default_factory=dict)
+    
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "RedTeamFindingsResponse":
+        key_findings_data = data.get("key_findings", [])
+        key_findings = [RedTeamKeyFinding.from_dict(finding) for finding in key_findings_data]
+        
+        return cls(
+            key_findings=key_findings,
+            message=data.get("message", "")
+        )
+    
+    def to_dict(self) -> Dict[str, Any]:
+        result = {
+            "key_findings": [finding.to_dict() for finding in self.key_findings],
+            "message": self.message
+        }
+        result.update(self._extra_fields)
+        return result
+
+
 
 # Default configurations
 DEFAULT_REDTEAM_CONFIG = RedTeamConfig()

enkryptai_sdk/guardrails.py

@@ -31,6 +31,7 @@ from .dto import (
     GuardrailsListPoliciesResponse,
     GuardrailsPolicyAtomizerRequest,
     GuardrailsPolicyAtomizerResponse,
+    GuardrailsScanUrlResponse
 )
 
 # ---------------------------------------
@@ -195,6 +196,28 @@ class GuardrailsClient(BaseClient):
             return GuardrailsBatchDetectResponse.from_dict(response)
         except Exception as e:
             raise GuardrailsClientError(str(e))
+        
+    def policy_batch_detect(self, policy_name, texts):
+        """
+        Apply a specific policy to detect and filter content in multiple texts.
+        
+        Parameters:
+        - policy_name (str): Name of the policy to apply
+        - texts (list): A list of texts to analyze
+        
+        Returns:
+        - GuardrailsBatchDetectResponse: Response from the API containing batch detection results
+        """
+        headers = {"X-Enkrypt-Policy": policy_name}
+        payload = {"texts": texts}
+
+        try:
+            response = self._request("POST", "/guardrails/policy/batch/detect", headers=headers, json=payload)
+            if isinstance(response, dict) and response.get("error"):
+                raise GuardrailsClientError(f"API Error: {str(response)}")
+            return GuardrailsBatchDetectResponse.from_dict(response)
+        except Exception as e:
+            raise GuardrailsClientError(str(e))
     
     def pii(self, text, mode="request", key="null", entities=None):
         """
@@ -267,6 +290,74 @@ class GuardrailsClient(BaseClient):
         except Exception as e:
             raise GuardrailsClientError(str(e))
 
+    def scan_url(self, url, config=None):
+        """
+        Scan a URL for security threats including injection attacks and policy violations.
+
+        Parameters:
+        - url (str): The URL to scan and analyze.
+        - config (dict or GuardrailsConfig, optional): A configuration for detectors.
+        If a GuardrailsConfig instance is provided, its underlying dictionary will be used.
+        If not provided, defaults to injection attack and policy violation detection.
+
+        Returns:
+        - Response from the API.
+        """
+        # Use default config if none provided
+        if config is None:
+            config = {
+                "injection_attack": {
+                    "enabled": True
+                },
+                "policy_violation": {
+                    "enabled": True,
+                    "policy_text": "Detect any malicious text or injection attacks",
+                    "need_explanation": True
+                }
+            }
+
+        # Allow passing in either a dict or a GuardrailsConfig or GuardrailDetectors instance
+        if hasattr(config, "as_dict"):
+            config = config.as_dict()
+        if hasattr(config, "to_dict"):
+            config = config.to_dict()
+            
+        payload = {
+            "url": url,
+            "detectors": config
+        }
+
+        try:
+            response = self._request("POST", "/guardrails/scan-url", json=payload)
+            if response.get("error"):
+                raise GuardrailsClientError(f"API Error: {str(response)}")
+            return GuardrailsScanUrlResponse.from_dict(response)
+        except Exception as e:
+            raise GuardrailsClientError(str(e))
+
+        
+    def policy_scan_url(self, policy_name, url):
+        """
+        Apply a specific policy to scan a URL for security threats.
+        
+        Parameters:
+        - policy_name (str): Name of the policy to apply
+        - url (str): The URL to scan and analyze
+        
+        Returns:
+        - GuardrailsScanUrlResponse: Response from the API containing scan results
+        """
+        headers = {"X-Enkrypt-Policy": policy_name}
+        payload = {"url": url}
+
+        try:
+            response = self._request("POST", "/guardrails/policy/scan-url", headers=headers, json=payload)
+            if response.get("error"):
+                raise GuardrailsClientError(f"API Error: {str(response)}")
+            return GuardrailsScanUrlResponse.from_dict(response)
+        except Exception as e:
+            raise GuardrailsClientError(str(e))
+
     # ----------------------------
     # Guardrails Policy Endpoints
     # ----------------------------

enkryptai_sdk/red_team.py

@@ -21,6 +21,7 @@ from .dto import (
     RedTeamRiskMitigationGuardrailsPolicyResponse,
     RedTeamRiskMitigationSystemPromptConfig,
     RedTeamRiskMitigationSystemPromptResponse,
+    RedTeamFindingsResponse
 )
 
 
@@ -537,3 +538,30 @@ class RedTeamClient(BaseClient):
         if isinstance(response, dict) and response.get("error"):
             raise RedTeamClientError(f"API Error: {str(response)}")
         return RedTeamRiskMitigationSystemPromptResponse.from_dict(response)
+
+    def get_findings(self, redteam_summary):
+        """
+        Get findings and insights based on red team summary data.
+        
+        Parameters:
+        - redteam_summary (dict or ResultSummary): Red team test summary data
+        
+        Returns:
+        - RedTeamFindingsResponse: Response from the API containing findings
+        """
+        # Allow passing in either a dict or a ResultSummary instance
+        if hasattr(redteam_summary, "to_dict"):
+            redteam_summary = redteam_summary.to_dict()
+            
+        payload = {
+            "redteam_summary": redteam_summary
+        }
+
+        try:
+            response = self._request("POST", "/redteam/findings", json=payload)
+            if response.get("error"):
+                raise RedTeamClientError(f"API Error: {str(response)}")
+            return RedTeamFindingsResponse.from_dict(response)
+        except Exception as e:
+            raise RedTeamClientError(str(e))
+        

enkryptai_sdk-1.0.22.dist-info/METADATA

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: enkryptai-sdk
+Version: 1.0.22
+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: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+# Enkrypt AI Python SDK
+
+![Python SDK test](https://github.com/enkryptai/enkryptai-sdk/actions/workflows/test.yaml/badge.svg)
+
+A Python SDK with Guardrails, Code of Conduct Policies, Endpoints (Models), Deployments, AI Proxy, Datasets, Red Team, etc. functionality for API interactions.
+
+**See documentation at [https://docs.enkryptai.com/libraries/python/introduction](https://docs.enkryptai.com/libraries/python/introduction)**
+
+See [https://pypi.org/project/enkryptai-sdk](https://pypi.org/project/enkryptai-sdk)
+
+## Copyright, License and Terms of Use
+
+© 2025 Enkrypt AI. All rights reserved.
+
+Enkrypt AI software is provided under a proprietary license. Unauthorized use, reproduction, or distribution of this software or any portion of it is strictly prohibited.
+
+Terms of Use: [https://www.enkryptai.com/terms-and-conditions](https://www.enkryptai.com/terms-and-conditions)
+
+Enkrypt AI and the Enkrypt AI logo are trademarks of Enkrypt AI, Inc.

{enkryptai_sdk-1.0.19.dist-info → enkryptai_sdk-1.0.22.dist-info}/RECORD

@@ -6,10 +6,10 @@ enkryptai_sdk/config.py,sha256=zUlWFr33JVz_kzUl3JalXeq-s1q0Qvyi4HBrGk0CTBU,9402
 enkryptai_sdk/datasets.py,sha256=RQIR6spI2STXeVolYzBt6gPv6PD5AGh9krs16aKWdWA,6067
 enkryptai_sdk/deployments.py,sha256=A7XZ2JwrMod9V4_aV8bFY_Soh9E3jHdwaTuJ9BwXuyk,4215
 enkryptai_sdk/evals.py,sha256=BywyEgIT7xdJ58svO_sDNOMVowdB0RTGoAZPEbCnDVo,2595
-enkryptai_sdk/guardrails.py,sha256=NluimOA0gM9N3S_q47LTUeG97t9PlYqPHlZahDPkJvI,16365
+enkryptai_sdk/guardrails.py,sha256=iEngSpkzZBB3EkJGxUxUgYF0Av4N2XWMN-BlAkRDle4,19856
 enkryptai_sdk/guardrails_old.py,sha256=SgzPZkTzbAPD9XfmYNG6M1-TrzbhDHpAkI3FjnVWS_s,6434
 enkryptai_sdk/models.py,sha256=0R0I4KOq0aDNi5utabANot-E8dT9GqiSsgrcI9RULHM,8932
-enkryptai_sdk/red_team.py,sha256=7bWNognd6TCzNQDocml-C_f6u5z1MeursSe3Rtz16Sw,19929
+enkryptai_sdk/red_team.py,sha256=w52gPteGaH6iEBThjIYxLAV1bXXTorgxST_TOnGMT88,20917
 enkryptai_sdk/response.py,sha256=43JRubzgGCpoVxYNzBZY0AlUgLbfcXD_AwD7wU3qY9o,4086
 enkryptai_sdk/dto/__init__.py,sha256=wHgIv_OCnVMJOys-vqImF59ifogDrMcgxVRmfNayVvc,2761
 enkryptai_sdk/dto/ai_proxy.py,sha256=clwMN4xdH8Zr55dnhilHbs-qaHRlCOrLPrij0Zd1Av0,11283
@@ -18,11 +18,11 @@ enkryptai_sdk/dto/coc.py,sha256=Lp2aat_24J4KuUg4BeJl9S39tEak8Bw15eJ4cQDrRQk,4749
 enkryptai_sdk/dto/common.py,sha256=lrWMu4FKUGCN2dbS9fT4yNtfiPm1cNN16J4eCe4_tBM,1812
 enkryptai_sdk/dto/datasets.py,sha256=RFA9CmbhD-QDDyweBq_k9iBd00b6I6SWmdP9DPNd9fc,5002
 enkryptai_sdk/dto/deployments.py,sha256=_tdSyRTJvthjLTbOxFO4f2P6vgirDsF3in5_gXE3a_U,11288
-enkryptai_sdk/dto/guardrails.py,sha256=NUVz59c-lnlTOwg72QIk62-USfHO-dpS5u2Hr6q9QGA,51774
+enkryptai_sdk/dto/guardrails.py,sha256=cfL18qfDtNXG4SONCVONHYAKS9J3m0EAqUdTeeUoZK8,55510
 enkryptai_sdk/dto/models.py,sha256=4aeI9-iHPhSX5duRMTQRbkXhplAhN8OHw3gWdTxrafU,14531
-enkryptai_sdk/dto/red_team.py,sha256=VoNQVte__bXf2-wXgTDMEk--7KSvQm7ZR45WXPPneHU,27324
-enkryptai_sdk-1.0.19.dist-info/licenses/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-enkryptai_sdk-1.0.19.dist-info/METADATA,sha256=mtGop_UEL2riS3hMqfD3NOcIorcb5pOyqC0jddvVwFE,73153
-enkryptai_sdk-1.0.19.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-enkryptai_sdk-1.0.19.dist-info/top_level.txt,sha256=s2X9UJJwvJamNmr6ZXWyyQe60sXtQGWFuaBYfhgHI_4,14
-enkryptai_sdk-1.0.19.dist-info/RECORD,,
+enkryptai_sdk/dto/red_team.py,sha256=KRR_gDBTrrN6VEiSLaXDIqciY7N7OelIAQNmzCAsZgU,28675
+enkryptai_sdk-1.0.22.dist-info/licenses/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+enkryptai_sdk-1.0.22.dist-info/METADATA,sha256=EDFqSS5spOBzcyNAgtqm8DnUeGE7AtxXRsDEIdHWZTw,1644
+enkryptai_sdk-1.0.22.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+enkryptai_sdk-1.0.22.dist-info/top_level.txt,sha256=s2X9UJJwvJamNmr6ZXWyyQe60sXtQGWFuaBYfhgHI_4,14
+enkryptai_sdk-1.0.22.dist-info/RECORD,,