Interface LangGraphRunnableConfig<ConfigurableType>

interface LangGraphRunnableConfig<ConfigurableType> {
    callbacks?: Callbacks;
    configurable?: ConfigurableType;
    maxConcurrency?: number;
    metadata?: Record<string, unknown>;
    recursionLimit?: number;
    runId?: string;
    runName?: string;
    signal?: AbortSignal;
    store?: BaseStore;
    tags?: string[];
    timeout?: number;
    writer?: ((chunk) => void);
}

Type Parameters

  • ConfigurableType extends Record<string, any> = Record<string, any>

Hierarchy

Properties

callbacks? configurable? maxConcurrency? metadata? recursionLimit? runId? runName? signal? store? tags? timeout? writer?

Properties

Optional callbacks

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.

Optional configurable

configurable?: ConfigurableType

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

Optional maxConcurrency

maxConcurrency?: number

Maximum number of parallel calls to make.

Optional metadata

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.

Optional recursionLimit

recursionLimit?: number

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

Optional runId

runId?: string

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

Optional runName

runName?: string

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

Optional signal

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

Optional store

store?: BaseStore

Optional tags

tags?: string[]

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

Optional timeout

timeout?: number

Timeout for this call in milliseconds.

Optional writer

writer?: ((chunk) => void)

Type declaration

    • (chunk): void

    • Parameters

      • chunk: unknown

      Returns void

Settings

Member Visibility

Theme

On This Page

callbacksconfigurablemaxConcurrencymetadatarecursionLimitrunIdrunNamesignalstoretagstimeoutwriter