first commit
This commit is contained in:
104
docs/integrations/guardrails/aws-bedrock.mdx
Normal file
104
docs/integrations/guardrails/aws-bedrock.mdx
Normal file
@@ -0,0 +1,104 @@
|
||||
---
|
||||
title: "AWS Bedrock Guardrails"
|
||||
description: "Integrate AWS Bedrock Guardrails with Bifrost for enterprise-grade content filtering, PII protection, prompt attack detection, and image content analysis."
|
||||
icon: "aws"
|
||||
---
|
||||
|
||||
Bifrost integrates with **Amazon Bedrock Guardrails** to provide enterprise-grade content filtering and safety features with deep AWS integration. This page covers the configuration and capabilities of the AWS Bedrock guardrail provider.
|
||||
|
||||

|
||||
|
||||
## Capabilities
|
||||
|
||||
- **Content Filters**: Hate speech, insults, sexual content, violence, misconduct
|
||||
- **Denied Topics**: Block specific topics or categories
|
||||
- **Word Filters**: Custom profanity and sensitive word blocking
|
||||
- **PII Protection**: Detect and redact 50+ PII entity types
|
||||
- **Contextual Grounding**: Verify responses against source documents
|
||||
- **Prompt Attack Detection**: Identify injection and jailbreak attempts
|
||||
- **Image Content Support**: Analyze images in addition to text (PNG, JPEG)
|
||||
|
||||
## Configuration Fields
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `access_key` | string | Yes | - | AWS Access Key ID |
|
||||
| `secret_key` | string | Yes | - | AWS Secret Access Key |
|
||||
| `guardrail_arn` | string | Yes | - | ARN of the Bedrock guardrail |
|
||||
| `guardrail_version` | string | Yes | - | Version of the guardrail (e.g., "1", "DRAFT") |
|
||||
| `region` | string | Yes | - | AWS region |
|
||||
|
||||
## Authentication
|
||||
|
||||
Uses AWS SDK with static credentials:
|
||||
```json
|
||||
{
|
||||
"access_key": "AKIAXXXXXXXXXXXXXXXXXX",
|
||||
"secret_key": "your-secret-access-key",
|
||||
"guardrail_arn": "arn:aws:bedrock:us-east-1:123456789:guardrail/abc123",
|
||||
"guardrail_version": "1",
|
||||
"region": "us-east-1"
|
||||
}
|
||||
```
|
||||
|
||||
## Supported AWS Regions
|
||||
|
||||
| Region Code | Region Name |
|
||||
|-------------|-------------|
|
||||
| `us-east-1` | US East (N. Virginia) |
|
||||
| `us-east-2` | US East (Ohio) |
|
||||
| `us-west-1` | US West (N. California) |
|
||||
| `us-west-2` | US West (Oregon) |
|
||||
| `ap-south-1` | Asia Pacific (Mumbai) |
|
||||
| `ap-northeast-1` | Asia Pacific (Tokyo) |
|
||||
| `ap-northeast-2` | Asia Pacific (Seoul) |
|
||||
| `ap-southeast-1` | Asia Pacific (Singapore) |
|
||||
| `ap-southeast-2` | Asia Pacific (Sydney) |
|
||||
| `eu-central-1` | Europe (Frankfurt) |
|
||||
| `eu-west-1` | Europe (Ireland) |
|
||||
| `eu-west-2` | Europe (London) |
|
||||
| `eu-west-3` | Europe (Paris) |
|
||||
|
||||
## Supported Content Types
|
||||
|
||||
- Text content
|
||||
- Images (PNG, JPEG formats)
|
||||
|
||||
## Usage Metrics Returned
|
||||
|
||||
Bedrock guardrails return detailed usage metrics for cost tracking and monitoring:
|
||||
|
||||
| Metric | Description |
|
||||
|--------|-------------|
|
||||
| `content_policy_units` | Units consumed by content policy evaluation |
|
||||
| `contextual_grounding_policy_units` | Units for grounding checks |
|
||||
| `sensitive_information_policy_units` | Units for PII detection |
|
||||
| `topic_policy_units` | Units for topic filtering |
|
||||
| `word_policy_units` | Units for word filtering |
|
||||
| `automated_reasoning_policy_units` | Units for reasoning checks |
|
||||
| `content_policy_image_units` | Units for image content analysis |
|
||||
|
||||
## Supported PII Types
|
||||
|
||||
- Personal identifiers (SSN, passport, driver's license)
|
||||
- Financial information (credit cards, bank accounts)
|
||||
- Contact information (email, phone, address)
|
||||
- Medical information (health records, insurance)
|
||||
- Device identifiers (IP addresses, MAC addresses)
|
||||
|
||||
## Provider Capabilities Comparison
|
||||
|
||||
| Capability | AWS Bedrock | Azure Content Safety | GraySwan | Patronus AI |
|
||||
|------------|-------------|---------------------|----------|-------------|
|
||||
| PII Detection | Yes | No | No | Yes |
|
||||
| Content Filtering | Yes | Yes | Yes | Yes |
|
||||
| Prompt Injection | Yes | Yes | Yes | Yes |
|
||||
| Hallucination Detection | No | No | No | Yes |
|
||||
| Toxicity Screening | Yes | Yes | Yes | Yes |
|
||||
| Custom Policies | Yes | Yes | Yes | Yes |
|
||||
| Custom Natural Language Rules | No | No | Yes | No |
|
||||
| Image Support | Yes | No | No | No |
|
||||
| IPI Detection | No | Yes | Yes | No |
|
||||
| Mutation Detection | No | No | Yes | No |
|
||||
|
||||
For information on configuring guardrail rules and profiles, see [Guardrails](/enterprise/guardrails).
|
||||
80
docs/integrations/guardrails/azure-content-safety.mdx
Normal file
80
docs/integrations/guardrails/azure-content-safety.mdx
Normal file
@@ -0,0 +1,80 @@
|
||||
---
|
||||
title: "Azure Content Safety"
|
||||
description: "Integrate Azure AI Content Safety with Bifrost for multi-modal content moderation, severity-based filtering, prompt shield, and custom blocklist support."
|
||||
icon: "microsoft"
|
||||
---
|
||||
|
||||
Bifrost integrates with **Azure AI Content Safety** to provide multi-modal content moderation powered by Microsoft's advanced AI models. This page covers the configuration and capabilities of the Azure Content Safety guardrail provider.
|
||||
|
||||

|
||||
|
||||
## Capabilities
|
||||
|
||||
- **Severity-Based Filtering**: 4-level severity classification (Safe, Low, Medium, High)
|
||||
- **Multi-Category Detection**: Hate, sexual, violence, self-harm content
|
||||
- **Prompt Shield**: Advanced jailbreak and injection detection
|
||||
- **Indirect Attack Detection**: Identify hidden malicious instructions
|
||||
- **Protected Material**: Detect copyrighted content (output only)
|
||||
- **Custom Blocklists**: Define organization-specific blocked terms
|
||||
|
||||
## Configuration Fields
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
| -------------------------------- | ------- | -------- | -------- | ------------------------------------------------------------ |
|
||||
| `endpoint` | string | Yes | - | Azure Content Safety endpoint URL |
|
||||
| `api_key` | string | Yes | - | Azure subscription key |
|
||||
| `analyze_enabled` | boolean | No | true | Enable content analysis for Hate, Sexual, Violence, SelfHarm |
|
||||
| `analyze_severity_threshold` | enum | No | "medium" | Severity level to trigger: `low`, `medium`, or `high` |
|
||||
| `jailbreak_shield_enabled` | boolean | No | false | Enable jailbreak detection (input only) |
|
||||
| `indirect_attack_shield_enabled` | boolean | No | false | Enable indirect prompt attack detection (input only) |
|
||||
| `copyright_enabled` | boolean | No | false | Enable copyrighted content detection (output only) |
|
||||
| `text_blocklist_enabled` | boolean | No | false | Enable custom blocklist filtering |
|
||||
| `blocklist_names` | array | No | - | List of Azure blocklist names to apply |
|
||||
|
||||
## Collecting your API key and URL
|
||||
|
||||
Navigate to Azure foundry dashboard
|
||||
|
||||
<Frame>
|
||||
<img src="/media/guardrails/azure-api-key.png" alt="Azure foundry dashboard" />
|
||||
</Frame>
|
||||
|
||||
- Copy API key to use it in the Azure content moderation config form
|
||||
- Copy project endpoint and use base URL as endpoint in the form. e.g. (`https://xxx-resource.services.ai.azure.com`)
|
||||
|
||||
## Severity Threshold Levels
|
||||
|
||||
| Threshold | Numeric Value | Behavior |
|
||||
| --------- | ------------- | ----------------------------------------- |
|
||||
| `low` | 2 | Most strict - blocks severity 2 and above |
|
||||
| `medium` | 4 | Balanced - blocks severity 4 and above |
|
||||
| `high` | 6 | Least strict - blocks only severity 6 |
|
||||
|
||||
## Detection Categories
|
||||
|
||||
- Hate and fairness
|
||||
- Sexual content
|
||||
- Violence
|
||||
- Self-harm
|
||||
|
||||
<Note>
|
||||
**Input-only features:** Jailbreak Shield and Indirect Attack Shield only apply to input validation. **Output-only
|
||||
features:** Copyright detection only applies to output validation.
|
||||
</Note>
|
||||
|
||||
## Provider Capabilities Comparison
|
||||
|
||||
| Capability | AWS Bedrock | Azure Content Safety | GraySwan | Patronus AI |
|
||||
| ----------------------------- | ----------- | -------------------- | -------- | ----------- |
|
||||
| PII Detection | Yes | No | No | Yes |
|
||||
| Content Filtering | Yes | Yes | Yes | Yes |
|
||||
| Prompt Injection | Yes | Yes | Yes | Yes |
|
||||
| Hallucination Detection | No | No | No | Yes |
|
||||
| Toxicity Screening | Yes | Yes | Yes | Yes |
|
||||
| Custom Policies | Yes | Yes | Yes | Yes |
|
||||
| Custom Natural Language Rules | No | No | Yes | No |
|
||||
| Image Support | Yes | No | No | No |
|
||||
| IPI Detection | No | Yes | Yes | No |
|
||||
| Mutation Detection | No | No | Yes | No |
|
||||
|
||||
For information on configuring guardrail rules and profiles, see [Guardrails](/enterprise/guardrails).
|
||||
70
docs/integrations/guardrails/grayswan.mdx
Normal file
70
docs/integrations/guardrails/grayswan.mdx
Normal file
@@ -0,0 +1,70 @@
|
||||
---
|
||||
title: "GraySwan Cygnal"
|
||||
description: "Integrate GraySwan Cygnal Monitor with Bifrost for AI safety monitoring with natural language rule definitions, violation scoring, and advanced threat detection."
|
||||
icon: "shield-check"
|
||||
---
|
||||
|
||||
Bifrost integrates with **GraySwan Cygnal Monitor** to provide AI safety monitoring with natural language rule definitions and advanced threat detection capabilities. This page covers the configuration and capabilities of the GraySwan Cygnal guardrail provider.
|
||||
|
||||

|
||||
|
||||
## Capabilities
|
||||
|
||||
- **Violation Scoring**: Continuous 0-1 scale violation detection with configurable thresholds
|
||||
- **Custom Natural Language Rules**: Define safety rules in plain English without code
|
||||
- **Policy Management**: Use pre-built policies from GraySwan platform or create custom ones
|
||||
- **Indirect Prompt Injection (IPI) Detection**: Identify hidden instructions in user inputs
|
||||
- **Mutation Detection**: Detect attempts to manipulate or alter content
|
||||
- **Reasoning Modes**: Choose from fast ("off"), balanced ("hybrid"), or thorough ("thinking") analysis
|
||||
|
||||
## Configuration Fields
|
||||
|
||||
| Field | Type | Required | Default | Description |
|
||||
|-------|------|----------|---------|-------------|
|
||||
| `api_key` | string | Yes | - | GraySwan API key |
|
||||
| `violation_threshold` | number | No | 0.5 | Score threshold (0-1) for triggering intervention. Lower values are more strict. |
|
||||
| `reasoning_mode` | enum | No | "off" | Analysis depth: `off` (fastest), `hybrid` (balanced), or `thinking` (most thorough) |
|
||||
| `policy_id` | string | No | - | Single custom policy ID from GraySwan platform |
|
||||
| `policy_ids` | array | No | - | Multiple policy IDs for aggregated rule evaluation |
|
||||
| `rules` | object | No | - | Custom natural language rules as key-value pairs |
|
||||
|
||||
## Custom Rules Example
|
||||
|
||||

|
||||
|
||||
Rules are defined as key-value pairs where the key is the rule name and the value is a natural language description:
|
||||
|
||||
```json
|
||||
{
|
||||
"rules": {
|
||||
"no_profanity": "Do not allow profanity or vulgar language",
|
||||
"no_pii": "Do not allow personally identifiable information",
|
||||
"professional_tone": "Ensure all responses maintain a professional tone"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Detection Features
|
||||
|
||||
- Real-time violation scoring
|
||||
- Multi-rule evaluation
|
||||
- IPI attack detection
|
||||
- Content mutation monitoring
|
||||
- Detailed violation descriptions with rule attribution
|
||||
|
||||
## Provider Capabilities Comparison
|
||||
|
||||
| Capability | AWS Bedrock | Azure Content Safety | GraySwan | Patronus AI |
|
||||
|------------|-------------|---------------------|----------|-------------|
|
||||
| PII Detection | Yes | No | No | Yes |
|
||||
| Content Filtering | Yes | Yes | Yes | Yes |
|
||||
| Prompt Injection | Yes | Yes | Yes | Yes |
|
||||
| Hallucination Detection | No | No | No | Yes |
|
||||
| Toxicity Screening | Yes | Yes | Yes | Yes |
|
||||
| Custom Policies | Yes | Yes | Yes | Yes |
|
||||
| Custom Natural Language Rules | No | No | Yes | No |
|
||||
| Image Support | Yes | No | No | No |
|
||||
| IPI Detection | No | Yes | Yes | No |
|
||||
| Mutation Detection | No | No | Yes | No |
|
||||
|
||||
For information on configuring guardrail rules and profiles, see [Guardrails](/enterprise/guardrails).
|
||||
40
docs/integrations/guardrails/patronus-ai.mdx
Normal file
40
docs/integrations/guardrails/patronus-ai.mdx
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: "Patronus AI"
|
||||
description: "Integrate Patronus AI with Bifrost for LLM security and safety including hallucination detection, PII identification, toxicity screening, and custom evaluators."
|
||||
icon: "brain"
|
||||
---
|
||||
|
||||
Bifrost integrates with **Patronus AI** to provide specialized LLM security and safety with advanced evaluation capabilities. This page covers the configuration and capabilities of the Patronus AI guardrail provider.
|
||||
|
||||
## Capabilities
|
||||
|
||||
- **Hallucination Detection**: Identify factually incorrect responses
|
||||
- **PII Detection**: Comprehensive personal data identification
|
||||
- **Toxicity Screening**: Multi-language toxic content detection
|
||||
- **Prompt Injection Defense**: Advanced attack pattern recognition
|
||||
- **Custom Evaluators**: Build organization-specific safety checks
|
||||
- **Real-Time Monitoring**: Continuous safety validation
|
||||
|
||||
## Advanced Features
|
||||
|
||||
- Context-aware evaluation
|
||||
- Multi-turn conversation analysis
|
||||
- Custom policy templates
|
||||
- Integration with existing safety workflows
|
||||
|
||||
## Provider Capabilities Comparison
|
||||
|
||||
| Capability | AWS Bedrock | Azure Content Safety | GraySwan | Patronus AI |
|
||||
|------------|-------------|---------------------|----------|-------------|
|
||||
| PII Detection | Yes | No | No | Yes |
|
||||
| Content Filtering | Yes | Yes | Yes | Yes |
|
||||
| Prompt Injection | Yes | Yes | Yes | Yes |
|
||||
| Hallucination Detection | No | No | No | Yes |
|
||||
| Toxicity Screening | Yes | Yes | Yes | Yes |
|
||||
| Custom Policies | Yes | Yes | Yes | Yes |
|
||||
| Custom Natural Language Rules | No | No | Yes | No |
|
||||
| Image Support | Yes | No | No | No |
|
||||
| IPI Detection | No | Yes | Yes | No |
|
||||
| Mutation Detection | No | No | Yes | No |
|
||||
|
||||
For information on configuring guardrail rules and profiles, see [Guardrails](/enterprise/guardrails).
|
||||
Reference in New Issue
Block a user