F5 Guardrails

Documentation Index

Fetch the complete documentation index at: https://docs.portkey.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

​

Using F5 Guardrails with Portkey

​

1. Add F5 Guardrails Credentials to Portkey

• Navigate to the Plugins page under Admin Settings
• Click on the edit button for the F5 Guardrails integration
• Add your F5 Guardrails API Key (obtain this from your F5/CalypsoAI account)
• (Optional) Add your F5 Gaurdrail API URL, defaults to https://us1.calypsoai.app.

​

2. Add F5 Guardrails Check

• Navigate to the Guardrails page and click the Create button
• Search for “F5 Guardrails” and click Add
• Configure your moderation checks:
  • Project ID: Your F5 Guardrails project identifier (Required)
  • Redact: Whether to redact PII data detected by the guardrail. When enabled, detected PII will be masked in the content (Default: false)
  • Timeout: The timeout in milliseconds for the scan (Default: 5000)
• Set any actions you want on your check, and create the Guardrail!

​

3. 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.

{
  "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
});

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!"
      }]
  }'

​

Get Support