@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface RedactOptions

    Options for redactTranscript.

    interface RedactOptions {
        emails?: boolean;
        phones?: boolean;
        ids?: boolean;
        displayNames?: "drop" | "placeholder" | "keep";
        outboundPatterns?: boolean;
        surrogates?: boolean;
        dropStartedAt?: boolean;
        rules?: RedactionRule[];
        allow?: string[];
        map?: RedactionMap;
    }
    Index
    emails? phones? ids? displayNames? outboundPatterns? surrogates? dropStartedAt? rules? allow? map?
    emails?: boolean

    Redact emails in texts (default true).

    phones?: boolean

    Redact phone-like digit runs (7+ digits) in texts (default true).

    ids?: boolean

    Replace chat/sender/message ids with placeholders (default true).

    displayNames?: "drop" | "placeholder" | "keep"

    Display names: 'placeholder' (default) replaces them with <name:N> in the field and in every text; 'drop' removes the field but still redacts the name in texts; 'keep' leaves them untouched.

    outboundPatterns?: boolean

    Apply the email/phone/custom patterns to outbound texts too (default false: outbound texts only get values learned from inbound turns). Replay such a golden with replayTranscript(..., { redact: { ... } }).

    surrogates?: boolean

    Use format-valid surrogates instead of <email:N> / <phone:N> (email1@redacted.invalid, +10000000001), so validation steps in flows accept the redacted input on replay. Default false.

    dropStartedAt?: boolean

    Drop startedAt (the wall-clock start) (default true).

    rules?: RedactionRule[]

    Extra patterns.

    allow?: string[]

    Values that must never be redacted (e.g. a support phone printed by the bot).

    map?: RedactionMap

    Reuse placeholders across transcripts. Mutated in place.

    Settings
    Member Visibility

    On This Page
    Properties