enkryptai-sdk 1.0.26__py3-none-any.whl → 1.0.27__py3-none-any.whl

enkryptai_sdk/dto/__init__.py

@@ -97,6 +97,7 @@ __all__ = [
     "GuardrailsListPoliciesResponse",
     "GuardrailsPolicyAtomizerRequest",
     "GuardrailsPolicyAtomizerResponse",
+    "GuardrailsScanPdfResponse",
     "CoCPolicyRequest",
     "CoCPolicyData",
     "CoCPolicyResponse",

enkryptai_sdk/dto/guardrails.py

@@ -1751,3 +1751,79 @@ class GuardrailsScanUrlResponse(BaseDTO):
             
         return f"URL Scan Result for {self.url}\nStatus: {status}\n{violation_str}"
 
+
+# -------------------------------------
+# Guardrails Scan PDF
+# -------------------------------------
+
+
+@dataclass
+class ScanPdfDetails(BaseDTO):
+    total_pages: int = 0
+    pages_with_detections: int = 0
+    detections: List[Dict[str, Any]] = field(default_factory=list)
+    _extra_fields: Dict[str, Any] = field(default_factory=dict)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "ScanPdfDetails":
+        return cls(
+            total_pages=data.get("total_pages", 0),
+            pages_with_detections=data.get("pages_with_detections", 0),
+            detections=data.get("detections", [])
+        )
+
+    def to_dict(self) -> Dict[str, Any]:
+        result = {
+            "total_pages": self.total_pages,
+            "pages_with_detections": self.pages_with_detections,
+            "detections": self.detections
+        }
+        result.update(self._extra_fields)
+        return result
+
+
+@dataclass
+class GuardrailsScanPdfResponse(BaseDTO):
+    summary: Dict[str, int] = field(default_factory=dict)
+    details: ScanPdfDetails = field(default_factory=ScanPdfDetails)
+    _extra_fields: Dict[str, Any] = field(default_factory=dict)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "GuardrailsScanPdfResponse":
+        return cls(
+            summary=data.get("summary", {}),
+            details=ScanPdfDetails.from_dict(data.get("details", {}))
+        )
+
+    def to_dict(self) -> Dict[str, Any]:
+        result = {
+            "summary": self.summary,
+            "details": self.details.to_dict()
+        }
+        result.update(self._extra_fields)
+        return result
+
+    def has_detections(self) -> bool:
+        return self.details.pages_with_detections > 0 or len(self.details.detections) > 0
+
+    def is_safe(self) -> bool:
+        return not self.has_detections()
+
+    def is_attack(self) -> bool:
+        return self.has_detections()
+
+    def __str__(self) -> str:
+        status = "UNSAFE" if self.has_detections() else "SAFE"
+        flagged = [k for k, v in self.summary.items() if v > 0]
+        if flagged:
+            detection_str = f"Detections: {', '.join(flagged)}"
+        else:
+            detection_str = "No detections"
+        return (
+            f"PDF Scan Result\n"
+            f"Status: {status}\n"
+            f"Total Pages: {self.details.total_pages}\n"
+            f"Pages With Detections: {self.details.pages_with_detections}\n"
+            f"{detection_str}"
+        )
+

enkryptai_sdk/guardrails.py

@@ -31,7 +31,8 @@ from .dto import (
     GuardrailsListPoliciesResponse,
     GuardrailsPolicyAtomizerRequest,
     GuardrailsPolicyAtomizerResponse,
-    GuardrailsScanUrlResponse
+    GuardrailsScanUrlResponse,
+    GuardrailsScanPdfResponse
 )
 
 # ---------------------------------------
@@ -292,16 +293,20 @@ class GuardrailsClient(BaseClient):
 
     def scan_url(self, url, config=None):
         """
-        Scan a URL for security threats including injection attacks and policy violations.
+        Scan a URL for security threats using any combination of available detectors.
+
+        Supports all detectors available in the detect endpoint, including:
+        injection_attack, policy_violation, toxicity, nsfw, pii, bias,
+        keyword_detector, copyright_ip, system_prompt, sponge_attack, topic_detector.
 
         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.
+          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.
+        - GuardrailsScanUrlResponse: Response from the API containing scan results.
         """
         # Use default config if none provided
         if config is None:
@@ -358,6 +363,75 @@ class GuardrailsClient(BaseClient):
         except Exception as e:
             raise GuardrailsClientError(str(e))
 
+    def scan_pdf(self, file, config=None):
+        """
+        Scan a PDF for security threats using any combination of available detectors.
+
+        Supports all detectors available in the detect endpoint, including:
+        injection_attack, policy_violation, toxicity, nsfw, pii, bias,
+        keyword_detector, copyright_ip, system_prompt, sponge_attack, topic_detector.
+
+        Parameters:
+        - file (str): Base64-encoded PDF string.
+        - 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:
+        - GuardrailsScanPdfResponse: Response from the API containing scan results.
+        """
+        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
+                }
+            }
+
+        if hasattr(config, "as_dict"):
+            config = config.as_dict()
+        if hasattr(config, "to_dict"):
+            config = config.to_dict()
+
+        payload = {
+            "file": file,
+            "detectors": config
+        }
+
+        try:
+            response = self._request("POST", "/guardrails/scan-pdf", json=payload)
+            if response.get("error"):
+                raise GuardrailsClientError(f"API Error: {str(response)}")
+            return GuardrailsScanPdfResponse.from_dict(response)
+        except Exception as e:
+            raise GuardrailsClientError(str(e))
+
+    def policy_scan_pdf(self, policy_name, file):
+        """
+        Apply a specific policy to scan a PDF for security threats.
+
+        Parameters:
+        - policy_name (str): Name of the policy to apply.
+        - file (str): Base64-encoded PDF string.
+
+        Returns:
+        - GuardrailsScanPdfResponse: Response from the API containing scan results.
+        """
+        headers = {"X-Enkrypt-Policy": policy_name}
+        payload = {"file": file}
+
+        try:
+            response = self._request("POST", "/guardrails/policy/scan-pdf", headers=headers, json=payload)
+            if response.get("error"):
+                raise GuardrailsClientError(f"API Error: {str(response)}")
+            return GuardrailsScanPdfResponse.from_dict(response)
+        except Exception as e:
+            raise GuardrailsClientError(str(e))
+
     # ----------------------------
     # Guardrails Policy Endpoints
     # ----------------------------

