类 ToolExecutor

bound

config

Optional configFactories

可选 kwargs

lc_kwargs

lc_namespace

lc_serializable

可选 name

lc_aliases

• get lc_aliases(): undefined | {
      [key: string]: string;
  }

• 构造函数参数别名映射。键是属性名称，例如“foo”。值是在序列化时替换键的别名。这用于例如使参数名称与 Python 匹配。

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

lc_attributes

• get lc_attributes(): undefined | SerializedFields

• 与构造函数参数合并的附加属性映射。键是属性名称，例如“foo”。值是属性值，这些值将被序列化。这些属性需要被构造函数作为参数接受。

  返回 undefined | SerializedFields

lc_id

• get lc_id(): string[]

• 模块的最终序列化标识符。

  返回 string[]

lc_secrets

• get lc_secrets(): undefined | {
      [key: string]: string;
  }

• 秘密映射，这些秘密将从序列化中省略。键是构造函数参数中秘密的路径，例如“foo.bar.baz”。值是秘密 ID，这些 ID 将在反序列化时使用。

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

_batchWithConfig

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

• 处理可运行项的批处理和配置的内部方法。它接收一个函数、输入值和可选配置，并返回一个解析为输出值的 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。

_mergeConfig

• _mergeConfig(...options): Promise<Partial<RunnableConfig>>

• 参数

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

  返回 Promise<Partial<RunnableConfig>>

_streamIterator

• _streamIterator(input, options?): AsyncGenerator<any, void, unknown>

• 参数

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

  返回 AsyncGenerator<any, void, unknown>

asTool

• asTool<T>(fields): RunnableToolLike<ZodType<ToolCall | T, ZodTypeDef, ToolCall | T>, any>

• 将一个可执行文件转换为工具。返回一个新的 RunnableToolLike 实例，其中包含可执行文件、名称、描述和模式。

  类型参数

  • T扩展 any = any

  参数

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

    • 可选 description?: string

      工具的描述。如果未提供，则回退到 Zod 模式上的描述，如果两者均未提供，则为 undefined。

    • 可选 name?: string

      工具的名称。如果未提供，它将默认为可执行文件的名称。

    • schema: ZodType<T, ZodTypeDef, T>

      工具输入的 Zod 模式。从可执行文件输入类型推断 Zod 类型。

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

  一个 RunnableToolLike 实例，它是一个可执行文件，可以用作工具。

assign

• assign(mapping): Runnable<any, any, RunnableConfig>

• 将新的字段分配给此可执行文件的字典输出。返回一个新的可执行文件。

  参数

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

  返回 Runnable<any, any, RunnableConfig>

batch

• batch(inputs, options?, batchOptions?): Promise<any[]>

• 参数

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

  返回 Promise<any[]>

• batch(inputs, options?, batchOptions?): Promise<any[]>

• 参数

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

  返回 Promise<any[]>

• batch(inputs, options?, batchOptions?): Promise<any[]>

• 参数

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

  返回 Promise<any[]>

bind

• bind(kwargs): RunnableBinding<any, any, RunnableConfig>

• 参数

  • kwargs: Partial<RunnableConfig>

  返回 RunnableBinding<any, any, RunnableConfig>

getGraph

• getGraph(_?): Graph

• 参数

  • 可选 _: RunnableConfig

  返回 Graph

获取名称

• 获取名称(后缀?): 字符串

• 参数

  • 可选 后缀: 字符串

  返回 字符串

调用

• 调用(输入, 选项?): Promise<任何>

• 参数

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

  返回 Promise<any>

映射

• 映射(): Runnable<任何[], 任何[], RunnableConfig>

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

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

选择

• 选择(键): Runnable<任何, 任何, RunnableConfig>

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

  参数

  • 键: 字符串 | 字符串[]

  返回 Runnable<any, any, RunnableConfig>

管道

• 管道<NewRunOutput>(强制转换): Runnable<任何, Exclude<NewRunOutput, 错误>, RunnableConfig>

• 创建一个新的 runnable 序列，该序列按顺序运行每个单独的 runnable，将一个 runnable 的输出管道到另一个 runnable 或类似 runnable 的对象中。

  类型参数

  • NewRunOutput

  参数

  • 强制转换: RunnableLike<任何, NewRunOutput>

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

  返回 Runnable<任何, Exclude<NewRunOutput, 错误>, RunnableConfig>

  一个新的 runnable 序列。

流

• 流(输入, 选项?): Promise<IterableReadableStream<任何>>

• 参数

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

  返回 Promise<IterableReadableStream<任何>>

流事件

• 流事件(输入, 选项, 流选项?): IterableReadableStream<StreamEvent>

• 参数

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

  返回 IterableReadableStream<StreamEvent>

• 流事件(输入, 选项, 流选项?): IterableReadableStream<Uint8Array>

• 参数

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

  返回 IterableReadableStream<Uint8Array>

流日志

• 流日志(输入, 选项?, 流选项?): AsyncGenerator<RunLogPatch, 任何, 未知>

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

  参数

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

  返回 AsyncGenerator<RunLogPatch, any, unknown>

转换为 JSON

• 转换为 JSON(): 序列化

• 返回 序列化

转换为 JSON 未实现

• 转换为 JSON 未实现(): 序列化未实现

• 返回 序列化未实现

转换

• 转换(生成器, 选项): AsyncGenerator<任何, 任何, 未知>

• 参数

  • 生成器: AsyncGenerator<任何, 任何, 未知>
  • 选项: Partial<RunnableConfig>

  返回 AsyncGenerator<any, any, unknown>

withConfig

• withConfig(config): RunnableBinding<any, any, RunnableConfig>

• 参数

  • config: RunnableConfig

  返回 RunnableBinding<any, any, RunnableConfig>

withFallbacks

• withFallbacks(fields): RunnableWithFallbacks<any, any>

• 从当前可运行程序创建一个新的可运行程序，如果初始调用失败，它将尝试调用其他传递的回退可运行程序。

  参数

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

    • fallbacks: Runnable<any, any, RunnableConfig>[]

      如果可运行程序出错，则调用其他可运行程序。

  返回 RunnableWithFallbacks<any, any>

  一个新的 RunnableWithFallbacks。

withListeners

• withListeners(params): Runnable<any, any, RunnableConfig>

• 将生命周期监听器绑定到 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>)

      在可运行程序完成运行后调用，使用 Run 对象。

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

        • 参数

          • run: Run
          • 可选 config: RunnableConfig

          返回 void | Promise<void>

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

      如果可运行程序抛出错误，则调用，使用 Run 对象。

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

        • 参数

          • run: Run
          • 可选 config: RunnableConfig

          返回 void | Promise<void>

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

      在可运行程序开始运行之前调用，使用 Run 对象。

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

        • 参数

          • run: Run
          • 可选 config: RunnableConfig

          返回 void | Promise<void>

  返回 Runnable<any, any, RunnableConfig>

withRetry

• withRetry(fields?): RunnableRetry<any, any, RunnableConfig>

• 参数

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

    • Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler

    • Optional stopAfterAttempt?: number

  返回 RunnableRetry<any, any, RunnableConfig>

Static isRunnable

• isRunnable(thing): thing is Runnable<any, any, RunnableConfig>

• 参数

  • thing: any

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

Static isRunnableBinding

• isRunnableBinding(thing): thing is RunnableBinding<any, any, any>

• 参数

  • thing: any

  返回 thing is RunnableBinding<any, any, any>

Static lc_name

• lc_name(): string

• 返回 字符串