Type Alias AiPiiScanResult

AiPiiScanResult:
| { detected: false }
| { detected: true; matchedTypes: string[]; redactedPrompt: string }

Outcome of screening one prompt. On a detection the prompt is replaced by redactedPrompt everywhere it would otherwise be stored, so the audit trail records that a request was refused and why without restating the values that caused it.

Type Declaration

{ detected: false }
{ detected: true; matchedTypes: string[]; redactedPrompt: string }
- detected: true
- matchedTypes: string[]
  
  Entity kinds and custom-rule names that matched. Never the matched values.
- redactedPrompt: string
  
  The prompt with every match replaced by a [REDACTED:<type>] placeholder.

Type Alias AiPiiScanResult

Type Declaration

detected: true

matchedTypes: string[]

redactedPrompt: string

Settings