类 Pregel<Nodes, Channels, ConfigurableFieldType, InputType, OutputType, StreamUpdatesType, StreamValuesType>

Pregel 类是 LangGraph 的核心运行时引擎,它实现了受 Google 的 Pregel 系统启发的消息传递图计算模型。它为构建可靠、可控的代理工作流奠定了基础,这些工作流可以随时间演变状态。

主要特点

  • 离散“超步”中节点间的消息传递
  • 通过检查点器实现内置持久化层
  • 对值、更新和事件的一流流式支持
  • 通过中断实现人机协作能力
  • 支持超步内的并行节点执行

Pregel 类不应由消费者直接实例化。请改用以下更高级的 API

  • StateGraph: 用于构建代理工作流的主要图类
  • 函数式 API:使用任务和入口点的声明式方法
    • entrypoint 函数返回一个 Pregel 实例

示例

// Using StateGraph API
const graph = new StateGraph(annotation)
.addNode("nodeA", myNodeFunction)
.addEdge("nodeA", "nodeB")
.compile();

// The compiled graph is a Pregel instance
const result = await graph.invoke(input);

示例

// Using Functional API
import { task, entrypoint } from "@langchain/langgraph";
import { MemorySaver } from "@langchain/langgraph-checkpoint";

// Define tasks that can be composed
const addOne = task("add", async (x: number) => x + 1);

// Create a workflow using the entrypoint function
const workflow = entrypoint({
name: "workflow",
checkpointer: new MemorySaver()
}, async (numbers: number[]) => {
// Tasks can be run in parallel
const results = await Promise.all(numbers.map(n => addOne(n)));
return results;
});

// The workflow is a Pregel instance
const result = await workflow.invoke([1, 2, 3]); // Returns [2, 3, 4]

类型参数

继承关系 (查看完整)

实现

属性

autoValidate: boolean

编译图结构时是否自动验证。默认为 true。

cache?: BaseCache<unknown>

图的可选缓存,用于缓存任务。

channels: Channels

图中的通道,将通道名称映射到其 BaseChannel 或 ManagedValueSpec 实例

checkpointer?: false | BaseCheckpointSaver<number>

用于持久化图状态的可选检查点器。如果提供,则在每个超步保存图状态的检查点。如果为 false 或未定义,则禁用检查点,图将无法保存或恢复状态。

config?: LangGraphRunnableConfig<Record<string, any>>

图执行的默认配置,可以按每次调用进行覆盖

debug: boolean

是否启用调试日志。默认为 false。

inputChannels: keyof Channels | (keyof Channels)[]

图的输入通道。当图被调用时,这些通道接收初始输入。可以是单个通道键或通道键数组。

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

可选的节点名称数组或“*”,用于在执行这些节点后中断。用于实现人机协作工作流。

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

可选的节点名称数组或“*”,用于在执行这些节点前中断。用于实现人机协作工作流。

lc_kwargs: SerializedFields
lc_runnable: boolean
lc_serializable: boolean
name?: string
nodes: Nodes

图中的节点,将节点名称映射到其 PregelNode 实例

outputChannels: keyof Channels | (keyof Channels)[]

图的输出通道。当图完成时,这些通道包含最终输出。可以是单个通道键或通道键数组。

retryPolicy?: RetryPolicy

用于处理节点执行失败的可选重试策略

stepTimeout?: number

每个超步执行的可选超时时间(毫秒)

store?: BaseStore

图的可选长期内存存储,允许跨线程持久化和检索数据

streamChannels?: keyof Channels | (keyof Channels)[]

可选的流式传输通道。如果未指定,将流式传输所有通道。可以是单个通道键或通道键数组。

streamMode: StreamMode[]

此图启用的流式传输模式。默认为 ["values"]。支持的模式

  • "values":在每个步骤后流式传输完整状态
  • "updates":在每个步骤后流式传输状态更新
  • "messages":从节点内部流式传输消息
  • "custom":从节点内部流式传输自定义事件
  • "debug":流式传输与图执行相关的事件——用于追踪和调试图执行
triggerToNodes: Record<string, string[]>

