Guardrails Policy is a powerful tool for managing and implementing content detection and filtering policies. Here’s what we offer:

​
Policy Management

  1. Add Policy

    • Create new policies with custom configurations.
    • Specify policy name, description, and detectors.
import os
from enkryptai_sdk import *
from dotenv import load_dotenv

load_dotenv()

ENKRYPT_API_KEY = os.getenv("ENKRYPTAI_API_KEY")
ENKRYPT_BASE_URL = os.getenv("ENKRYPTAI_BASE_URL") or "https://api.enkryptai.com"

guardrails_client = GuardrailsClient(api_key=ENKRYPT_API_KEY, base_url=ENKRYPT_BASE_URL)

test_policy_name = "Test Policy"

sample_detectors = {
        "pii": {
            "enabled": False,
            "entities": [
                "pii",
                "secrets",
                "ip_address",
                "url"
            ]
        },
        "nsfw": {
            "enabled": True
        },
        "toxicity": {
            "enabled": False
        },
        "topic_detector": {
            "topic": ["science"],
            "enabled": False
        },
        "injection_attack": {
            "enabled": True
        },
        "keyword_detector": {
            "enabled": False,
            "banned_keywords": []
        },
        "policy_violation": {
            "enabled": True,
            "need_explanation": True,
            "policy_text": ""
        },
        "bias": {
            "enabled": False
        },
        "copyright_ip": {
            "enabled": False
        },
        "system_prompt": {
            "enabled": False,
            "index": "system"
        },
    }

# Create a policy with a dictionary
add_policy_response = guardrails_client.add_policy(
    policy_name=test_policy_name,
    config=copy.deepcopy(sample_detectors),
    description="Sample custom security policy"
)

# Or create a policy with GuardrailsConfig object
injection_config = GuardrailsConfig.injection_attack()
add_policy_response = guardrails_client.add_policy(
    policy_name=test_policy_name,
    config=injection_config,
    description="Detects prompt injection attacks"
)

print(add_policy_response)

assert add_policy_response.message == "Policy details added successfully"

# Print as a dictionary
print(add_policy_response.to_dict())

  1. Get Policy

    • Retrieve existing policies by name.
    • Option to refresh the cache if current data is outdated.
# Retrieve policy configuration
policy = guardrails_client.get_policy(policy_name=test_policy_name)

print(policy)

# Get other fields
print(policy.name)
print(policy.detectors)

# Print as a dictionary
print(policy.to_dict())
print(policy.detectors.to_dict())

  1. Modify Policy

    • Modify existing policies.
    • Update name, description, and detector configurations.
# Update policy with new configuration
# Similar to add, we can use a dictionary or GuardrailsConfig object
new_detectors_dict = copy.deepcopy(sample_detectors)
# Modify the detectors as needed
# Example: Enable bias detection
new_detectors_dict["bias"]["enabled"] = True

new_config = new_detectors_dict or GuardrailsConfig.bias()  # Switch to bias detection

modify_policy_response = guardrails_client.modify_policy(
    policy_name=test_policy_name,
    guardrails_config=new_config,
    description="Updated to detect bias"
)

print(modify_policy_response)

assert modify_policy_response.message == "Policy details updated successfully"

# Print as a dictionary
print(modify_policy_response.to_dict())
  1. Delete Policy
    • Remove policies that are no longer needed.
# Remove a policy
delete_policy_response = guardrails_client.delete_policy(policy_name=test_policy_name)

print(delete_policy_response)

assert delete_policy_response.message == "Policy details deleted successfully"

# Print as a dictionary
print(delete_policy_response.to_dict())
  1. List Policies
    • Retrieve a list of all policies.
# List all policies
policies = guardrails_client.get_policy_list()

print(policies)

# Get the first policy
print(policies.policies[0])
print(policies.policies[0].name)

# Print as a dictionary
print(policies.to_dict())

​
Policy Usage

  1. Detect Using Policy
    • Apply a specific policy to detect and filter content.
    • Utilize custom configurations for various use cases.
# Use policy to detect
policy_detect_response = guardrails_client.policy_detect(
    policy_name=test_policy_name,
    text="Check this text for policy violations"
)

print(policy_detect_response)

# Print as a dictionary
print(policy_detect_response.to_dict())