已弃用

请使用 ToolNode 代替。

继承关系

  • RunnableBinding<ToolExecutorInputType, ToolExecutorOutputType>
    • ToolExecutor

构造函数

  • 参数

    返回值 ToolExecutor

属性

bound: Runnable<any, any, RunnableConfig>
config: RunnableConfig
configFactories?: ((config) => RunnableConfig | Promise<RunnableConfig>)[]

类型声明

    • (config): RunnableConfig | Promise<RunnableConfig>
    • 参数

      • config: RunnableConfig

      返回 RunnableConfig | Promise<RunnableConfig>

无效工具消息模板: string
kwargs?: Partial<RunnableConfig>
lc_graph_name: string
lc_kwargs: SerializedFields
lc_namespace: string[]
lc_runnable: boolean
lc_serializable: boolean
name?: string
toolMap: Record<string, RunnableToolLike<ZodType<any, ZodTypeDef, any>, unknown> | StructuredToolInterface<ZodObjectAny>>
tools: (RunnableToolLike<ZodType<any, ZodTypeDef, any>, unknown> | StructuredToolInterface<ZodObjectAny>)[]

访问器

  • 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 extends any

    参数

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

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

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

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

          返回 Promise<any[]>

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

    返回 Promise<any[]>

    解析为输出值的 Promise。

  • 类型参数

    • T extends any

    参数

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

    返回 Promise<any>

  • 执行工具调用

    参数

    • toolInvocation: ToolInvocationInterface

      要调用的工具以及传递给它的输入。

    • 可选 config: RunnableConfig

      调用时传递给工具的可选配置。

    返回 Promise<any>

    工具调用结果(stringToolMessage,由 ToolOutput 泛型设置)或字符串错误消息。

  • 类型参数

    • O extends RunnableConfig & {
          runType?: string;
      }

    参数

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

    返回 Partial<O>[]

  • 参数

    • 剩余 ...options: (undefined | RunnableConfig | Partial<RunnableConfig>)[]

    返回 Promise<Partial<RunnableConfig>>

  • 参数

    • 可选 options: Partial<RunnableConfig>

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

  • 参数

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

    返回 AsyncGenerator<any, void, unknown>

  • 参数

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

    返回 AsyncGenerator<RunLogPatch, any, unknown>

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

    类型参数

    • I 扩展 任何
    • O 扩展 任何

    参数

    • inputGenerator: AsyncGenerator<I, 任何, 未知>
    • transformer: ((generator, runManager?, options?) => AsyncGenerator<O, 任何, 未知>)
        • (generator, runManager?, options?): AsyncGenerator<O, 任何, 未知>
        • 参数

          • generator: AsyncGenerator<I, 任何, 未知>
          • 可选 runManager: CallbackManagerForChainRun
          • 可选 options: Partial<RunnableConfig>

          返回 AsyncGenerator<O, 任何, 未知>

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

    返回 AsyncGenerator<O, 任何, 未知>

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

    类型参数

    • T 扩展 任何 = 任何

    参数

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

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

      • 可选 name?: 字符串

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

      • schema: ZodType<T, ZodTypeDef, T>

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

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

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

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

    参数

    • mapping: RunnableMapLike<Record<字符串, 未知>, Record<字符串, 未知>>

    返回 Runnable<任何, 任何, RunnableConfig>

  • 参数

    • inputs: 任何[]
    • 可选 options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
    • 可选 batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    返回 Promise<any[]>

  • 参数

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

    返回 Promise<any[]>

  • 参数

    • inputs: 任何[]
    • 可选 options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
    • 可选 batchOptions: RunnableBatchOptions

    返回 Promise<any[]>

  • 参数

    • kwargs: Partial<RunnableConfig>

    返回 RunnableBinding<任何, 任何, RunnableConfig>

  • 参数

    • 可选 _: RunnableConfig

    返回 Graph

  • 参数

    • 可选 suffix: string

    返回 string

  • 参数

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

    返回 Promise<any>

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

    返回 Runnable<any[], any[], RunnableConfig>

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

    参数

    • keys: string | string[]

    返回 Runnable<任何, 任何, RunnableConfig>

  • 创建一个新的 runnable 序列,按顺序运行每个单独的 runnable,并将一个 runnable 的输出传递给另一个 runnable 或类似 runnable 的东西。

    类型参数

    • NewRunOutput

    参数

    • coerceable: RunnableLike<any, NewRunOutput>

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

    返回 Runnable<any, Exclude<NewRunOutput, Error>, RunnableConfig>

    一个新的 runnable 序列。

  • 参数

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

    返回 Promise<IterableReadableStream<any>>

  • 参数

    • input: any
    • options: Partial<RunnableConfig> & {
          version: "v1" | "v2";
      }
    • 可选 streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    返回 IterableReadableStream<StreamEvent>

  • 参数

    • input: any
    • options: Partial<RunnableConfig> & {
          encoding: "text/event-stream";
          version: "v1" | "v2";
      }
    • 可选 streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    返回 IterableReadableStream<Uint8Array>

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

    参数

    • input: any
    • 可选 options: Partial<RunnableConfig>
    • 可选 streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    返回 AsyncGenerator<RunLogPatch, any, unknown>

  • 返回 Serialized

  • 返回 SerializedNotImplemented

  • 参数

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

    返回 AsyncGenerator<any, any, unknown>

  • 参数

    • config: RunnableConfig

    返回 Runnable<任何, 任何, RunnableConfig>

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

    参数

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

    返回 RunnableWithFallbacks<any, any>

    一个新的 RunnableWithFallbacks。

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

    参数

    • 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
            • 可选 config: RunnableConfig

            返回 void | Promise<void>

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

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

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

            • run: Run
            • 可选 config: RunnableConfig

            返回 void | Promise<void>

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

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

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

            • run: Run
            • 可选 config: RunnableConfig

            返回 void | Promise<void>

    返回 Runnable<任何, 任何, RunnableConfig>

  • 参数

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

    返回 RunnableRetry<any, any, RunnableConfig>

  • 参数

    • thing: any

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

  • 参数

    • thing: any

    返回 thingRunnableBinding<any, any, any>

  • 返回 string