节点名称到其 PregelNode 实现的映射
通道名称到其 BaseChannel 或 ManagedValueSpec 实现的映射
可传递给图的可配置字段的类型
图接受的输入值的类型
图产生的输出值的类型
编译时是否自动验证图结构。默认为 true。
图中的通道,将通道名称映射到其 BaseChannel 或 ManagedValueSpec 实例。
可选
checkpointer用于持久化图状态的可选检查点器。提供时,会在每个超步保存图状态的检查点。如果为 false 或 undefined,则禁用检查点功能,图将无法保存或恢复状态。
可选
config图执行的默认配置,可以在每次调用时覆盖。
是否启用调试日志记录。默认为 false。
图的输入通道。当图被调用时,这些通道接收初始输入。可以是单个通道键或通道键数组。
可选
interrupt在执行这些节点后中断的可选节点名称数组或“all”。用于实现人机协作(human-in-the-loop)工作流。
可选
interrupt在执行这些节点前中断的可选节点名称数组或“all”。用于实现人机协作(human-in-the-loop)工作流。
受保护
lc_可选
name图中的节点,将节点名称映射到其 PregelNode 实例。
图的输出通道。当图完成时,这些通道包含最终输出。可以是单个通道键或通道键数组。
可选
retry处理节点执行失败的可选重试策略
可选
step每个超步执行的可选超时时间(毫秒)
可选
store图的可选长期内存存储,允许在线程之间持久化和检索数据。
可选
stream要流式传输的可选通道。如果未指定,则流式传输所有通道。可以是单个通道键或通道键数组。
为此图启用的流式模式。默认为 ["values"]。支持的模式:
构造函数参数别名的映射。键是属性名,例如 "foo"。值是将在序列化中替换键的别名。这用于例如使参数名与 Python 匹配。
要与构造函数参数合并的附加属性的映射。键是属性名,例如 "foo"。值是要序列化的属性值。这些属性需要被构造函数接受为参数。
模块的最终序列化标识符。
密钥的映射,这些密钥将从序列化中省略。键是构造函数参数中密钥的路径,例如 "foo.bar.baz"。值是密钥 ID,将在反序列化时使用。
应序列化的手动键列表。如果未覆盖,则构造函数中传入的所有字段都将被序列化。
内部方法,用于处理可运行对象的批处理和配置。它接受一个函数、输入值和可选配置,并返回一个解析为输出值的 Promise。
对于每个输入值要执行的函数。
可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>>[]可选的
runManagers: (undefined | CallbackManagerForChainRun)[]可选的
batchOptions: RunnableBatchOptions可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType> & { 可选的
batchOptions: RunnableBatchOptions一个解析为输出值的 Promise。
受保护的
_call可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>> & { 受保护的
_get受保护的
_separate可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>>受保护的
_stream受保护的
_transform辅助方法,将输入值迭代器转换为输出值迭代器,并带有回调。使用此方法在 Runnable 子类中实现 stream()
或 transform()
。
可选的
runManager: CallbackManagerForChainRun可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>>可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>> & { 将可运行对象转换为工具。返回一个 RunnableToolLike
的新实例,其中包含可运行对象、名称、描述和 schema。
一个 RunnableToolLike
的实例,它是一个可以用作工具的可运行对象。
批量处理的默认实现,调用 invoke N 次。如果子类可以更有效地进行批量处理,则应覆盖此方法。
每次批量调用输入的数组。
可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>> | Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>>[]单个调用选项对象应用于每次批量调用,或为每次调用提供一个数组。
可选的
batchOptions: RunnableBatchOptions & { RunOutput 数组,如果设置了 batchOptions.returnExceptions,则为 RunOutput 和错误的混合数组。
可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>> | Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>>[]可选的
batchOptions: RunnableBatchOptions & { 可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>> | Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>>[]可选的
batchOptions: RunnableBatchOptions将参数绑定到 Runnable,返回一个新的 Runnable。
一个新的 RunnableBinding,调用时将应用绑定的参数。
获取图的当前状态。需要配置检查点。
获取状态的配置
可选
options: GetStateOptions附加选项
当前图状态的快照
如果未配置检查点
获取图状态的历史记录。需要配置检查点。适用于
获取历史记录的配置
可选
options: CheckpointListOptions过滤历史记录的选项
状态快照的异步迭代器
如果未配置检查点
获取此图中的所有子图。子图是嵌套在此图节点中的 Pregel 实例。
可选
namespace: string用于过滤子图的可选命名空间
可选
recurse: boolean是否递归获取子图的子图
生成器,产生 [名称, 子图] 的元组
请改用 getSubgraphsAsync。异步方法将在下一个次要版本中成为默认方法。
异步获取此图中的所有子图。子图是嵌套在此图节点中的 Pregel 实例。
可选
namespace: string用于过滤子图的可选命名空间
可选
recurse: boolean是否递归获取子图的子图
AsyncGenerator,产生 [名称, 子图] 的元组
使用单个输入和配置运行图。
图的输入。
可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>>运行所使用的配置。
返回一个新的 Runnable,通过对每个输入调用 invoke() 将输入列表映射到输出列表。
创建一个新的 runnable 序列,按顺序运行每个 runnable,将一个 runnable 的输出导入另一个 runnable 或类似 runnable 的对象。
一个 runnable、函数或其值为函数或 runnable 的对象。
一个新的 runnable 序列。
流式传输图的执行过程,并在状态更新发生时发出。这是实时观察图执行的主要方法。
流模式
更多详情,请参见 流传输操作指南。
启动图执行的输入
可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>>流传输的配置选项
图状态更新的异步可迭代流
可选
streamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">可选
streamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">从一个 runnable 流式传输所有输出,这些输出会报告给回调系统。这包括 LLMs、Retrievers、Tools 等所有内部运行。输出以 Log 对象的形式流式传输,Log 对象包含一个 jsonpatch 操作列表,该列表描述了运行状态在每个步骤中如何变化,以及运行的最终状态。可以按顺序应用 jsonpatch 操作来构建状态。
可选的
options: Partial<PregelOptions<Nodes, Channels, ConfigurableFieldType>>可选
streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">transform 的默认实现,它会缓冲输入然后调用 stream。如果子类可以在输入仍在生成时开始产生输出,则应覆盖此方法。
使用新值更新图的状态。需要配置一个检查点。
此方法可用于
更新的配置
用于更新状态的值
可选
asNode: string | keyof Nodes可选的节点名称,用于指定更新归属于哪个节点
更新后的配置
如果未配置检查点
如果更新无法归属于某个节点
使用更新的配置创建 Pregel 图的新实例。此方法遵循不可变模式 - 它不会修改当前实例,而是返回一个包含合并配置的新实例。
要与当前配置合并的配置
一个带有合并配置的新 Pregel 实例
// Create a new instance with debug enabled
const debugGraph = graph.withConfig({ debug: true });
// Create a new instance with a specific thread ID
const threadGraph = graph.withConfig({
configurable: { thread_id: "123" }
});
从当前 runnable 创建一个新的 runnable,如果初始调用失败,它将尝试调用其他传入的备用 (fallback) runnables。
一个新的 RunnableWithFallbacks。
将生命周期监听器绑定到一个 Runnable,返回一个新的 Runnable。Run 对象包含关于运行的信息,包括其 id、类型、输入、输出、错误、startTime、endTime 以及添加到运行中的任何标签或元数据。
包含回调函数的对象。
可选
onrunnable 运行结束时调用,传入 Run 对象。
可选
config: RunnableConfig<Record<string, any>>可选
on如果 runnable 抛出错误时调用,传入 Run 对象。
可选
config: RunnableConfig<Record<string, any>>可选
onrunnable 开始运行前调用,传入 Run 对象。
可选
config: RunnableConfig<Record<string, any>>为现有 runnable 添加重试逻辑。
可选
fields: { 可选
on可选
stop一个新的 RunnableRetry,当被调用时,将根据参数进行重试。
静态
is
Pregel 类是 LangGraph 的核心运行时引擎,实现了受 Google 的 Pregel 系统启发的基于消息传递的图计算模型。它为构建可靠、可控且能随时间演进状态的代理工作流提供了基础。
主要特性
Pregel 类不应由消费者直接实例化。请改用以下更高级别的 API
Pregel
Pregel
实例示例
示例