一个运行上一个 AIMessage 中请求的工具的节点。它可以在带有 "messages" 键的 StateGraph 中使用,也可以在 MessageGraph 中使用。如果请求了多个工具调用,它们将并行运行。输出将是 ToolMessages 的列表,每个工具调用一个。

示例

import { ToolNode } from "@langchain/langgraph/prebuilt";
import { tool } from "@langchain/core/tools";
import { z } from "zod";
import { AIMessage } from "@langchain/core/messages";

const getWeather = tool((input) => {
if (["sf", "san francisco"].includes(input.location.toLowerCase())) {
return "It's 60 degrees and foggy.";
} else {
return "It's 90 degrees and sunny.";
}
}, {
name: "get_weather",
description: "Call to get the current weather.",
schema: z.object({
location: z.string().describe("Location to get the weather for."),
}),
});

const tools = [getWeather];
const toolNode = new ToolNode(tools);

const messageWithSingleToolCall = new AIMessage({
content: "",
tool_calls: [
{
name: "get_weather",
args: { location: "sf" },
id: "tool_call_id",
type: "tool_call",
}
]
})

await toolNode.invoke({ messages: [messageWithSingleToolCall] });
// Returns tool invocation responses as:
// { messages: ToolMessage[] }

示例

import {
StateGraph,
MessagesAnnotation,
} from "@langchain/langgraph";
import { ToolNode } from "@langchain/langgraph/prebuilt";
import { tool } from "@langchain/core/tools";
import { z } from "zod";
import { ChatAnthropic } from "@langchain/anthropic";

const getWeather = tool((input) => {
if (["sf", "san francisco"].includes(input.location.toLowerCase())) {
return "It's 60 degrees and foggy.";
} else {
return "It's 90 degrees and sunny.";
}
}, {
name: "get_weather",
description: "Call to get the current weather.",
schema: z.object({
location: z.string().describe("Location to get the weather for."),
}),
});

const tools = [getWeather];
const modelWithTools = new ChatAnthropic({
model: "claude-3-haiku-20240307",
temperature: 0
}).bindTools(tools);

const toolNodeForGraph = new ToolNode(tools)

const shouldContinue = (state: typeof MessagesAnnotation.State) => {
const { messages } = state;
const lastMessage = messages[messages.length - 1];
if ("tool_calls" in lastMessage && Array.isArray(lastMessage.tool_calls) && lastMessage.tool_calls?.length) {
return "tools";
}
return "__end__";
}

const callModel = async (state: typeof MessagesAnnotation.State) => {
const { messages } = state;
const response = await modelWithTools.invoke(messages);
return { messages: response };
}

const graph = new StateGraph(MessagesAnnotation)
.addNode("agent", callModel)
.addNode("tools", toolNodeForGraph)
.addEdge("__start__", "agent")
.addConditionalEdges("agent", shouldContinue)
.addEdge("tools", "agent")
.compile();

const inputs = {
messages: [{ role: "user", content: "what is the weather in SF?" }],
};

const stream = await graph.stream(inputs, {
streamMode: "values",
});

for await (const { messages } of stream) {
console.log(messages);
}
// Returns the messages in the state at each step of execution

类型参数

  • T = any

层次结构

  • RunnableCallable<T, T>
    • ToolNode

构造函数

  • 类型参数

    • T = any

    参数

    • tools: (RunnableToolLike<ZodType<any, ZodTypeDef, any>, unknown> | StructuredToolInterface<ZodObjectAny>)[]
    • 可选 options: ToolNodeOptions

    返回 ToolNode<T>

属性

config?: RunnableConfig
func: ((...args) => any)

类型声明

    • (...args): any
    • 参数

      • 剩余 ...args: any[]

      返回 any

handleToolErrors: boolean
lc_kwargs: SerializedFields
lc_namespace: string[]
lc_runnable: boolean
lc_serializable: boolean
name?: string
recurse: boolean
run: any
tags?: string[]
tools: (RunnableToolLike<ZodType<any, ZodTypeDef, any>, unknown> | StructuredToolInterface<ZodObjectAny>)[]
trace: boolean

访问器

  • 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,这些 ID 将在反序列化时使用。

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

