Class AiRedactor

java.lang.Object

com.kingsrook.qqq.backend.core.actions.ai.output.AiRedactor

public class AiRedactor
extends Object

Replaces secrets and PII in values sent to a model with [REDACTED:kind]: private keys, JWTs, API keys (sk-...), AWS access keys and (labelled) secret keys, US social security numbers, payment card numbers (Luhn-valid, 13-19 digits) and any custom patterns (kind "custom"). Runs on every string value before truncation, so a long secret is never left half-redacted by a cut.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KIND_API_KEY
static final String	KIND_AWS_KEY
static final String	KIND_AWS_SECRET
static final String	KIND_CARD_NUMBER
static final String	KIND_CUSTOM
static final String	KIND_JWT
static final String	KIND_PRIVATE_KEY
static final String	KIND_SSN

Constructor Summary

Constructors

Constructor	Description
AiRedactor(Collection<Pattern> customPatterns)	Constructor

Method Summary

Modifier and Type	Method	Description
String	redact(String value, Set<String> redactedKinds)	Redact a value - adding the kind of each redaction made to redactedKinds (which may be null).
static String	replacement(String kind)	The replacement text for a redaction of the given kind.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KIND_PRIVATE_KEY

public static final String KIND_PRIVATE_KEY

See Also:

• Constant Field Values

KIND_JWT

public static final String KIND_JWT

See Also:

• Constant Field Values

KIND_API_KEY

public static final String KIND_API_KEY

See Also:

• Constant Field Values

KIND_AWS_KEY

public static final String KIND_AWS_KEY

See Also:

• Constant Field Values

KIND_AWS_SECRET

public static final String KIND_AWS_SECRET

See Also:

• Constant Field Values

KIND_SSN

public static final String KIND_SSN

See Also:

• Constant Field Values

KIND_CARD_NUMBER

public static final String KIND_CARD_NUMBER

See Also:

• Constant Field Values

KIND_CUSTOM

public static final String KIND_CUSTOM

See Also:

• Constant Field Values

Constructor Details

AiRedactor

public AiRedactor(Collection<Pattern> customPatterns)

Constructor

Method Details

redact

public String redact(String value,
 Set<String> redactedKinds)

Redact a value - adding the kind of each redaction made to redactedKinds (which may be null).

replacement

public static String replacement(String kind)

The replacement text for a redaction of the given kind.