Skip to content

YAML Configuration

Complete reference for YAML configuration options.

Full Example

# oxideshield.yaml

# Guard configuration
guards:
  pattern:
    enabled: true
    severity_threshold: medium
    custom_patterns:
      - pattern: "internal only"
        category: proprietary
        severity: high

  length:
    enabled: true
    max_chars: <your_limit>  # Configure based on your use case
    max_tokens: <your_limit>  # Configure based on your model

  encoding:
    enabled: true
    max_unicode_ratio: <threshold>  # Configurable per deployment

  pii:
    enabled: true
    redaction: mask
    block_on_detect: false
    categories:
      - email
      - phone
      - credit_card

  toxicity:
    enabled: true
    threshold: <threshold>  # Adjust sensitivity

  perplexity:
    enabled: false
    threshold: <threshold>  # Adjust sensitivity

# Pipeline configuration
pipeline:
  strategy: fail_fast  # fail_fast, unanimous, majority, weighted
  timeout_ms: <value>  # Set based on latency budget

# Proxy configuration
proxy:
  listen: "0.0.0.0:8080"
  upstreams:
    anthropic:
      url: "https://api.anthropic.com"
      timeout_ms: <value>  # Configure per environment
    openai:
      url: "https://api.openai.com"
      timeout_ms: <value>  # Configure per environment

# Dashboard configuration
dashboard:
  listen: "0.0.0.0:9090"
  cors: true

# Logging
logging:
  level: info
  format: json