PregelOptions

Optional cache for the graph, useful for caching tasks.

User provided context

Whether to enable debug logging. Defaults to false.

Whether to checkpoint during the run (or only at the end/interruption).

• "async": Save checkpoint asynchronously while the next step executes (default).
• "sync": Save checkpoint synchronously before the next step starts.
• "exit": Save checkpoint only when the graph exits.

The encoding to use for the stream.

• undefined: Use the default format.
• "text/event-stream": Use the Server-Sent Events format.

Specifies which channel keys to retrieve from the checkpoint when resuming execution. This is an advanced option that you generally don't need to set manually. The graph will automatically determine the appropriate input keys based on its configuration.

Optional array of node names or "all" to interrupt after executing these nodes. Used for implementing human-in-the-loop workflows.

Optional array of node names or "all" to interrupt before executing these nodes. Used for implementing human-in-the-loop workflows.

Specifies which channel keys to include in the output stream and final result. Use this to filter which parts of the graph state you want to observe.

Abort signal to cancel the run.

Optional long-term memory store for the graph, allows for persistence & retrieval of data across threads

The streaming modes enabled for this graph. Defaults to ["values"]. Supported modes:

• "values": Streams the full state after each step
• "updates": Streams state updates after each step
• "messages": Streams messages from within nodes
• "custom": Streams custom events from within nodes
• "debug": Streams events related to the execution of the graph - useful for tracing & debugging graph execution