Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/security / / PiiDetectionOptions
Interface: PiiDetectionOptions
Defined in: packages/security/src/guardrails/builtins/pii-detection.ts:77
Options for piiDetection(...).
Stable
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
action? | readonly | "block" | "warn" | "rewrite" | Action to take on a match. Defaults to 'rewrite' (mask the detected substring with [REDACTED:<kind>]). | packages/security/src/guardrails/builtins/pii-detection.ts:86 |
extraPatterns? | readonly | readonly PiiPattern[] | Additional patterns merged with the default catalogue. | packages/security/src/guardrails/builtins/pii-detection.ts:79 |
name? | readonly | string | Override guardrail name. | packages/security/src/guardrails/builtins/pii-detection.ts:90 |
patterns? | readonly | readonly PiiPattern[] | Replace the default catalogue entirely. | packages/security/src/guardrails/builtins/pii-detection.ts:81 |
stage? | readonly | "input" | "output" | Stage the guardrail applies to. Defaults to 'input'. | packages/security/src/guardrails/builtins/pii-detection.ts:88 |