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

enkryptai_sdk/config.py

@@ -16,6 +16,7 @@ DEFAULT_GUARDRAILS_CONFIG = {
     "bias": {"enabled": False},
     "copyright_ip": {"enabled": False},
     "system_prompt": {"enabled": False, "index": "system"},
+    "sponge_attack": {"enabled": False},
 }
 
 
@@ -151,6 +152,15 @@ class GuardrailsConfig:
         config = copy.deepcopy(DEFAULT_GUARDRAILS_CONFIG)
         config["system_prompt"] = {"enabled": True, "index": index}
         return cls(config)
+    
+    @classmethod
+    def sponge_attack(cls):
+        """
+        Returns a configuration instance pre-configured for sponge attack detection.
+        """
+        config = copy.deepcopy(DEFAULT_GUARDRAILS_CONFIG)
+        config["sponge_attack"] = {"enabled": True}
+        return cls(config)
 
     def update(self, **kwargs):
         """

enkryptai_sdk/dto/common.py

@@ -0,0 +1,64 @@
+# To avoid circular imports
+from enum import Enum
+from .base import BaseDTO
+from typing import Dict, List, Optional, Any
+from dataclasses import dataclass, field, asdict
+
+
+class ModelAuthTypeEnum(str, Enum):
+    APIKEY = "apikey"
+    JWT = "jwt"
+
+
+class ModelJwtMethodEnum(str, Enum):
+    POST = "POST"
+    GET = "GET"
+
+
+@dataclass
+class CustomHeader(BaseDTO):
+    key: str
+    value: str
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "CustomHeader":
+        return cls(
+            key=data.get("key", ""),
+            value=data.get("value", "")
+        )
+
+    def to_dict(self) -> Dict[str, Any]:
+        return {
+            "key": self.key,
+            "value": self.value
+        }
+
+
+@dataclass
+class ModelJwtConfig(BaseDTO):
+    jwt_method: ModelJwtMethodEnum = ModelJwtMethodEnum.POST
+    jwt_url: str = ""
+    jwt_headers: List[CustomHeader] = field(default_factory=list)
+    jwt_body: str = ""
+    jwt_response_key: str = ""
+    _extra_fields: Dict[str, Any] = field(default_factory=dict)
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "ModelJwtConfig":
+        return cls(
+            jwt_method=ModelJwtMethodEnum(data.get("jwt_method", ModelJwtMethodEnum.POST)),
+            jwt_url=data.get("jwt_url", ""),
+            jwt_headers=[CustomHeader.from_dict(header) for header in data.get("jwt_headers", [])],
+            jwt_body=data.get("jwt_body", ""),
+            jwt_response_key=data.get("jwt_response_key", ""),
+        )
+    
+    def to_dict(self) -> Dict[str, Any]:
+        return {
+            "jwt_method": self.jwt_method.value,
+            "jwt_url": self.jwt_url,
+            "jwt_headers": [header.to_dict() for header in self.jwt_headers],
+            "jwt_body": self.jwt_body,
+            "jwt_response_key": self.jwt_response_key,
+        }
+

enkryptai_sdk/dto/deployments.py

@@ -15,6 +15,7 @@ class InputGuardrailBlockType(str, Enum):
     BIAS = "bias"
     SYSTEM_PROMPT = "system_prompt"
     COPYRIGHT_IP = "copyright_ip"
+    SPONGE_ATTACK = "sponge_attack"
 
 
 class OutputGuardrailBlockType(str, Enum):
@@ -28,6 +29,7 @@ class OutputGuardrailBlockType(str, Enum):
     BIAS = "bias"
     SYSTEM_PROMPT = "system_prompt"
     COPYRIGHT_IP = "copyright_ip"
+    SPONGE_ATTACK = "sponge_attack"
     HALLUCINATION = "hallucination"
     ADHERENCE = "adherence"
     RELEVANCY = "relevancy"

enkryptai_sdk/dto/guardrails.py

@@ -243,6 +243,23 @@ class SystemPromptDetector(BaseDTO):
         }
 
 
+@dataclass
+class SpongeAttackDetector(BaseDTO):
+    enabled: bool = False
+    _extra_fields: Dict[str, Any] = field(default_factory=dict)
+    
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "SpongeAttackDetector":
+        return cls(
+            enabled=data.get("enabled", False)
+        )
+    
+    def to_dict(self) -> Dict[str, Any]:
+        return {
+            "enabled": self.enabled
+        }
+
+
 class GuardrailDetectorsEnum(str, Enum):
     TOPIC_DETECTOR = "topic_detector"
     NSFW = "nsfw"
@@ -254,6 +271,7 @@ class GuardrailDetectorsEnum(str, Enum):
     BIAS = "bias"
     COPYRIGHT_IP = "copyright_ip"
     SYSTEM_PROMPT = "system_prompt"
+    SPONGE_ATTACK = "sponge_attack"
 
 
 @dataclass
@@ -268,6 +286,7 @@ class GuardrailDetectors(BaseDTO):
     bias: BiasDetector = field(default_factory=BiasDetector)
     copyright_ip: CopyrightIPDetector = field(default_factory=CopyrightIPDetector)
     system_prompt: SystemPromptDetector = field(default_factory=SystemPromptDetector)
+    sponge_attack: SpongeAttackDetector = field(default_factory=SpongeAttackDetector)
     _extra_fields: Dict[str, Any] = field(default_factory=dict)
     
     @classmethod
@@ -282,7 +301,8 @@ class GuardrailDetectors(BaseDTO):
             policy_violation=PolicyViolationDetector.from_dict(data.get("policy_violation", {})),
             bias=BiasDetector.from_dict(data.get("bias", {})),
             copyright_ip=CopyrightIPDetector.from_dict(data.get("copyright_ip", {})),
-            system_prompt=SystemPromptDetector.from_dict(data.get("system_prompt", {}))
+            system_prompt=SystemPromptDetector.from_dict(data.get("system_prompt", {})),
+            sponge_attack=SpongeAttackDetector.from_dict(data.get("sponge_attack", {}))
         )
     
     def to_dict(self) -> Dict[str, Any]:
@@ -296,7 +316,8 @@ class GuardrailDetectors(BaseDTO):
             "policy_violation": self.policy_violation.to_dict(),
             "bias": self.bias.to_dict(),
             "copyright_ip": self.copyright_ip.to_dict(),
-            "system_prompt": self.system_prompt.to_dict()
+            "system_prompt": self.system_prompt.to_dict(),
+            "sponge_attack": self.sponge_attack.to_dict()
         }
 
 
@@ -608,6 +629,25 @@ class SystemPromptDetail(BaseDTO):
         return result
 
 
+@dataclass
+class SpongeAttackDetail(BaseDTO):
+    sponge_attack_detected: bool = False
+    _extra_fields: Dict[str, Any] = field(default_factory=dict)
+    
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "SpongeAttackDetail":
+        return cls(
+            sponge_attack_detected=data.get("sponge_attack_detected", False)
+        )
+    
+    def to_dict(self) -> Dict[str, Any]:
+        result = {
+            "sponge_attack_detected": self.sponge_attack_detected
+        }
+        result.update(self._extra_fields)
+        return result
+
+
 @dataclass
 class DetectResponseSummary(BaseDTO):
     on_topic: int = 0
@@ -620,6 +660,7 @@ class DetectResponseSummary(BaseDTO):
     bias: int = 0
     copyright_ip_similarity: int = 0
     system_prompt_similarity: int = 0
+    sponge_attack: int = 0
     _extra_fields: Dict[str, Any] = field(default_factory=dict)
     
     @classmethod
@@ -634,7 +675,8 @@ class DetectResponseSummary(BaseDTO):
             policy_violation=data.get("policy_violation", 0),
             bias=data.get("bias", 0),
             copyright_ip_similarity=data.get("copyright_ip_similarity", 0),
-            system_prompt_similarity=data.get("system_prompt_similarity", 0)
+            system_prompt_similarity=data.get("system_prompt_similarity", 0),
+            sponge_attack=data.get("sponge_attack", 0)
         )
     
     def to_dict(self) -> Dict[str, Any]:
@@ -648,7 +690,8 @@ class DetectResponseSummary(BaseDTO):
             "policy_violation": self.policy_violation,
             "bias": self.bias,
             "copyright_ip_similarity": self.copyright_ip_similarity,
-            "system_prompt_similarity": self.system_prompt_similarity
+            "system_prompt_similarity": self.system_prompt_similarity,
+            "sponge_attack": self.sponge_attack
         }
         result.update(self._extra_fields)
         return result
@@ -666,6 +709,7 @@ class DetectResponseDetails(BaseDTO):
     bias: BiasDetail = field(default_factory=BiasDetail)
     copyright_ip: CopyrightIPDetail = field(default_factory=CopyrightIPDetail)
     system_prompt: SystemPromptDetail = field(default_factory=SystemPromptDetail)
+    sponge_attack: SpongeAttackDetail = field(default_factory=SpongeAttackDetail)
     _extra_fields: Dict[str, Any] = field(default_factory=dict)
     
     @classmethod
@@ -680,7 +724,8 @@ class DetectResponseDetails(BaseDTO):
             policy_violation=PolicyViolationDetail.from_dict(data.get("policy_violation", {})),
             bias=BiasDetail.from_dict(data.get("bias", {})),
             copyright_ip=CopyrightIPDetail.from_dict(data.get("copyright_ip", {})),
-            system_prompt=SystemPromptDetail.from_dict(data.get("system_prompt", {}))
+            system_prompt=SystemPromptDetail.from_dict(data.get("system_prompt", {})),
+            sponge_attack=SpongeAttackDetail.from_dict(data.get("sponge_attack", {}))
         )
     
     def to_dict(self) -> Dict[str, Any]:
@@ -694,7 +739,8 @@ class DetectResponseDetails(BaseDTO):
             "policy_violation": self.policy_violation.to_dict(),
             "bias": self.bias.to_dict(),
             "copyright_ip": self.copyright_ip.to_dict(),
-            "system_prompt": self.system_prompt.to_dict()
+            "system_prompt": self.system_prompt.to_dict(),
+            "sponge_attack": self.sponge_attack.to_dict()
         }
         result.update(self._extra_fields)
         return result

enkryptai_sdk/dto/models.py

@@ -5,7 +5,7 @@ from .base import BaseDTO
 from tabulate import tabulate
 from dataclasses import dataclass, field, asdict
 from typing import Optional, List, Set, Dict, Any
-from .red_team import ModelAuthTypeEnum, CustomHeader, ModelJwtConfig
+from .common import ModelAuthTypeEnum, CustomHeader, ModelJwtConfig
 
 
 # class Modality(Enum):

enkryptai_sdk/dto/red_team.py

@@ -3,9 +3,11 @@ from enum import Enum
 from .base import BaseDTO
 from typing import Dict, List, Optional, Any
 from dataclasses import dataclass, field, asdict
+
 from .datasets import DatasetConfig
 from .models import ModelConfig
 from .guardrails import GuardrailDetectors
+from .common import ModelAuthTypeEnum, CustomHeader, ModelJwtConfig
 
 # The risk mitigation do not support all detectors, so we need to create a separate enum for them.
 class RiskGuardrailDetectorsEnum(str, Enum):
@@ -18,64 +20,7 @@ class RiskGuardrailDetectorsEnum(str, Enum):
     # Below are not yet supported by Guardrails. So, also not supported by Risk Mitigation.
     # COPYRIGHT_IP = "copyright_ip"
     # SYSTEM_PROMPT = "system_prompt"
-
-
-class ModelAuthTypeEnum(str, Enum):
-    APIKEY = "apikey"
-    JWT = "jwt"
-
-
-class ModelJwtMethodEnum(str, Enum):
-    POST = "POST"
-    GET = "GET"
-
-
-@dataclass
-class CustomHeader(BaseDTO):
-    key: str
-    value: str
-
-    @classmethod
-    def from_dict(cls, data: Dict[str, Any]) -> "CustomHeader":
-        return cls(
-            key=data.get("key", ""),
-            value=data.get("value", "")
-        )
-
-    def to_dict(self) -> Dict[str, Any]:
-        return {
-            "key": self.key,
-            "value": self.value
-        }
-
-
-@dataclass
-class ModelJwtConfig(BaseDTO):
-    jwt_method: ModelJwtMethodEnum = ModelJwtMethodEnum.POST
-    jwt_url: str = ""
-    jwt_headers: List[CustomHeader] = field(default_factory=list)
-    jwt_body: str = ""
-    jwt_response_key: str = ""
-    _extra_fields: Dict[str, Any] = field(default_factory=dict)
-
-    @classmethod
-    def from_dict(cls, data: Dict[str, Any]) -> "ModelJwtConfig":
-        return cls(
-            jwt_method=ModelJwtMethodEnum(data.get("jwt_method", ModelJwtMethodEnum.POST)),
-            jwt_url=data.get("jwt_url", ""),
-            jwt_headers=[CustomHeader.from_dict(header) for header in data.get("jwt_headers", [])],
-            jwt_body=data.get("jwt_body", ""),
-            jwt_response_key=data.get("jwt_response_key", ""),
-        )
-    
-    def to_dict(self) -> Dict[str, Any]:
-        return {
-            "jwt_method": self.jwt_method.value,
-            "jwt_url": self.jwt_url,
-            "jwt_headers": [header.to_dict() for header in self.jwt_headers],
-            "jwt_body": self.jwt_body,
-            "jwt_response_key": self.jwt_response_key,
-        }
+    # SPONGE_ATTACK = "sponge_attack"
 
 
 @dataclass
@@ -416,6 +361,28 @@ class TestConfig(BaseDTO):
         return cls(**data, attack_methods=attack_methods)
 
 
+@dataclass
+class CompetitorTestConfig(BaseDTO):
+    system_description: str
+    competitors_list: List[str]
+    sample_percentage: int = 1
+    attack_methods: AttackMethods = field(default_factory=AttackMethods)
+
+    def to_dict(self) -> dict:
+        return {
+            "sample_percentage": self.sample_percentage,
+            "competitors_list": self.competitors_list,
+            "system_description": self.system_description,
+            "attack_methods": self.attack_methods.to_dict(),
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict):
+        data = data.copy()
+        attack_methods = AttackMethods.from_dict(data.pop("attack_methods", {}))
+        return cls(**data, attack_methods=attack_methods)
+
+
 @dataclass
 class RedTeamTestConfigurations(BaseDTO):
     # Basic tests
@@ -424,6 +391,12 @@ class RedTeamTestConfigurations(BaseDTO):
     insecure_code_test: TestConfig = field(default=None)
     toxicity_test: TestConfig = field(default=None)
     harmful_test: TestConfig = field(default=None)
+    pii_test: TestConfig = field(default=None)
+    copyright_test: TestConfig = field(default=None)
+    misinformation_test: TestConfig = field(default=None)
+    system_prompt_extractions_test: TestConfig = field(default=None)
+    sponge_test: TestConfig = field(default=None)
+    competitor_test: CompetitorTestConfig = field(default=None)
     # Advanced tests
     adv_info_test: TestConfig = field(default=None)
     adv_bias_test: TestConfig = field(default=None)
@@ -442,6 +415,13 @@ class RedTeamTestConfigurations(BaseDTO):
     access_control_test: TestConfig = field(default=None)
     physical_and_actuation_safety_test: TestConfig = field(default=None)
     reliability_and_monitoring_test: TestConfig = field(default=None)
+    governance_test: TestConfig = field(default=None)
+    agent_output_quality_test: TestConfig = field(default=None)
+    tool_misuse_test: TestConfig = field(default=None)
+    privacy_test: TestConfig = field(default=None)
+    reliability_and_observability_test: TestConfig = field(default=None)
+    agent_behaviour_test: TestConfig = field(default=None)
+    access_control_and_permissions_test: TestConfig = field(default=None)
     _extra_fields: Dict[str, Any] = field(default_factory=dict)
 
     @classmethod

{enkryptai_sdk-1.0.17.dist-info → enkryptai_sdk-1.0.19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: enkryptai-sdk
-Version: 1.0.17
+Version: 1.0.19
 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
@@ -275,6 +275,9 @@ sample_detectors = {
         },
         "bias": {
             "enabled": False
+        },
+        "sponge_attack": {
+            "enabled": False
         }
     }
 ```
@@ -984,6 +987,7 @@ print(batch_detect_response.to_dict())
 - `copyright_ip`: Check for copyright/IP violations ***(Coming soon)***
 - `system_prompt`: Detect system prompt leaks ***(Coming soon)***
 - `keyword_detector`: Check for specific keywords
+- `sponge_attack`: Detect infinite loops
 
 Each detector can be enabled/disabled and configured with specific options as documented in the [API docs](https://docs.enkryptai.com/guardrails-api-reference/introduction).
 
@@ -1058,6 +1062,12 @@ guardrails_config = GuardrailsConfig.copyright_ip()
 guardrails_config = GuardrailsConfig.system_prompt(index="system")
 ```
 
+### [Sponge Attack](https://docs.enkryptai.com/guardrails-api-reference/Sponge_Attack_Detector)
+
+```python Python
+guardrails_config = GuardrailsConfig.sponge_attack()
+```
+
 ## [Detect with config](https://docs.enkryptai.com/guardrails-api-reference/Detect)
 
 ```python Python
@@ -1656,7 +1666,7 @@ custom_headers = {
 
 # Example of making a request with custom headers
 response = client.chat.completions.create(
-    model='gpt-4o',
+    # model='gpt-4o', # Optional
     messages=[{'role': 'user', 'content': 'Hello!'}],
     extra_headers=custom_headers
 )

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

@@ -2,7 +2,7 @@ enkryptai_sdk/__init__.py,sha256=8H5tznmjirTVdrTmrsyU6fNVRj3-UC0nrTGkzfFp0h0,845
 enkryptai_sdk/ai_proxy.py,sha256=ot1lqKk2LjcvlpnFm2kSA51vFThfquVlx86BhSbAzBo,3823
 enkryptai_sdk/base.py,sha256=KonezvdjVzIr3gw75grzcCNyhzI_sHXi-Cb9tRJgSDE,3277
 enkryptai_sdk/coc.py,sha256=5rq9LhZX-uvCmX8fM6JEndIEvd8rSzsSfDFnTvSvTQE,7396
-enkryptai_sdk/config.py,sha256=PyyuJRKWuiuFUaI90M21M141wlfIBeO_QVDU36KHKCs,9065
+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
@@ -15,13 +15,14 @@ enkryptai_sdk/dto/__init__.py,sha256=wHgIv_OCnVMJOys-vqImF59ifogDrMcgxVRmfNayVvc
 enkryptai_sdk/dto/ai_proxy.py,sha256=clwMN4xdH8Zr55dnhilHbs-qaHRlCOrLPrij0Zd1Av0,11283
 enkryptai_sdk/dto/base.py,sha256=y77kQL1X7389ifSVNc0E7CUFNxACh5AM3ml9YPon1KY,2822
 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=Aw4b8tDA3FYIomqDvCjblCXTagL4bT8Fx91X0SFXs40,11216
-enkryptai_sdk/dto/guardrails.py,sha256=oJQqFhsdQd_yPU187AhKse-Y4xktgmVNwwKKkzFazbg,50167
-enkryptai_sdk/dto/models.py,sha256=Nk6ZQyMfDMbl5ITQWQJUZMPxQOTATA65QbKHIy7i3qM,14533
-enkryptai_sdk/dto/red_team.py,sha256=NrYj9NZX3EmrBpESiZYFUCzgXH3eConh4NhVRKT28LM,27362
-enkryptai_sdk-1.0.17.dist-info/licenses/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-enkryptai_sdk-1.0.17.dist-info/METADATA,sha256=10vTRJNUYuEu7KgixIMOvgaweistehy8_s3kf3lkXiA,72860
-enkryptai_sdk-1.0.17.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-enkryptai_sdk-1.0.17.dist-info/top_level.txt,sha256=s2X9UJJwvJamNmr6ZXWyyQe60sXtQGWFuaBYfhgHI_4,14
-enkryptai_sdk-1.0.17.dist-info/RECORD,,
+enkryptai_sdk/dto/deployments.py,sha256=_tdSyRTJvthjLTbOxFO4f2P6vgirDsF3in5_gXE3a_U,11288
+enkryptai_sdk/dto/guardrails.py,sha256=NUVz59c-lnlTOwg72QIk62-USfHO-dpS5u2Hr6q9QGA,51774
+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,,