是否在编译图结构时自动验证。默认为 true。
图中的通道,将通道名称映射到其 BaseChannel 或 ManagedValueSpec 实例
可选
checkpointer用于持久化图状态的可选检查点程序。如果提供,则在每个超级步骤保存图状态的检查点。当为 false 或未定义时,禁用检查点,并且图将无法保存或恢复状态。
可选
config图执行的默认配置,可以在每次调用时覆盖
是否启用调试日志记录。默认为 false。
图的输入通道。当调用图时,这些通道接收初始输入。可以是单个通道键或通道键数组。
可选
interrupt可选的节点名称数组或 “all”,用于在执行这些节点后中断。用于实现人机环路工作流。
可选
interrupt可选的节点名称数组或 “all”,用于在执行这些节点之前中断。用于实现人机环路工作流。
受保护的
lc_可选
name图中的节点,将节点名称映射到其 PregelNode 实例
图的输出通道。当图完成时,这些通道包含最终输出。可以是单个通道键或通道键数组。
可选
retry用于处理节点执行失败的可选重试策略
可选
step每个超级步骤执行的可选超时时间,以毫秒为单位
可选
store图的可选长期内存存储,允许跨线程持久化和检索数据
可选
stream可选的流式传输通道。如果未指定,将流式传输所有通道。可以是一个单独的通道键或一个通道键数组。
为此图启用的流式传输模式。默认为 ["values"]。支持的模式包括
构造函数参数别名映射。键是属性名称,例如 "foo"。值是将替换序列化中键的别名。这用于例如使参数名称与 Python 匹配。
要与构造函数参数合并的其他属性的映射。键是属性名称,例如 "foo"。值是将被序列化的属性值。这些属性需要被构造函数接受为参数。
模块的最终序列化标识符。
密钥的映射,在序列化时将被省略。键是构造函数参数中密钥的路径,例如 "foo.bar.baz"。值是密钥 ID,反序列化时将使用该 ID。
应序列化的键的手动列表。如果未覆盖,则所有传递到构造函数中的字段都将被序列化。
用于处理可运行对象的批处理和配置的内部方法。它接受一个函数、输入值和可选配置,并返回一个 Promise,该 Promise 解析为输出值。
要为每个输入值执行的函数。
可选
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>>[]可选
runManagers: (undefined | CallbackManagerForChainRun)[]可选
batchOptions: RunnableBatchOptions可选
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>> & { 可选
batchOptions: RunnableBatchOptions解析为输出值的 Promise。
受保护
_call可选
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>> & { 受保护
_get受保护
_separate可选
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>>Protected
_streamProtected
_transform辅助方法,用于将输入值的迭代器转换为输出值的迭代器,并带有回调。使用此方法在 Runnable 子类中实现 stream()
或 transform()
。
Optional
runManager: CallbackManagerForChainRun可选
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>>可选
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>> & { 将 runnable 转换为工具。返回 RunnableToolLike
的新实例,其中包含 runnable、名称、描述和模式。
RunnableToolLike
的实例,它是一个可以用作工具的 runnable。
Optional
options: { Optional
with批处理的默认实现,它调用 invoke N 次。如果子类可以更有效地进行批处理,则应重写此方法。
每次批处理调用的输入数组。
Optional
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>> | Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>>要应用于每个批处理调用的单个调用选项对象,或每次调用的数组。
Optional
batchOptions: RunnableBatchOptions & { RunOutput 的数组,如果设置了 batchOptions.returnExceptions,则为混合的 RunOutput 和错误
Optional
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>> | Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>>Optional
batchOptions: RunnableBatchOptions & { Optional
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>> | Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>>可选
batchOptions: RunnableBatchOptions将参数绑定到一个 Runnable,返回一个新的 Runnable。
一个新的 RunnableBinding,当被调用时,将应用绑定的参数。
获取图的当前状态。需要配置一个检查点。
用于检索状态的配置
Optional
options: GetStateOptions附加选项
当前图状态的快照
如果未配置检查点
获取图状态的历史记录。需要配置一个检查点。适用于
用于检索历史记录的配置
Optional
options: CheckpointListOptions用于过滤历史记录的选项
状态快照的异步迭代器
如果未配置检查点
获取此图中的所有子图。子图是嵌套在此图的节点内的 Pregel 实例。
Optional
namespace: string用于过滤子图的可选命名空间
Optional
recurse: boolean是否递归获取子图的子图
生成器,产生 [name, subgraph] 元组
请使用 getSubgraphsAsync 代替。异步方法将在下一个次要版本中成为默认方法。
异步获取此图中的所有子图。子图是嵌套在此图的节点内的 Pregel 实例。
Optional
namespace: string用于过滤子图的可选命名空间
Optional
recurse: boolean是否递归获取子图的子图
AsyncGenerator,产生 [name, subgraph] 元组
使用单个输入和配置运行图。
图的输入。
可选
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>>用于运行的配置。
返回一个新的 Runnable,它通过对每个输入调用 invoke(),将输入列表映射到输出列表。
创建一个新的 runnable 序列,它串行运行每个单独的 runnable,并将一个 runnable 的输出通过管道传输到另一个 runnable 或类似 runnable 的对象。
一个 runnable、函数或对象,其值是函数或 runnables。
一个新的 runnable 序列。
流式传输图的执行过程,并在状态更新发生时发出更新。这是实时观察图执行情况的主要方法。
流模式
更多详情,请参阅Streaming how-to guides。
启动图执行的输入
可选
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>>流式处理的配置选项
图状态更新的异步可迭代流
生成由可运行对象的内部步骤发出的事件流。
用于创建 StreamEvents 的迭代器,该迭代器提供关于可运行对象进度的实时信息,包括来自中间结果的 StreamEvents。
StreamEvent 是一个具有以下模式的字典
event
: string - 事件名称的格式为:on_[runnable_type]_(start|stream|end)。name
: string - 生成事件的可运行对象的名称。run_id
: string - 与发出事件的可运行对象的给定执行相关联的随机生成的 ID。作为父可运行对象执行的一部分而被调用的子可运行对象会被分配其自己唯一的 ID。tags
: string[] - 生成事件的可运行对象的标签。metadata
: Record<string, any> - 生成事件的可运行对象的元数据。data
: Record<string, any>下面是一个表格,说明了各种链可能发出的一些事件。为了简洁起见,表格中省略了元数据字段。链定义已包含在表格之后。
注意 此参考表适用于模式的 V2 版本。
+----------------------+-----------------------------+------------------------------------------+
| event | input | output/chunk |
+======================+=============================+==========================================+
| on_chat_model_start | {"messages": BaseMessage[]} | |
+----------------------+-----------------------------+------------------------------------------+
| on_chat_model_stream | | AIMessageChunk("hello") |
+----------------------+-----------------------------+------------------------------------------+
| on_chat_model_end | {"messages": BaseMessage[]} | AIMessageChunk("hello world") |
+----------------------+-----------------------------+------------------------------------------+
| on_llm_start | {'input': 'hello'} | |
+----------------------+-----------------------------+------------------------------------------+
| on_llm_stream | | 'Hello' |
+----------------------+-----------------------------+------------------------------------------+
| on_llm_end | 'Hello human!' | |
+----------------------+-----------------------------+------------------------------------------+
| on_chain_start | | |
+----------------------+-----------------------------+------------------------------------------+
| on_chain_stream | | "hello world!" |
+----------------------+-----------------------------+------------------------------------------+
| on_chain_end | [Document(...)] | "hello world!, goodbye world!" |
+----------------------+-----------------------------+------------------------------------------+
| on_tool_start | {"x": 1, "y": "2"} | |
+----------------------+-----------------------------+------------------------------------------+
| on_tool_end | | {"x": 1, "y": "2"} |
+----------------------+-----------------------------+------------------------------------------+
| on_retriever_start | {"query": "hello"} | |
+----------------------+-----------------------------+------------------------------------------+
| on_retriever_end | {"query": "hello"} | [Document(...), ..] |
+----------------------+-----------------------------+------------------------------------------+
| on_prompt_start | {"question": "hello"} | |
+----------------------+-----------------------------+------------------------------------------+
| on_prompt_end | {"question": "hello"} | ChatPromptValue(messages: BaseMessage[]) |
+----------------------+-----------------------------+------------------------------------------+
“on_chain_*”事件是对于不属于上述任何类别的 Runnables 的默认事件。
除了上面的标准事件之外,用户还可以分派自定义事件。
自定义事件将仅在 API 的 v2
版本中公开!
自定义事件具有以下格式
+-----------+------+------------------------------------------------------------+
| Attribute | Type | Description |
+===========+======+============================================================+
| name | str | A user defined name for the event. |
+-----------+------+------------------------------------------------------------+
| data | Any | The data associated with the event. This can be anything. |
+-----------+------+------------------------------------------------------------+
这是一个例子
import { RunnableLambda } from "@langchain/core/runnables";
import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch";
// Use this import for web environments that don't support "async_hooks"
// and manually pass config to child runs.
// import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch/web";
const slowThing = RunnableLambda.from(async (someInput: string) => {
// Placeholder for some slow operation
await new Promise((resolve) => setTimeout(resolve, 100));
await dispatchCustomEvent("progress_event", {
message: "Finished step 1 of 2",
});
await new Promise((resolve) => setTimeout(resolve, 100));
return "Done";
});
const eventStream = await slowThing.streamEvents("hello world", {
version: "v2",
});
for await (const event of eventStream) {
if (event.event === "on_custom_event") {
console.log(event);
}
}
Optional
streamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">Optional
streamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">流式传输来自可运行对象的所有输出,如同报告给回调系统一样。这包括 LLM、检索器、工具等的所有内部运行。输出作为 Log 对象流式传输,其中包括 jsonpatch ops 列表,这些 ops 描述了运行状态在每个步骤中是如何变化的,以及运行的最终状态。可以应用 jsonpatch ops 以构造状态。
可选
options: Partial<PregelOptions<Record<"__start__" | N, PregelNode<S, U>>, Record<string | N, BaseChannel<unknown, unknown, unknown>>, StateType<C> & Record<string, any>>>Optional
streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">transform 的默认实现,它缓冲输入,然后调用 stream。如果子类可以在仍在生成输入时开始生成输出,则应覆盖此方法。
使用新值更新图的状态。需要配置检查点。
此方法可用于
更新的配置
用于更新状态的值
Optional
asNode: string | N用于将更新归因于的可选节点名称
更新的配置
如果未配置检查点
如果更新不能归因于节点
使用更新的配置创建 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。
将生命周期监听器绑定到 Runnable,返回一个新的 Runnable。 Run 对象包含有关运行的信息,包括其 id、类型、输入、输出、错误、startTime、endTime 以及添加到运行的任何标签或元数据。
包含回调函数的对象。
Optional
on在可运行对象完成运行后调用,使用 Run 对象。
可选
config: RunnableConfig<Record<string, any>>可选
on当 runnable 抛出错误时调用,并传入 Run 对象。
可选
config: RunnableConfig<Record<string, any>>可选
on在 runnable 开始运行前调用,并传入 Run 对象。
可选
config: RunnableConfig<Record<string, any>>为现有的 runnable 添加重试逻辑。
可选
fields: { 可选
on可选
stop一个新的 RunnableRetry,当被调用时,将根据参数进行重试。
静态
is
构建和编译 StateGraph 的最终结果。不应直接实例化,仅应使用 StateGraph 的
.compile()
实例方法。