方法

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

    类型参数

    • T

    参数

    • func: ((inputs, options?, runManagers?, batchOptions?) => Promise<(Error | T)[]>)

      要为每个输入值执行的函数。

        • (inputs, options?, runManagers?, batchOptions?): Promise<(Error | T)[]>
        • 参数

          • inputs: T[]
          • Optional options: Partial<RunnableConfig>[]
          • Optional runManagers: (undefined | CallbackManagerForChainRun)[]
          • Optional batchOptions: RunnableBatchOptions

          返回值 Promise<(Error | T)[]>

    • inputs: T[]
    • Optional options: Partial<RunnableConfig & {
          runType?: string;
      }> | Partial<RunnableConfig & {
          runType?: string;
      }>[]
    • Optional batchOptions: RunnableBatchOptions

    返回值 Promise<(Error | T)[]>

    解析为输出值的 Promise。

  • 类型参数

    • T

    参数

    • func: ((input) => Promise<T>) | ((input, config?, runManager?) => Promise<T>)
    • input: T
    • 可选 options: Partial<RunnableConfig> & {
          runType?: string;
      }

    返回 Promise<T>

  • 类型参数

    • O 扩展 RunnableConfig & {
          runType?: string;
      }

    参数

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

    返回 Partial<O>[]

  • 参数

    • 可选 options: Partial<RunnableConfig>

    返回 [RunnableConfig, Omit<Partial<RunnableConfig>, keyof RunnableConfig>]

  • 默认流式实现。如果子类支持流式输出,则应重写此方法。

    参数

    • input: T
    • 可选 options: Partial<RunnableConfig>

    返回 AsyncGenerator<T, any, unknown>

  • 参数

    • input: T
    • logStreamCallbackHandler: LogStreamCallbackHandler
    • config: Partial<RunnableConfig>

    返回 AsyncGenerator<RunLogPatch, any, unknown>

  • 参数

    • input: T
    • 可选 config: Partial<RunnableConfig>
    • 可选 runManager: CallbackManagerForChainRun

    返回 Promise<T>

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

    类型参数

    • I
    • O

    参数

    • inputGenerator: AsyncGenerator<I, any, unknown>
    • transformer: ((generator, runManager?, options?) => AsyncGenerator<O, any, unknown>)
        • (generator, runManager?, options?): AsyncGenerator<O, any, unknown>
        • 参数

          • generator: AsyncGenerator<I, any, unknown>
          • 可选 runManager: CallbackManagerForChainRun
          • 可选 options: Partial<RunnableConfig>

          返回 AsyncGenerator<O, any, unknown>

    • 可选 options: RunnableConfig & {
          runType?: string;
      }

    返回 AsyncGenerator<O, any, unknown>

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

    类型参数

    • T = T

    参数

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

        工具的描述。如果没有提供,则回退到 Zod 模式中的描述,或者如果两者都没有提供,则为 undefined。

      • 可选 name?: string

        工具的名称。如果没有提供,它将默认为 runnable 的名称。

      • schema: ZodType<T, ZodTypeDef, T>

        工具输入的 Zod 模式。从 runnable 的输入类型推断 Zod 类型。

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

    一个 RunnableToolLike 的实例,它是一个可以作为工具使用的 runnable。

  • 将新的字段分配给此 runnable 的字典输出。返回一个新的 runnable。

    参数

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

    返回 Runnable<any, any, RunnableConfig>

  • batch 的默认实现,它调用 invoke N 次。子类如果能够更有效地批处理,则应覆盖此方法。

    参数

    • inputs: T[]

      要对每个批处理调用进行的输入数组。

    • 可选 options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

      单个调用选项对象(应用于每个批处理调用)或每个调用的数组。

    • 可选 batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    返回 Promise<T[]>

    RunOutputs 数组,或者如果 batchOptions.returnExceptions 设置,则为混合的 RunOutputs 和错误

  • 参数

    • inputs: T[]
    • 可选 options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
    • 可选 batchOptions: RunnableBatchOptions & {
          returnExceptions: true;
      }

    返回值 Promise<(Error | T)[]>

  • 参数

    • inputs: T[]
    • 可选 options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
    • Optional batchOptions: RunnableBatchOptions

    返回值 Promise<(Error | T)[]>

  • 将参数绑定到 Runnable,返回一个新的 Runnable。

    参数

    • kwargs: Partial<RunnableConfig>

    返回 Runnable<T, T, RunnableConfig>

    一个新的 RunnableBinding,它在调用时将应用绑定参数。

  • 参数

    • 可选 _: RunnableConfig

    返回 Graph

  • 参数

    • 可选 后缀: 字符串

    返回值 字符串

  • 参数

    • 输入: 任何
    • 可选 options: Partial<RunnableConfig>

    返回值 Promise<任何>

  • 返回一个新的 Runnable,它通过对每个输入调用 invoke() 来将输入列表映射到输出列表。

    返回值 Runnable<T[], T[], RunnableConfig>

  • 从该 runnable 的字典输出中挑选键。返回一个新的 runnable。

    参数

    • : 字符串 | 字符串[]

    返回 Runnable<any, any, RunnableConfig>

  • 创建一个新的 runnable 序列,该序列按顺序运行每个单独的 runnable,将一个 runnable 的输出管道到另一个 runnable 或 runnable-like。

    类型参数

    • NewRunOutput

    参数

    • 可强制转换: RunnableLike<T, NewRunOutput>

      一个 runnable、函数或对象,其值是函数或 runnable。

    返回值 Runnable<T, Exclude<NewRunOutput, Error>, RunnableConfig>

    一个新的 runnable 序列。

  • 以块的形式流输出。

    参数

    • input: T
    • 可选 options: Partial<RunnableConfig>

    返回值 Promise<IterableReadableStream<T>>

    一个可读流,也是可迭代的。

  • 生成由 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);
    }
    }

    参数

    • input: T
    • 选项: Partial<RunnableConfig> & {
          版本: "v1" | "v2";
      }
    • 可选 流选项: Omit<EventStreamCallbackHandlerInput, "autoClose">

    返回值 IterableReadableStream<StreamEvent>

  • 参数

    • input: T
    • 选项: Partial<RunnableConfig> & {
          编码: "text/event-stream";
          版本: "v1" | "v2";
      }
    • 可选 流选项: Omit<EventStreamCallbackHandlerInput, "autoClose">

    返回值 IterableReadableStream<Uint8Array>

  • 流式传输来自 runnable 的所有输出,如回调系统所报告。这包括 LLM、检索器、工具等的内部运行。输出以 Log 对象的形式进行流式传输,其中包含描述每次步骤中运行状态如何变化的 jsonpatch 操作列表,以及运行的最终状态。jsonpatch 操作可以按顺序应用以构建状态。

    参数

    • input: T
    • 可选 options: Partial<RunnableConfig>
    • 可选 流选项: Omit<LogStreamCallbackHandlerInput, "autoClose">

    返回 AsyncGenerator<RunLogPatch, any, unknown>

  • 返回 Serialized

  • 返回 SerializedNotImplemented

  • transform 的默认实现,它会缓冲输入,然后调用 stream。如果子类可以在生成输入时开始生成输出,则应覆盖此方法。

    参数

    • generator: AsyncGenerator<T, any, unknown>
    • options: Partial<RunnableConfig>

    返回 AsyncGenerator<T, any, unknown>

  • 将配置绑定到 Runnable,返回一个新的 Runnable。

    参数

    • config: RunnableConfig

      要附加到新 runnable 的新配置参数。

    返回 Runnable<T, T, RunnableConfig>

    一个新的 RunnableBinding,其配置与传递的配置匹配。

  • 从当前 runnable 创建一个新的 runnable,如果初始调用失败,该 runnable 将尝试调用其他传递的 fallback runnable。

    参数

    • fields: {
          fallbacks: Runnable<T, T, RunnableConfig>[];
      } | Runnable<T, T, RunnableConfig>[]

    返回 RunnableWithFallbacks<T, T>

    一个新的 RunnableWithFallbacks。

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

    参数

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

      包含回调函数的对象。

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

        runnable 完成运行后调用,使用 Run 对象。

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

            • run: Run
            • 可选 config: RunnableConfig

            返回 void | Promise<void>

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

        如果 runnable 抛出错误,则调用,使用 Run 对象。

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

            • run: Run
            • 可选 config: RunnableConfig

            返回 void | Promise<void>

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

        runnable 开始运行之前调用,使用 Run 对象。

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

            • run: Run
            • 可选 config: RunnableConfig

            返回 void | Promise<void>

    返回 Runnable<T, T, RunnableConfig>

  • 为现有 runnable 添加重试逻辑。

    参数

    • 可选 fields: {
          onFailedAttempt?: RunnableRetryFailedAttemptHandler;
          stopAfterAttempt?: number;
      }
      • 可选 onFailedAttempt?: RunnableRetryFailedAttemptHandler
      • 可选 stopAfterAttempt?: number

    返回 RunnableRetry<T, T, RunnableConfig>

    一个新的 RunnableRetry,当调用时,将根据参数进行重试。

  • 参数

    • 东西: any

    返回 东西Runnable<any, any, RunnableConfig>

  • 可序列化对象的名称。覆盖以提供别名或在缩小环境中保留序列化模块名称。

    作为静态方法实现以支持加载逻辑。

    返回值 字符串