pii

Apply the configured strategy to matches within content.

Detect credit card numbers in content using Luhn validation.

Detect email addresses in content.

Detect IPv4 or IPv6 addresses in content.

Detect MAC addresses in content.

Detect URLs in content using regex and stdlib validation.

Decorator to configure hook behavior in middleware methods.

Use this decorator on before_model or after_model methods in middleware classes to configure their behavior. Currently supports specifying which destinations they can jump to, which establishes conditional edges in the agent graph.

Raised when configured to block on detected sensitive values.

Represents an individual match of sensitive data.

Configuration for handling a single PII type.

Resolved redaction rule ready for execution.

Base middleware class for an agent.

Subclass this and implement any of the defined methods to customize agent behavior between steps in the main agent loop.

State schema for the agent.

Detect and handle Personally Identifiable Information (PII) in conversations.

This middleware detects common PII types and applies configurable strategies to handle them. It can detect emails, credit cards, IP addresses, MAC addresses, and URLs in both user input and agent output.

Built-in PII types:

• email: Email addresses
• credit_card: Credit card numbers (validated with Luhn algorithm)
• ip: IP addresses (validated with stdlib)
• mac_address: MAC addresses
• url: URLs (both http/https and bare URLs)

Strategies:

• block: Raise an exception when PII is detected
• redact: Replace PII with [REDACTED_TYPE] placeholders
• mask: Partially mask PII (e.g., ****-****-****-1234 for credit card)
• hash: Replace PII with deterministic hash (e.g., <email_hash:a1b2c3d4>)

Strategy Selection Guide: