Interface ArcjetRedactOptions<Detect>

interface ArcjetRedactOptions<Detect> {
    cache?: boolean | BaseCache<Generation[]>;
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    chatModel: BaseChatModel<BaseChatModelCallOptions, AIMessageChunk>;
    contextWindowSize?: number;
    detect?: Detect;
    entities?: ValidEntities<Detect>;
    maxConcurrency?: number;
    maxRetries?: number;
    metadata?: Record<string, unknown>;
    onFailedAttempt?: FailedAttemptHandler;
    replace?: ((entity: undefined extends Detect
        ? ArcjetSensitiveInfoType
        : Detect extends DetectSensitiveInfoEntities<CustomEntities>
            ? ArcjetSensitiveInfoType | CustomEntities
            : never) => undefined | string);
    tags?: string[];
    verbose?: boolean;
}

Type Parameters

  • Detect

Hierarchy

  • BaseChatModelParams
    • ArcjetRedactOptions

Properties

cache? callbackManager? callbacks? chatModel contextWindowSize? detect? entities? maxConcurrency? maxRetries? metadata? onFailedAttempt? replace? tags? verbose?

Properties

Optionalcache

cache?: boolean | BaseCache<Generation[]>

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

chatModel

chatModel: BaseChatModel<BaseChatModelCallOptions, AIMessageChunk>

OptionalcontextWindowSize

contextWindowSize?: number

Optionaldetect

detect?: Detect

Optionalentities

entities?: ValidEntities<Detect>

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

Optionalmetadata

metadata?: Record<string, unknown>

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

Optionalreplace

replace?: ((entity: undefined extends Detect
    ? ArcjetSensitiveInfoType
    : Detect extends DetectSensitiveInfoEntities<CustomEntities>
        ? ArcjetSensitiveInfoType | CustomEntities
        : never) => undefined | string)

Optionaltags

tags?: string[]

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties