Guardrail that detects personally identifiable information (PII).

Detects common PII patterns including:

  • Social Security Numbers (SSN)
  • Email addresses
  • Phone numbers
  • Credit card numbers
  • IP addresses
  • Passport numbers
  • Driver's license numbers
const piiGuardrail = new PIIGuardrail({
detectTypes: ['ssn', 'email', 'credit_card'],
severity: GuardrailSeverity.ERROR,
});

const result = await piiGuardrail.evaluate({
content: 'My email is john@example.com and SSN is 123-45-6789',
contentType: 'input',
});

console.log(result.passed); // false
console.log(result.violations?.length); // 2

Implements

  • Guardrail

Constructors

Methods

Properties

Constructors

Methods

  • Evaluate content against this guardrail

    Parameters

    • context: GuardrailContext

      Evaluation context

    Returns Promise<GuardrailResult>

    Result of the evaluation

Properties

name: "pii-detection" = 'pii-detection'

Unique name of the guardrail

description: "Detects personally identifiable information in content" = 'Detects personally identifiable information in content'

Human-readable description

enabled: boolean

Whether this guardrail is enabled