Interface ArcjetRedactOptions<Detect>

interface ArcjetRedactOptions<Detect> {
    callbacks?: Callbacks;
    configurable?: Record<string, any>;
    contextWindowSize?: number;
    detect?: Detect;
    entities?: ValidEntities<Detect>;
    llm: BaseLLM<BaseLLMCallOptions>;
    maxConcurrency?: number;
    metadata?: Record<string, unknown>;
    recursionLimit?: number;
    replace?: ((entity: undefined extends Detect
        ? ArcjetSensitiveInfoType
        : Detect extends DetectSensitiveInfoEntities<CustomEntities>
            ? ArcjetSensitiveInfoType | CustomEntities
            : never) => undefined | string);
    runId?: string;
    runName?: string;
    signal?: AbortSignal;
    stop?: string[];
    tags?: string[];
    timeout?: number;
}

Type Parameters

  • Detect

Hierarchy

  • BaseLLMCallOptions
    • ArcjetRedactOptions

Properties

callbacks? configurable? contextWindowSize? detect? entities? llm maxConcurrency? metadata? recursionLimit? replace? runId? runName? signal? stop? tags? timeout?

Properties

Optionalcallbacks

callbacks?: Callbacks

Callbacks for this call and any sub-calls (eg. a Chain calling an LLM). Tags are passed to all callbacks, metadata is passed to handle*Start callbacks.

Optionalconfigurable

configurable?: Record<string, any>

Runtime values for attributes previously made configurable on this Runnable, or sub-Runnables.

OptionalcontextWindowSize

contextWindowSize?: number

Optionaldetect

detect?: Detect

Optionalentities

entities?: ValidEntities<Detect>

llm

llm: BaseLLM<BaseLLMCallOptions>

OptionalmaxConcurrency

maxConcurrency?: number

Maximum number of parallel calls to make.

Optionalmetadata

metadata?: Record<string, unknown>

Metadata for this call and any sub-calls (eg. a Chain calling an LLM). Keys should be strings, values should be JSON-serializable.

OptionalrecursionLimit

recursionLimit?: number

Maximum number of times a call can recurse. If not provided, defaults to 25.

Optionalreplace

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

OptionalrunId

runId?: string

Unique identifier for the tracer run for this call. If not provided, a new UUID will be generated.

OptionalrunName

runName?: string

Name for the tracer run for this call. Defaults to the name of the class.

Optionalsignal

signal?: AbortSignal

Abort signal for this call. If provided, the call will be aborted when the signal is aborted.

See

https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal

Optionalstop

stop?: string[]

Stop tokens to use for this call. If not provided, the default stop tokens for the model will be used.

Optionaltags

tags?: string[]

Tags for this call and any sub-calls (eg. a Chain calling an LLM). You can use these to filter calls.

Optionaltimeout

timeout?: number

Timeout for this call in milliseconds.

Settings

Member Visibility

On This Page

Properties