Interface PregelOptions<Nn, Cc, ConfigurableFieldType>

Config for executing the graph.

interface PregelOptions<Nn, Cc, ConfigurableFieldType> {
    callbacks?: Callbacks;
    configurable?: ConfigurableFieldType;
    debug?: boolean;
    inputKeys?: keyof Cc | (keyof Cc)[];
    interruptAfter?: "*" | (keyof Nn)[];
    interruptBefore?: "*" | (keyof Nn)[];
    maxConcurrency?: number;
    metadata?: Record<string, unknown>;
    outputKeys?: keyof Cc | (keyof Cc)[];
    recursionLimit?: number;
    runId?: string;
    runName?: string;
    signal?: AbortSignal;
    store?: BaseStore;
    streamMode?: StreamMode | StreamMode[];
    subgraphs?: boolean;
    tags?: string[];
    timeout?: number;
}

Type Parameters

  • Nn extends StrRecord<string, PregelNode>
  • Cc extends StrRecord<string, BaseChannel | ManagedValueSpec>
  • ConfigurableFieldType extends Record<string, any> = Record<string, any>

Hierarchy

Properties

callbacks? configurable? debug? inputKeys? interruptAfter? interruptBefore? maxConcurrency? metadata? outputKeys? recursionLimit? runId? runName? signal? store? streamMode? subgraphs? tags? timeout?

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?: ConfigurableFieldType

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

Optional debug

debug?: boolean

Enable debug mode for the graph run.

Optional inputKeys

inputKeys?: keyof Cc | (keyof Cc)[]

Optional interruptAfter

interruptAfter?: "*" | (keyof Nn)[]

The nodes to interrupt the graph run after.

Optional interruptBefore

interruptBefore?: "*" | (keyof Nn)[]

The nodes to interrupt the graph run before.

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 outputKeys

outputKeys?: keyof Cc | (keyof Cc)[]

The output keys to retrieve from the graph run.

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

The shared value store

Optional streamMode

streamMode?: StreamMode | StreamMode[]

The stream mode for the graph run. Default is ["values"].

Optional subgraphs

subgraphs?: boolean

Whether to stream subgraphs.

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.

Settings

Member Visibility

Theme

On This Page

callbacksconfigurabledebuginputKeysinterruptAfterinterruptBeforemaxConcurrencymetadataoutputKeysrecursionLimitrunIdrunNamesignalstorestreamModesubgraphstagstimeout