一个节点,运行上一个 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> | DynamicTool)[]
    • Optional options: ToolNodeOptions

    返回值 ToolNode<T>

属性

config?: RunnableConfig<Record<string, any>>
func: ((...args) => any)

类型声明

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

      • Rest ...args: any[]

      返回值 any

handleToolErrors: boolean
lc_kwargs: SerializedFields
lc_namespace: string[]
lc_runnable: boolean
lc_serializable: boolean
name?: string
recurse: boolean
tags?: string[]
tools: (RunnableToolLike<ZodType<any, ZodTypeDef, any>, unknown> | StructuredToolInterface<ZodObjectAny> | DynamicTool)[]
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,将在反序列化时使用。

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

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

    返回值 undefined | string[]

方法

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

    类型参数

    • T

    参数

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

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

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

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

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

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

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

    一个 Promise,它解析为输出值。

  • 类型参数

    • T

    参数

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

    返回值 Promise<T>

  • 类型参数

    • O extends RunnableConfig<Record<string, any>, O> & {
          runType?: string;
      }

    参数

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

    Returns Partial<O>[]

  • 参数

    • Optional options: Partial<RunnableConfig<Record<string, any>>>

    Returns [RunnableConfig<Record<string, any>>, Omit<Partial<RunnableConfig<Record<string, any>>>, keyof RunnableConfig<Record<string, any>>>]

  • Default streaming implementation. Subclasses should override this method if they support streaming output.

    参数

    • input: T
    • Optional options: Partial<RunnableConfig<Record<string, any>>>

    Returns AsyncGenerator<T, any, unknown>

  • 参数

    • input: T
    • logStreamCallbackHandler: LogStreamCallbackHandler
    • config: Partial<RunnableConfig<Record<string, any>>>

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • 参数

    • input: T
    • Optional config: Partial<RunnableConfig<Record<string, any>>>
    • Optional runManager: CallbackManagerForChainRun

    返回值 Promise<T>

  • Helper method to transform an Iterator of Input values into an Iterator of Output values, with callbacks. Use this to implement stream() or transform() in Runnable subclasses.

    类型参数

    • 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>
          • Optional runManager: CallbackManagerForChainRun
          • Optional options: Partial<RunnableConfig<Record<string, any>>>

          Returns AsyncGenerator<O, any, unknown>

    • Optional options: Partial<RunnableConfig<Record<string, any>>> & {
          runType?: string;
      }

    Returns AsyncGenerator<O, any, unknown>

  • Convert a runnable to a tool. Return a new instance of RunnableToolLike which contains the runnable, name, description and schema.

    类型参数

    • T = T

    参数

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

        The description of the tool. Falls back to the description on the Zod schema if not provided, or undefined if neither are provided.

      • Optional name?: string

        The name of the tool. If not provided, it will default to the name of the runnable.

      • schema: ZodType<T, ZodTypeDef, T>

        The Zod schema for the input of the tool. Infers the Zod type from the input type of the runnable.

    Returns RunnableToolLike<ZodType<ToolCall | T, ZodTypeDef, ToolCall | T>, T>

    An instance of RunnableToolLike which is a runnable that can be used as a tool.

  • Assigns new fields to the dict output of this runnable. Returns a new runnable.

    参数

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

    Returns Runnable<any, any, RunnableConfig<Record<string, any>>>

  • Default streaming implementation. Subclasses should override this method if they support streaming output.

    参数

    • inputs: T[]

      输入到每个批次调用的数组。

    • Optional options: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[]

      应用于每个批次调用的单个调用选项对象,或每个调用的数组。

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<T[]>

    RunOutputs 数组,或者 RunOutputs 和错误的混合数组(如果设置了 batchOptions.returnExceptions)

  • 参数

    • inputs: T[]
    • Optional options: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[]
    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions: true;
      }

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

  • 参数

    • inputs: T[]
    • Optional options: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[]
    • Optional batchOptions: RunnableBatchOptions

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

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

    参数

    • kwargs: Partial<RunnableConfig<Record<string, any>>>

    Returns Runnable<T, T, RunnableConfig<Record<string, any>>>

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

  • 参数

    • Optional _: RunnableConfig<Record<string, any>>

    Returns Graph

  • 参数

    • Optional suffix: string

    Returns string

  • 参数

    • input: T
    • Optional options: Partial<RunnableConfig<Record<string, any>>>

    返回值 Promise<T>

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

    Returns Runnable<T[], T[], RunnableConfig<Record<string, any>>>

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

    参数

    • keys: string | string[]

    Returns Runnable<any, any, RunnableConfig<Record<string, any>>>

  • 创建一个新的 runnable 序列,该序列串行运行每个单独的 runnable,并将一个 runnable 的输出通过管道传输到另一个 runnable 或类似 runnable 的对象中。

    类型参数

    • NewRunOutput

    参数

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

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

    Returns Runnable<T, Exclude<NewRunOutput, Error>, RunnableConfig<Record<string, any>>>

    一个新的 runnable 序列。

  • 参数

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

    返回值 Promise<T>

  • 以块 (chunk) 的形式流式输出。

    参数

    • input: T
    • Optional options: Partial<RunnableConfig<Record<string, any>>>

    返回 Promise<IterableReadableStream<T>>

    一个可读流,同时也是一个可迭代对象。

  • 生成由 runnable 内部步骤发出的事件流。

    用于创建一个 StreamEvents 的迭代器,该迭代器提供关于 runnable 进度的实时信息,包括来自中间结果的 StreamEvents。

    StreamEvent 是一个具有以下模式的字典

    • event: string - 事件名称的格式为:on_[runnable_type]_(start|stream|end)。
    • name: string - 生成事件的 runnable 的名称。
    • run_id: string - 与发出事件的 runnable 的给定执行相关联的随机生成的 ID。 作为父 runnable 执行的一部分调用的子 runnable 将被分配其自己唯一的 ID。
    • tags: string[] - 生成事件的 runnable 的标签。
    • metadata: Record<string, any> - 生成事件的 runnable 的元数据。
    • data: Record<string, any>

    下面是一个表格,说明了各种链可能发出的一些事件。 为了简洁起见,表格中省略了元数据字段。 链定义已包含在表格之后。

    注意 此参考表适用于 schema 的 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);
    }
    }

    参数

    • input: T
    • options: Partial<RunnableConfig<Record<string, any>>> & {
          version: "v1" | "v2";
      }
    • Optional streamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">

    返回 IterableReadableStream<StreamEvent>

  • 参数

    • input: T
    • options: Partial<RunnableConfig<Record<string, any>>> & {
          encoding: "text/event-stream";
          version: "v1" | "v2";
      }
    • Optional streamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">

    返回 IterableReadableStream<Uint8Array>

  • 流式传输来自 runnable 的所有输出,正如回调系统报告的那样。 这包括 LLM、检索器、工具等的所有内部运行。 输出以 Log 对象的形式流式传输,其中包括 jsonpatch ops 列表,这些列表描述了运行状态在每个步骤中如何更改,以及运行的最终状态。 可以应用 jsonpatch ops 以构造状态。

    参数

    • input: T
    • Optional options: Partial<RunnableConfig<Record<string, any>>>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • 返回 Serialized

  • 返回 SerializedNotImplemented

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

    参数

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

    Returns AsyncGenerator<T, any, unknown>

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

    参数

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

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

    Returns Runnable<T, T, RunnableConfig<Record<string, any>>>

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

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

    参数

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

    返回 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>);
      }

      包含回调函数的对象。

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

        在 runnable 完成运行后调用,带有 Run 对象。

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

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

            返回 void | Promise<void>

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

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

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

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

            返回 void | Promise<void>

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

        在 runnable 开始运行之前调用,带有 Run 对象。

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

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

            返回 void | Promise<void>

    Returns Runnable<T, T, RunnableConfig<Record<string, any>>>

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

    参数

    • Optional fields: {
          onFailedAttempt?: RunnableRetryFailedAttemptHandler;
          stopAfterAttempt?: number;
      }
      • Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
      • Optional stopAfterAttempt?: number

    返回 RunnableRetry<T, T, RunnableConfig<Record<string, any>>>

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

  • 参数

    • thing: any

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

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

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

    Returns string