{enkryptai_sdk-1.0.26.dist-info → enkryptai_sdk-1.0.27.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: enkryptai-sdk
-Version: 1.0.26
+Version: 1.0.27
 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

{enkryptai_sdk-1.0.26.dist-info → enkryptai_sdk-1.0.27.dist-info}/RECORD

@@ -6,25 +6,25 @@ 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=iEngSpkzZBB3EkJGxUxUgYF0Av4N2XWMN-BlAkRDle4,19856
+enkryptai_sdk/guardrails.py,sha256=9lcc2PYH6PD3xvZ_SxQe4xU8WL2tXIfz1lLy0tLhsA0,22813
 enkryptai_sdk/guardrails_old.py,sha256=SgzPZkTzbAPD9XfmYNG6M1-TrzbhDHpAkI3FjnVWS_s,6434
 enkryptai_sdk/models.py,sha256=0R0I4KOq0aDNi5utabANot-E8dT9GqiSsgrcI9RULHM,8932
 enkryptai_sdk/red_team.py,sha256=3Fi2VE3slBEKU0_LCadMQm1Pm1Kp4Jx-MrwohqrqntM,28058
 enkryptai_sdk/response.py,sha256=2WOyejMYK7lA7I3fyebd0oYhP4js5Q1favJAV_h9pmo,13604
-enkryptai_sdk/dto/__init__.py,sha256=hBN523YIkuHCvLTrkPu9ipGwAyLDnhV9sb3rKNpRajg,3061
+enkryptai_sdk/dto/__init__.py,sha256=tv3VxFetFGVR0vDE2oybh38qBDkAmvo4-FXXG_RkScY,3094
 enkryptai_sdk/dto/ai_proxy.py,sha256=clwMN4xdH8Zr55dnhilHbs-qaHRlCOrLPrij0Zd1Av0,11283
 enkryptai_sdk/dto/base.py,sha256=y77kQL1X7389ifSVNc0E7CUFNxACh5AM3ml9YPon1KY,2822
 enkryptai_sdk/dto/coc.py,sha256=9D5mmSdmC_guV75ml48PPLZD_zFa5FjxRwlTqHrmdak,5071
 enkryptai_sdk/dto/common.py,sha256=lrWMu4FKUGCN2dbS9fT4yNtfiPm1cNN16J4eCe4_tBM,1812
 enkryptai_sdk/dto/datasets.py,sha256=Ux72S2BoZ28-SpNA2C7P23W_wag6cvGvXvXeVHedvzk,7138
 enkryptai_sdk/dto/deployments.py,sha256=v--UrwkuXP4xTsPbmVruYj-g3JEQXepBRQfr-Gsv3aA,11744
-enkryptai_sdk/dto/guardrails.py,sha256=n73uPmK9fCIqqxv1rNecYUX4v5ePdIjxSBD4jIhwDe8,55966
+enkryptai_sdk/dto/guardrails.py,sha256=_FWZ0AJOqw8tD75oajbv1FYyIrzJUN11dlMnb3X9sBE,58415
 enkryptai_sdk/dto/models.py,sha256=Dj9VBG7tWnNqnjyX2KMJXIlst-9Obzb_AtvbQiklizA,16632
 enkryptai_sdk/dto/red_team.py,sha256=_VR_L1fj4t0sKISaEoGxqUW3vA0lRAVMQejeFaQ70ho,40200
 enkryptai_sdk/utils/__init__.py,sha256=SII0dz9SesrXt2zOR1xXErPYZGj3WyC9A9Pn_eOLsOg,710
 enkryptai_sdk/utils/pagination.py,sha256=5t9qiDdxRA4uQywU4I4pp9OScqNBrEPmzKlPG-b-eVE,11149
-enkryptai_sdk-1.0.26.dist-info/licenses/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-enkryptai_sdk-1.0.26.dist-info/METADATA,sha256=PTXLUL8KlDWw6uFL6-PCEMGNyK8rd5rp31LFJevFovY,1644
-enkryptai_sdk-1.0.26.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-enkryptai_sdk-1.0.26.dist-info/top_level.txt,sha256=s2X9UJJwvJamNmr6ZXWyyQe60sXtQGWFuaBYfhgHI_4,14
-enkryptai_sdk-1.0.26.dist-info/RECORD,,
+enkryptai_sdk-1.0.27.dist-info/licenses/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+enkryptai_sdk-1.0.27.dist-info/METADATA,sha256=h8lXBiColUVvV1G6KYxx8sNmxbjXYTBk-Xg-UX0rH8o,1644
+enkryptai_sdk-1.0.27.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+enkryptai_sdk-1.0.27.dist-info/top_level.txt,sha256=s2X9UJJwvJamNmr6ZXWyyQe60sXtQGWFuaBYfhgHI_4,14
+enkryptai_sdk-1.0.27.dist-info/RECORD,,

{enkryptai_sdk-1.0.26.dist-info → enkryptai_sdk-1.0.27.dist-info}/WHEEL

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