Azure Guardrails

Microsoft Azure offers robust content moderation and PII readaction services that can now be seamlessly integrated with Portkey’s guardrails ecosystem. This integration supports two powerful Azure services:

​

Setting Up Azure Guardrails

Follow these steps to integrate Azure’s content moderation services with Portkey:

​

1. Configure Azure Authentication

Navigate to the Integrations page under Settings to set up your Azure credentials. You can authenticate using three different methods:

• API Key - Uses a simple API key for authentication
• Entra (formerly Azure AD) - Uses Azure Active Directory authentication
• Managed - Uses managed identity authentication within Azure

Each authentication method requires specific credentials from your Azure account:

​

2. Create Azure Guardrail Checks

Once authentication is set up, you can add Azure guardrail checks to your Portkey workflow:

1. Navigate to the Guardrails page
2. Search for either Azure Content Safety or Azure PII Detection
3. Click Add to configure your chosen guardrail
4. Configure the specific settings for your guardrail
5. Save your configuration and create the guardrail

​

Azure Content Safety

Azure Content Safety analyzes text for harmful content across several categories.

Configuration Options

​

Using Blocklists

Blocklists allow you to define custom terms or patterns to be flagged. You’ll need to create Content Safety blocklists in your Azure account first, then reference them in the Blocklist Names field.

​

Azure PII Detection

Azure PII Detection identifies and can help protect personal and health-related information in your content.

Configuration Options

​

Add Guardrail ID to a Config and Make Your Request

• When you save a Guardrail, you’ll get an associated Guardrail ID - add this ID to the input_guardrails or output_guardrails params in your Portkey Config
• Create these Configs in Portkey UI, save them, and get an associated Config ID to attach to your requests. More here.

Here’s an example configuration:

{
  "input_guardrails": ["guardrails-id-xxx", "guardrails-id-yyy"],
  "output_guardrails": ["guardrails-id-xxx", "guardrails-id-yyy"]
}

const portkey = new Portkey({
    apiKey: "PORTKEY_API_KEY",
    config: "pc-***" // Supports a string config id or a config object
});

const portkey = new Portkey({
    apiKey: "PORTKEY_API_KEY",
    config: "pc-***" // Supports a string config id or a config object
});

portkey = Portkey(
    api_key="PORTKEY_API_KEY",
    config="pc-***" # Supports a string config id or a config object
)

const openai = new OpenAI({
  apiKey: 'OPENAI_API_KEY',
  baseURL: PORTKEY_GATEWAY_URL,
  defaultHeaders: createHeaders({
    apiKey: "PORTKEY_API_KEY",
    config: "CONFIG_ID"
  })
});

client = OpenAI(
    api_key="OPENAI_API_KEY", # defaults to os.environ.get("OPENAI_API_KEY")
    base_url=PORTKEY_GATEWAY_URL,
    default_headers=createHeaders(
        provider="openai",
        api_key="PORTKEY_API_KEY", # defaults to os.environ.get("PORTKEY_API_KEY")
        config="CONFIG_ID"
    )
)

curl https://api.portkey.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-config: $CONFIG_ID" \
  -d '{
    "model": "gpt-3.5-turbo",
    "messages": [{
        "role": "user",
        "content": "Hello!"
      }]
  }'

For more, refer to the Config documentation.

​

Monitoring and Logs

All guardrail actions and verdicts are visible in your Portkey logs, allowing you to:

• Track which content has been flagged
• See guardrail verdicts and actions
• Monitor the performance of your content moderation pipeline

​

Using Azure Guardrails - Scenarios

After setting up your guardrails, there are different ways to use them depending on your security requirements:

​

Detect and Monitor Only

To simply detect but not block content:

• Configure your guardrail actions without enabling “Deny”
• Monitor the guardrail results in your Portkey logs
• If any issues are detected, the response will include a hook_results object with details

​

Redact PII Automatically

To automatically remove sensitive information:

• Enable the Redact option for Azure PII Detection
• When PII is detected, it will be automatically redacted and replaced with standardized identifiers
• The response will include a transformed flag set to true in the results

​

Block Harmful Content

To completely block requests that violate your policies:

• Enable the Deny option in the guardrails action tab
• If harmful content is detected, the request will fail with an appropriate status code
• You can customize denial messages to provide guidance to users

​

Need Support?

If you encounter any issues with Azure Guardrails, please reach out to our support team through the Portkey community forum.