org.llm4s.agent.guardrails.builtin.PIIDetector
See thePIIDetector companion object
class PIIDetector(val piiTypes: Seq[PIIType], val onFail: GuardrailAction) extends InputGuardrail, OutputGuardrail
Detects Personally Identifiable Information (PII) in text.
Uses regex patterns to detect common PII types including:
- Social Security Numbers (SSN)
- Credit Card Numbers
- Email Addresses
- Phone Numbers
- IP Addresses
- Passport Numbers
- Dates of Birth
Can be configured to:
- Block: Return error when PII is detected (default)
- Fix: Automatically mask PII and continue
- Warn: Log warning and allow processing to continue
Example usage:
// Block on PII detection
val strictDetector = PIIDetector()
// Mask PII automatically
val maskingDetector = PIIDetector(onFail = GuardrailAction.Fix)
// Detect only credit cards and SSNs
val financialDetector = PIIDetector(
piiTypes = Seq(PIIType.CreditCard, PIIType.SSN)
)
Value parameters
- onFail
-
Action to take when PII is detected (default: Block)
- piiTypes
-
The types of PII to detect (default: SSN, CreditCard, Email, Phone)
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
trait OutputGuardrailtrait InputGuardrailtrait Guardrail[String]class Objecttrait Matchableclass Any
Members list
In this article