可选
config剩余
...args: any[]Protected
lc_Optional
namePrivate
runOptional
tags构造函数参数的别名映射。键是属性名称,例如“foo”。值是将在序列化中替换键的别名。这用于例如使参数名称与 Python 匹配。
与构造函数参数合并的附加属性映射。键是属性名称,例如“foo”。值是属性值,这些值将被序列化。这些属性需要被构造函数作为参数接受。
模块的最终序列化标识符。
秘密的映射,将在序列化时省略。键是构造函数参数中秘密的路径,例如“foo.bar.baz”。值是秘密 ID,这些 ID 将在反序列化时使用。
处理可运行程序的批处理和配置的内部方法。它接受一个函数、输入值和可选配置,并返回一个解析为输出值的 Promise。
解析为输出值的 Promise。
Protected
_call受保护
_get受保护
_separate受保护
_stream受保护
_traced受保护
_transform辅助方法,将输入值的迭代器转换为输出值的迭代器,并带回调。使用此方法在 Runnable 子类中实现 stream()
或 transform()
。
batch 的默认实现,它调用 invoke N 次。子类如果能够更有效地批处理,则应覆盖此方法。
要对每个批处理调用进行的输入数组。
可选
options: Partial<RunnableConfig> | Partial<RunnableConfig>[]单个调用选项对象(应用于每个批处理调用)或每个调用的数组。
可选
batchOptions: RunnableBatchOptions & { RunOutputs 数组,或者如果 batchOptions.returnExceptions 设置,则为混合的 RunOutputs 和错误
可选
options: Partial<RunnableConfig> | Partial<RunnableConfig>[]可选
batchOptions: RunnableBatchOptions & { 可选
options: Partial<RunnableConfig> | Partial<RunnableConfig>[]Optional
batchOptions: RunnableBatchOptions创建一个新的 runnable 序列,该序列按顺序运行每个单独的 runnable,将一个 runnable 的输出管道到另一个 runnable 或 runnable-like。
一个 runnable、函数或对象,其值是函数或 runnable。
一个新的 runnable 序列。
生成由 runnable 内部步骤发出的事件流。
用于创建一个 StreamEvents 的迭代器,提供有关 runnable 进度(包括来自中间结果的 StreamEvents)的实时信息。
一个 StreamEvent 是一个字典,具有以下模式
事件
: 字符串 - 事件名称格式为:on_[runnable_type]_(start|stream|end)。名称
: 字符串 - 生成该事件的 runnable 的名称。运行_id
: 字符串 - 与发出该事件的 runnable 的给定执行相关的随机生成的 ID。作为父 runnable 执行的一部分而被调用的子 runnable 被分配了自己的唯一 ID。标签
: 字符串[] - 生成该事件的 runnable 的标签。元数据
: Record<字符串, 任何> - 生成该事件的 runnable 的元数据。数据
: Record<字符串, 任何>下表说明了各种链可能发出的某些事件。为简洁起见,元数据字段已从表格中省略。链定义已包含在表格之后。
注意 此参考表适用于 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。
除了标准事件之外,用户还可以调度自定义事件。
自定义事件将仅在 v2
版本的 API 中显示!
自定义事件具有以下格式
+-----------+------+------------------------------------------------------------+
| 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);
}
}
可选
流选项: Omit<EventStreamCallbackHandlerInput, "autoClose">可选
流选项: Omit<EventStreamCallbackHandlerInput, "autoClose">流式传输来自 runnable 的所有输出,如回调系统所报告。这包括 LLM、检索器、工具等的内部运行。输出以 Log 对象的形式进行流式传输,其中包含描述每次步骤中运行状态如何变化的 jsonpatch 操作列表,以及运行的最终状态。jsonpatch 操作可以按顺序应用以构建状态。
可选
options: Partial<RunnableConfig>可选
流选项: Omit<LogStreamCallbackHandlerInput, "autoClose">将生命周期监听器绑定到 Runnable,返回一个新的 Runnable。Run 对象包含有关运行的信息,包括其 id、类型、输入、输出、错误、startTime、endTime 以及添加到运行的任何标签或元数据。
包含回调函数的对象。
可选
onrunnable 完成运行后调用,使用 Run 对象。
可选
config: RunnableConfig可选
on如果 runnable 抛出错误,则调用,使用 Run 对象。
可选
config: RunnableConfig可选
onrunnable 开始运行之前调用,使用 Run 对象。
可选
config: RunnableConfig为现有 runnable 添加重试逻辑。
可选
fields: { 可选
on可选
stop一个新的 RunnableRetry,当调用时,将根据参数进行重试。
静态
是可运行的静态
lc_name
一个运行上一个 AIMessage 中请求的工具的节点。它可以在带有 "messages" 键的 StateGraph 中使用,也可以在 MessageGraph 中使用。如果请求了多个工具调用,它们将并行运行。输出将是 ToolMessages 的列表,每个工具调用一个。
示例
示例