enkryptai-sdk 1.0.13__tar.gz → 1.0.15__tar.gz

{enkryptai_sdk-1.0.13/src/enkryptai_sdk.egg-info → enkryptai_sdk-1.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: enkryptai-sdk
-Version: 1.0.13
+Version: 1.0.15
 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
@@ -49,6 +49,8 @@ Also see the API documentation at [https://docs.enkryptai.com](https://docs.enkr
   - [Sample Redteam Model Config](#sample-redteam-model-config)
   - [Sample Custom Redteam Target Config](#sample-custom-redteam-target-config)
   - [Sample Custom Redteam Model Config](#sample-custom-redteam-model-config)
+  - [Sample Redteam Risk Mitigation Guardrails Policy Config](#sample-redteam-risk-mitigation-guardrails-policy-config)
+  - [Sample Redteam Risk Mitigation System Prompt Config](#sample-redteam-risk-mitigation-system-prompt-config)
 - [Health Checks](#health-checks)
   - [Guardrails Health](#guardrails-health)
   - [Guardrails Status](#guardrails-status)
@@ -124,6 +126,8 @@ Also see the API documentation at [https://docs.enkryptai.com](https://docs.enkr
   - [Get Redteam Task Results Summary of Test Type](#get-redteam-task-results-summary-of-test-type)
   - [Get Redteam Task Results Details](#get-redteam-task-results-details)
   - [Get Redteam Task Results Details of Test Type](#get-redteam-task-results-details-of-test-type)
+  - [Mitigate Risks with Guardrails Policy](#mitigate-risks-with-guardrails-policy)
+  - [Mitigate Risks with System Prompt](#mitigate-risks-with-system-prompt)
 - [Copyright, License, and Terms of Use](#copyright-license-and-terms-of-use)
 
 ## Installation
@@ -271,14 +275,7 @@ sample_detectors = {
         },
         "bias": {
             "enabled": False
-        },
-        "copyright_ip": {
-            "enabled": False
-        },
-        "system_prompt": {
-            "enabled": False,
-            "index": "system"
-        },
+        }
     }
 ```
 
@@ -525,6 +522,292 @@ sample_custom_redteam_model_config = {
     }
 ```
 
+### [Sample Redteam Risk Mitigation Guardrails Policy Config](https://docs.enkryptai.com/redteam-api-reference/endpoint/risk-mitigation-guardrails-policy)
+
+```python Python
+sample_redteam_risk_mitigation_guardrails_policy_config = {
+        "required_detectors": [
+            "policy_violation"
+        ],
+        "redteam_summary": {
+            "category": [
+                {
+                    "Biology": {
+                        "total": 50,
+                        "test_type": "cbrn_test",
+                        "success(%)": 92
+                    }
+                },
+                {
+                    "Chemistry": {
+                        "total": 50,
+                        "test_type": "cbrn_test",
+                        "success(%)": 98
+                    }
+                },
+                {
+                    "Fraud": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 73
+                    }
+                },
+                {
+                    "Guns & Illegal Substances": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 87
+                    }
+                },
+                {
+                    "Hate Speech and Discrimination": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 53
+                    }
+                },
+                {
+                    "Nuclear Science": {
+                        "total": 50,
+                        "test_type": "cbrn_test",
+                        "success(%)": 94
+                    }
+                },
+                {
+                    "Radiology": {
+                        "total": 50,
+                        "test_type": "cbrn_test",
+                        "success(%)": 84
+                    }
+                },
+                {
+                    "Regulated or Controlled Substances": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 74
+                    }
+                },
+                {
+                    "Sexual Content": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 79
+                    }
+                },
+                {
+                    "Suicide & Self-Harm": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 72
+                    }
+                },
+                {
+                    "Unethical Crimes": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 83
+                    }
+                },
+                {
+                    "Violent Crimes": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 70
+                    }
+                }
+            ],
+            "scenario": [],
+            "test_date": "2020-01-01T17:14:33.607823+00:00",
+            "test_name": "Mistral Small Latest x Red Team",
+            "test_type": [
+                {
+                    "cbrn_test": {
+                        "total": 200,
+                        "success(%)": 92
+                    }
+                },
+                {
+                    "harmful_test": {
+                        "total": 800,
+                        "success(%)": 73.88
+                    }
+                }
+            ],
+            "model_name": "mistral-small-latest",
+            "risk_score": 82.9375,
+            "dataset_name": "Standard",
+            "model_source": "",
+            "attack_method": [
+                {
+                    "Basic": {
+                        "total": 1000,
+                        "success(%)": 77.5
+                    }
+                }
+            ],
+            "nist_category": [
+                {
+                    "CBRN Information or Capabilities": {
+                        "total": 200,
+                        "success(%)": 92
+                    }
+                },
+                {
+                    "Dangerous, Violent, or Hateful Content": {
+                        "total": 800,
+                        "success(%)": 73.88
+                    }
+                }
+            ],
+            "model_provider": "mistral",
+            "model_endpoint_url": "https://api.mistral.ai/v1/chat/completions",
+            "custom_test_category_risks": []
+        }
+    }
+```
+
+### [Sample Redteam Risk Mitigation System Prompt Config](https://docs.enkryptai.com/redteam-api-reference/endpoint/risk-mitigation-system-prompt)
+
+```python Python
+sample_redteam_risk_mitigation_system_prompt_config = {
+        "system_prompt": "You are a helpful AI Assistant",
+        "redteam_summary": {
+            "category": [
+                {
+                    "Biology": {
+                        "total": 50,
+                        "test_type": "cbrn_test",
+                        "success(%)": 92
+                    }
+                },
+                {
+                    "Chemistry": {
+                        "total": 50,
+                        "test_type": "cbrn_test",
+                        "success(%)": 98
+                    }
+                },
+                {
+                    "Fraud": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 73
+                    }
+                },
+                {
+                    "Guns & Illegal Substances": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 87
+                    }
+                },
+                {
+                    "Hate Speech and Discrimination": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 53
+                    }
+                },
+                {
+                    "Nuclear Science": {
+                        "total": 50,
+                        "test_type": "cbrn_test",
+                        "success(%)": 94
+                    }
+                },
+                {
+                    "Radiology": {
+                        "total": 50,
+                        "test_type": "cbrn_test",
+                        "success(%)": 84
+                    }
+                },
+                {
+                    "Regulated or Controlled Substances": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 74
+                    }
+                },
+                {
+                    "Sexual Content": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 79
+                    }
+                },
+                {
+                    "Suicide & Self-Harm": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 72
+                    }
+                },
+                {
+                    "Unethical Crimes": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 83
+                    }
+                },
+                {
+                    "Violent Crimes": {
+                        "total": 100,
+                        "test_type": "harmful_test",
+                        "success(%)": 70
+                    }
+                }
+            ],
+            "scenario": [],
+            "test_date": "2020-01-01T17:14:33.607823+00:00",
+            "test_name": "Mistral Small Latest x Red Team",
+            "test_type": [
+                {
+                    "cbrn_test": {
+                        "total": 200,
+                        "success(%)": 92
+                    }
+                },
+                {
+                    "harmful_test": {
+                        "total": 800,
+                        "success(%)": 73.88
+                    }
+                }
+            ],
+            "model_name": "mistral-small-latest",
+            "risk_score": 82.9375,
+            "dataset_name": "Standard",
+            "model_source": "",
+            "attack_method": [
+                {
+                    "Basic": {
+                        "total": 1000,
+                        "success(%)": 77.5
+                    }
+                }
+            ],
+            "nist_category": [
+                {
+                    "CBRN Information or Capabilities": {
+                        "total": 200,
+                        "success(%)": 92
+                    }
+                },
+                {
+                    "Dangerous, Violent, or Hateful Content": {
+                        "total": 800,
+                        "success(%)": 73.88
+                    }
+                }
+            ],
+            "model_provider": "mistral",
+            "model_endpoint_url": "https://api.mistral.ai/v1/chat/completions",
+            "custom_test_category_risks": []
+        }
+    }
+```
+
 ## Health Checks
 
 ### [Guardrails Health](https://docs.enkryptai.com/guardrails-api-reference/endpoint/health-check)
@@ -701,8 +984,8 @@ print(batch_detect_response.to_dict())
 - `nsfw`: Filter inappropriate content
 - `toxicity`: Detect toxic language
 - `pii`: Detect personal information
-- `copyright_ip`: Check for copyright/IP violations
-- `system_prompt`: Detect system prompt leaks
+- `copyright_ip`: Check for copyright/IP violations ***(Coming soon)***
+- `system_prompt`: Detect system prompt leaks ***(Coming soon)***
 - `keyword_detector`: Check for specific keywords
 
 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).
@@ -764,12 +1047,16 @@ guardrails_config = GuardrailsConfig.keyword(keywords=["secret", "password"])
 
 ### [Copyright IP](https://docs.enkryptai.com/guardrails-api-reference/Copyright_IP_Leak_Detector)
 
+- ***(Coming soon)***
+
 ```python Python
 guardrails_config = GuardrailsConfig.copyright_ip()
 ```
 
 ### [System Prompt](https://docs.enkryptai.com/guardrails-api-reference/System_Prompt_Leak_Detector)
 
+- ***(Coming soon)***
+
 ```python Python
 guardrails_config = GuardrailsConfig.system_prompt(index="system")
 ```
@@ -972,6 +1259,8 @@ print(relevancy_response.to_dict())
 
 ### [Check Hallucination](https://docs.enkryptai.com/guardrails-api-reference/Hallucination)
 
+- ***(Coming soon)***
+
 Detect hallucinations in an LLM's response:
 
 ```python Python
@@ -1057,7 +1346,7 @@ print(atomize_response.to_dict())
 # Add a code of conduct policy
 add_policy_response = coc_client.add_policy(
     policy_name=test_coc_policy_name,
-    policy_rules=example_coc_policy_rules,  # Can also be a list of rules
+    policy_rules=example_coc_policy_rules, # Can also be a list of rules
     total_rules=4,
     policy_file="/path/to/your/policy.pdf"
     # policy_text=example_coc_policy_text, # Optional: Use this if you want to add a policy text instead of a file
@@ -1661,6 +1950,32 @@ print(redteam_results_details_test_type.task_status)
 print(redteam_results_details_test_type.to_dict())
 ```
 
+### [Mitigate Risks with Guardrails Policy](https://docs.enkryptai.com/redteam-api-reference/endpoint/risk-mitigation-guardrails-policy)
+
+```python Python
+# Mitigate risks with guardrails policy
+risk_mitigation_guardrails_policy_response = redteam_client.risk_mitigation_guardrails_policy(config=copy.deepcopy(sample_redteam_risk_mitigation_guardrails_policy_config))
+
+print(risk_mitigation_guardrails_policy_response)
+print(risk_mitigation_guardrails_policy_response.guardrails_policy)
+
+# Print as a dictionary
+print(risk_mitigation_guardrails_policy_response.to_dict())
+```
+
+### [Mitigate Risks with System Prompt](https://docs.enkryptai.com/redteam-api-reference/endpoint/risk-mitigation-system-prompt)
+
+```python Python
+# Mitigate risks with system prompt
+risk_mitigation_system_prompt_response = redteam_client.risk_mitigation_system_prompt(config=copy.deepcopy(sample_redteam_risk_mitigation_system_prompt_config))
+
+print(risk_mitigation_system_prompt_response)
+print(risk_mitigation_system_prompt_response.system_prompt)
+
+# Print as a dictionary
+print(risk_mitigation_system_prompt_response.to_dict())
+```
+
 ## Copyright, License and Terms of Use
 
 © 2025 Enkrypt AI. All rights reserved.