enkryptai-sdk 1.0.9__tar.gz → 1.0.10__tar.gz

{enkryptai_sdk-1.0.9/src/enkryptai_sdk.egg-info → enkryptai_sdk-1.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: enkryptai-sdk
-Version: 1.0.9
+Version: 1.0.10
 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
@@ -264,7 +264,10 @@ sample_detectors = {
         "policy_violation": {
             "enabled": True,
             "need_explanation": True,
-            "policy_text": ""
+            "policy_text": "The model should not provide medical advice when asked about health symptoms."
+            # Or we can also give coc_policy_name of a saved Code of Conduct Policy
+            # Instead of policy_text
+            # "coc_policy_name": "Test CoC Policy"
         },
         "bias": {
             "enabled": False
@@ -718,6 +721,9 @@ guardrails_config = GuardrailsConfig.injection_attack()
 
 ```python Python
 guardrails_config = GuardrailsConfig.policy_violation(policy_text="You must not use hate speech", need_explanation=True)
+
+# Or we can also give coc_policy_name of a saved Code of Conduct Policy instead of policy_text
+guardrails_config = GuardrailsConfig.policy_violation(coc_policy_name="Test CoC Policy", need_explanation=True)
 ```
 
 ### [Toxicity](https://docs.enkryptai.com/guardrails-api-reference/Toxicity_Detector)

{enkryptai_sdk-1.0.9 → enkryptai_sdk-1.0.10}/README.md

@@ -241,7 +241,10 @@ sample_detectors = {
         "policy_violation": {
             "enabled": True,
             "need_explanation": True,
-            "policy_text": ""
+            "policy_text": "The model should not provide medical advice when asked about health symptoms."
+            # Or we can also give coc_policy_name of a saved Code of Conduct Policy
+            # Instead of policy_text
+            # "coc_policy_name": "Test CoC Policy"
         },
         "bias": {
             "enabled": False
@@ -695,6 +698,9 @@ guardrails_config = GuardrailsConfig.injection_attack()
 
 ```python Python
 guardrails_config = GuardrailsConfig.policy_violation(policy_text="You must not use hate speech", need_explanation=True)
+
+# Or we can also give coc_policy_name of a saved Code of Conduct Policy instead of policy_text
+guardrails_config = GuardrailsConfig.policy_violation(coc_policy_name="Test CoC Policy", need_explanation=True)
 ```
 
 ### [Toxicity](https://docs.enkryptai.com/guardrails-api-reference/Toxicity_Detector)

{enkryptai_sdk-1.0.9 → enkryptai_sdk-1.0.10}/setup.py

@@ -9,7 +9,7 @@ with open(os.path.join(here, "README.md"), encoding="utf-8") as fh:
 setup(
     name="enkryptai-sdk",  # This is the name of your package on PyPI
     # NOTE: Also change this in .github/workflows/test.yaml
-    version="1.0.9", # Update this for new versions
+    version="1.0.10", # Update this for new versions
     description="A Python SDK with guardrails and red teaming functionality for API interactions",
     long_description=long_description,
     long_description_content_type="text/markdown",

{enkryptai_sdk-1.0.9 → enkryptai_sdk-1.0.10}/src/enkryptai_sdk/config.py

@@ -10,7 +10,7 @@ DEFAULT_GUARDRAILS_CONFIG = {
     "keyword_detector": {"enabled": False, "banned_keywords": []},
     "policy_violation": {
         "enabled": False,
-        "policy_text": "",
+        "policy_text": "Do not allow any illegal or immoral activities.",
         "need_explanation": False,
     },
     "bias": {"enabled": False},
@@ -42,16 +42,21 @@ class GuardrailsConfig:
         return cls(config)
 
     @classmethod
-    def policy_violation(cls, policy_text: str, need_explanation: bool = False):
+    def policy_violation(cls, policy_text: str = "", need_explanation: bool = False, coc_policy_name: str = ""):
         """
         Returns a configuration instance pre-configured for policy violation detection.
         """
         config = copy.deepcopy(DEFAULT_GUARDRAILS_CONFIG)
         config["policy_violation"] = {
             "enabled": True,
-            "policy_text": policy_text,
             "need_explanation": need_explanation,
         }
+
+        if policy_text:
+            config["policy_violation"]["policy_text"] = policy_text
+        if coc_policy_name:
+            config["policy_violation"]["coc_policy_name"] = coc_policy_name
+
         return cls(config)
 
     @classmethod

{enkryptai_sdk-1.0.9 → enkryptai_sdk-1.0.10}/src/enkryptai_sdk/dto/guardrails.py

@@ -163,6 +163,7 @@ class PolicyViolationDetector(BaseDTO):
     enabled: bool = False
     policy_text: str = ""
     need_explanation: bool = False
+    coc_policy_name: str = ""
     _extra_fields: Dict[str, Any] = field(default_factory=dict)
     
     @classmethod
@@ -170,16 +171,23 @@ class PolicyViolationDetector(BaseDTO):
         return cls(
             enabled=data.get("enabled", False),
             policy_text=data.get("policy_text", ""),
-            need_explanation=data.get("need_explanation", False)
+            need_explanation=data.get("need_explanation", False),
+            coc_policy_name=data.get("coc_policy_name", "")
         )
     
     def to_dict(self) -> Dict[str, Any]:
-        return {
+        res_dict = {
             "enabled": self.enabled,
-            "policy_text": self.policy_text,
             "need_explanation": self.need_explanation
         }
 
+        if self.policy_text:
+            res_dict["policy_text"] = self.policy_text
+        if self.coc_policy_name:
+            res_dict["coc_policy_name"] = self.coc_policy_name
+
+        return res_dict
+
 
 @dataclass
 class BiasDetector(BaseDTO):

{enkryptai_sdk-1.0.9 → enkryptai_sdk-1.0.10/src/enkryptai_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: enkryptai-sdk
-Version: 1.0.9
+Version: 1.0.10
 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
@@ -264,7 +264,10 @@ sample_detectors = {
         "policy_violation": {
             "enabled": True,
             "need_explanation": True,
-            "policy_text": ""
+            "policy_text": "The model should not provide medical advice when asked about health symptoms."
+            # Or we can also give coc_policy_name of a saved Code of Conduct Policy
+            # Instead of policy_text
+            # "coc_policy_name": "Test CoC Policy"
         },
         "bias": {
             "enabled": False
@@ -718,6 +721,9 @@ guardrails_config = GuardrailsConfig.injection_attack()
 
 ```python Python
 guardrails_config = GuardrailsConfig.policy_violation(policy_text="You must not use hate speech", need_explanation=True)
+
+# Or we can also give coc_policy_name of a saved Code of Conduct Policy instead of policy_text
+guardrails_config = GuardrailsConfig.policy_violation(coc_policy_name="Test CoC Policy", need_explanation=True)
 ```
 
 ### [Toxicity](https://docs.enkryptai.com/guardrails-api-reference/Toxicity_Detector)

{enkryptai_sdk-1.0.9 → enkryptai_sdk-1.0.10}/tests/test_all_v2.py

@@ -141,7 +141,7 @@ def sample_detectors():
         "policy_violation": {
             "enabled": True,
             "need_explanation": True,
-            "policy_text": ""
+            "policy_text": "Do not allow any illegal or immoral activities."
         },
         "bias": {
             "enabled": False

{enkryptai_sdk-1.0.9 → enkryptai_sdk-1.0.10}/tests/test_guardrails.py

@@ -63,7 +63,7 @@ def sample_detectors():
         "policy_violation": {
             "enabled": True,
             "need_explanation": True,
-            "policy_text": ""
+            "policy_text": "Do not allow any illegal or immoral activities."
         },
         "bias": {
             "enabled": False