Anchorage API reference
    Preparing search index...

    Interface PiiSecretsOptions

    Configuration for piiSecrets.

    interface PiiSecretsOptions {
        allowlist?: readonly (string | RegExp)[];
        channels?: readonly OutputChannel[];
        detectors?: readonly (
            | "email"
            | "ssn"
            | "phone"
            | "creditCard"
            | "awsAccessKey"
            | "privateKey"
            | "jwt"
            | "secretAssignment"
            | "highEntropy"
        )[];
        entropyThreshold?: number;
        holdBackChars?: number;
        name?: string;
        phases?: readonly PolicyPhase[];
    }
    Index

    Properties

    allowlist? channels? detectors? entropyThreshold? holdBackChars? name? phases?

    Properties

    allowlist?: readonly (string | RegExp)[]

    Exemptions: a match is skipped when its text equals (case-insensitive) an allowlist string, or tests true against an allowlist RegExp. Each entry must be a string or a RegExp; construction keeps its own copy of each RegExp.

    channels?: readonly OutputChannel[]

    Default: ['answer', 'reasoning', 'object'] — leak prevention, matching denyPatterns' default.

    detectors?: readonly (
        | "email"
        | "ssn"
        | "phone"
        | "creditCard"
        | "awsAccessKey"
        | "privateKey"
        | "jwt"
        | "secretAssignment"
        | "highEntropy"
    )[]

    Subset of detector ids to run. Default: all. A present list must be a non-empty array of PII_SECRETS_DETECTOR_IDS members.

    entropyThreshold?: number

    Minimum bits/char for the highEntropy detector. Default 4.5. A present value must be a number greater than 0 and at most the entropy of a candidate that uses each character of the 67-character candidate alphabet equally often (about 6.066), the highest entropy a candidate can reach. A threshold at that maximum still detects such a candidate.

    holdBackChars?: number

    Override the computed hold-back hint (maxEnabledSpan - 1). A present value must be a number of at least 0, or Infinity.

    name?: string

    Policy name used in denials and audit records.

    phases?: readonly PolicyPhase[]

    Agent lifecycle phases to inspect. Default: both input and output.

    Settings

    Member Visibility

    On This Page

    Properties