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