Menu
Language
Theme
interface PregelOptionsRunnableConfig<ContextType>Configuration options for executing a Pregel graph. These options control how the graph executes, what data is streamed, and how interrupts are handled.
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.
The run ID for the current execution. Undefined when runId is not provided in the config.
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:
Whether to checkpoint intermediate steps, defaults to true.
If false, only the final checkpoint is saved.
// Stream only the 'result' channel
outputKeys: "result"
// Stream multiple channels
outputKeys: ["result", "intermediateState"]