访问器

  • get lc_aliases(): undefined | {
        [key: string]: string;
    }
  • 构造函数参数的别名映射。键是属性名称,例如“foo”。值是序列化中将替换键的别名。这用于例如使参数名称与 Python 匹配。

    返回 undefined | {
        [key: string]: string;
    }

  • get lc_attributes(): undefined | SerializedFields
  • 与构造函数参数合并的附加属性映射。键是属性名称,例如“foo”。值是属性值,将被序列化。这些属性需要被构造函数接受为参数。

    返回 undefined | SerializedFields

  • get lc_id(): string[]
  • 模块的最终序列化标识符。

    返回 string[]

  • get lc_secrets(): undefined | {
        [key: string]: string;
    }
  • 秘密映射,将从序列化中省略。键是构造函数参数中秘密的路径,例如“foo.bar.baz”。值是秘密 ID,将在反序列化时使用。

    返回 undefined | {
        [key: string]: string;
    }

  • get lc_serializable_keys(): undefined | string[]
  • 应序列化的手动键列表。如果未覆盖,则所有传递给构造函数的字段都将被序列化。

    返回 undefined | string[]

  • get streamChannelsAsIs(): keyof Channels | (keyof Channels)[]
  • 获取以原始格式流式传输的通道。如果指定了 `streamChannels`,则按原样返回(单个键或数组)。否则,将图中所有通道作为数组返回。

    返回 keyof Channels | (keyof Channels)[]

    要流式传输的通道键,可以是单个键或数组

  • get streamChannelsList(): (keyof Channels)[]
  • 获取应流式传输的所有通道列表。如果指定了 `streamChannels`,则返回这些通道。否则,返回图中所有通道。

    返回 (keyof Channels)[]

    要流式传输的通道键数组

方法

  • 处理可运行对象的批处理和配置的内部方法。它接受一个函数、输入值和可选配置,并返回一个解析为输出值的 Promise。

    类型参数

    • T

    参数

    返回 Promise<(Error | OutputType)[]>

    解析为输出值的 Promise。

  • 类型参数

    参数

    • options: Partial<O> | Partial<O>[]
    • Optional length: number

    返回 Partial<O>[]

  • 参数

    返回 AsyncGenerator<RunLogPatch, any, any>

  • 辅助方法,用于将输入值迭代器转换为输出值迭代器,并带有回调。用于在 Runnable 子类中实现 stream()transform()

    类型参数

    • I
    • O

    参数

    继承自 PartialRunnable._transformStreamWithConfig

  • 将可运行对象转换为工具。返回一个 RunnableToolLike 的新实例,其中包含可运行对象、名称、描述和模式。

    类型参数

    参数

    • fields: {
          description?: string;
          name?: string;
          schema: ZodType<T, ZodTypeDef, T>;
      }
      • 可选 description?: string

        工具的描述。如果未提供,则回退到Zod模式上的描述,如果两者都未提供,则为未定义。

      • 可选 name?: string

        工具的名称。如果未提供,它将默认为可运行对象的名称。

      • schema: ZodType<T, ZodTypeDef, T>

        工具输入的Zod模式。从可运行对象的输入类型推断Zod类型。

    返回 RunnableToolLike<ZodType<ToolCall | T, ZodTypeDef, ToolCall | T>, OutputType>

    一个 RunnableToolLike 实例,它是一个可以作为工具使用的可运行对象。

  • 为此可运行对象的字典输出分配新字段。返回一个新的可运行对象。

    参数

    • mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

    返回 Runnable<any, any, RunnableConfig<Record<string, any>>>

  • 返回 Promise<void>

  • 参数

    • 可选 _: RunnableConfig<Record<string, any>>

    返回 Graph

  • 获取图结构的图示表示。这是 getGraph() 的异步版本,是首选方法。

    参数

    • config: RunnableConfig<Record<string, any>>

      用于生成图可视化的配置

    返回 Promise<Graph>

    可以可视化的图表示

  • 参数

    • 可选 suffix: string

    返回 string

  • 获取图的当前状态。需要配置检查点。

    参数

    • config: RunnableConfig<Record<string, any>>

      用于检索状态的配置

    • 可选 options: GetStateOptions

      附加选项

    返回 Promise<StateSnapshot>

    当前图状态的快照

    抛出

    如果没有配置检查点

  • 获取图状态的历史记录。需要配置检查点。适用于

    • 调试执行历史
    • 实现时间旅行
    • 分析图行为

    参数

    • config: RunnableConfig<Record<string, any>>

      用于检索历史记录的配置

    • 可选 options: CheckpointListOptions

      过滤历史记录的选项

    返回 AsyncIterableIterator<StateSnapshot, any, any>

    状态快照的异步迭代器

    抛出

    如果没有配置检查点

  • 获取此图中的所有子图。子图是嵌套在此图节点内的Pregel实例。

    参数

    • 可选 namespace: string

      可选的命名空间,用于过滤子图

    • 可选 recurse: boolean

      是否递归获取子图的子图

    返回 Generator<[string, Pregel<any, any, StrRecord<string, any>, any, any, any, any>], any, any>

    生成器,生成 [名称, 子图] 的元组

    已弃用

    请改用 getSubgraphsAsync。异步方法将在下一个次要版本中成为默认方法。

  • 异步获取此图中的所有子图。子图是嵌套在此图节点内的Pregel实例。

    参数

    • 可选 namespace: string

      可选的命名空间,用于过滤子图

    • 可选 recurse: boolean

      是否递归获取子图的子图

    返回 AsyncGenerator<[string, Pregel<any, any, StrRecord<string, any>, any, any, any, any>], any, any>

    生成 [名称, 子图] 元组的异步生成器

  • 从此可运行对象的字典输出中选择键。返回一个新的可运行对象。

    参数

    • keys: string | string[]

    返回 Runnable<any, any, RunnableConfig<Record<string, any>>>

  • 创建一个新的可运行序列,该序列按顺序运行每个单独的可运行对象,将一个可运行对象的输出传递给另一个可运行对象或类似可运行的对象。

    类型参数

    • NewRunOutput

    参数

    • coerceable: RunnableLike<OutputType, NewRunOutput, RunnableConfig<Record<string, any>>>

      一个可运行对象、函数或其值为函数或可运行对象的对象。

    返回 Runnable<null | InputType | Command<unknown, Record<string, unknown>, string>, Exclude<NewRunOutput, Error>, RunnableConfig<Record<string, any>>>

    一个新的可运行序列。

  • 参数

    返回 IterableReadableStream<StreamEvent>

    继承文档

  • 参数

    返回 IterableReadableStream<Uint8Array<ArrayBufferLike>>

  • 从可运行对象流式传输所有输出,如回调系统所报告。这包括LLM、检索器、工具等的所有内部运行。输出作为日志对象流式传输,其中包含描述运行状态如何在每个步骤中更改的jsonpatch操作列表,以及运行的最终状态。jsonpatch操作可以按顺序应用以构建状态。

    参数

    返回 AsyncGenerator<RunLogPatch, any, any>

  • 返回 Serialized

  • 返回 SerializedNotImplemented

  • transform 的默认实现,它会缓冲输入然后调用流式处理。如果子类可以在输入仍在生成时开始产生输出,则应重写此方法。

    参数

    返回 AsyncGenerator<OutputType, any, any>

  • 用新值更新图的状态。需要配置检查点。

    此方法可用于

    • 实现人机协作流程
    • 在断点期间修改图状态
    • 将外部输入集成到图中

    参数

    • inputConfig: LangGraphRunnableConfig<Record<string, any>>

      更新的配置

    • values: unknown

      用于更新状态的值

    • 可选 asNode: string | keyof Nodes

      可选的节点名称,用于归因更新

    返回 Promise<RunnableConfig<Record<string, any>>>

    更新的配置

    抛出

    如果没有配置检查点

    抛出

    如果更新无法归因于某个节点

  • 验证图结构以确保其格式良好。检查以下内容:

    • 没有孤立节点
    • 有效的输入/输出通道配置
    • 有效的中断配置

    返回 this

    this - 用于方法链式调用的 Pregel 实例

    抛出

    如果图结构无效

  • 从当前可运行对象创建一个新的可运行对象,如果初始调用失败,它将尝试调用其他传入的备用可运行对象。

    参数

    • fields: {
          fallbacks: Runnable<null | InputType | Command<unknown, Record<string, unknown>, string>, OutputType, RunnableConfig<Record<string, any>>>[];
      } | Runnable<null | InputType | Command<unknown, Record<string, unknown>, string>, OutputType, RunnableConfig<Record<string, any>>>[]

    返回 RunnableWithFallbacks<null | InputType | Command<unknown, Record<string, unknown>, string>, OutputType>

    一个新的 RunnableWithFallbacks。

  • 将生命周期监听器绑定到可运行对象,返回一个新的可运行对象。Run 对象包含关于运行的信息,包括其 id、类型、输入、输出、错误、startTime、endTime 以及添加到运行的任何标签或元数据。

    参数

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      包含回调函数的对象。

      • Optional onEnd?: ((run, config?) => void | Promise<void>)

        在可运行对象运行结束后调用,传入 Run 对象。

          • (run, config?): void | Promise<void>
          • 参数

            • run: Run
            • Optional config: RunnableConfig<Record<string, any>>

            返回 void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)

        如果可运行对象抛出错误,则调用此函数,传入 Run 对象。

          • (run, config?): void | Promise<void>
          • 参数

            • run: Run
            • Optional config: RunnableConfig<Record<string, any>>

            返回 void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)

        在可运行对象开始运行前调用,传入 Run 对象。

          • (run, config?): void | Promise<void>
          • 参数

            • run: Run
            • Optional config: RunnableConfig<Record<string, any>>

            返回 void | Promise<void>

    返回 Runnable<null | InputType | Command<unknown, Record<string, unknown>, string>, OutputType, PregelOptions<Nodes, Channels, ConfigurableFieldType, undefined | StreamMode | StreamMode[], boolean>>

  • 参数

    • thing: any

    返回 thing is Runnable<any, any, RunnableConfig<Record<string, any>>>