类 ToolExecutor

bound

config

可选 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，在反序列化时将使用。

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

lc_serializable_keys

• get lc_serializable_keys(): undefined | string[]

• 应该序列化的键的手动列表。如果未被覆盖，所有传递给构造函数的字段都将被序列化。

  返回 undefined | 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<Record<string, any>>>[]
        • 可选 runManagers: (undefined | CallbackManagerForChainRun)[]
        • 可选 batchOptions: RunnableBatchOptions

        返回 Promise<any[]>

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

  返回 Promise<any[]>

  一个解析为输出值的 Promise。

_mergeConfig

• _mergeConfig(...options): Promise<Partial<RunnableConfig<Record<string, any>>>>

• 参数

  • Rest ...options: (undefined | RunnableConfig<Record<string, any>> | Partial<RunnableConfig<Record<string, any>>>)[]

  返回 Promise<Partial<RunnableConfig<Record<string, any>>>>

_streamIterator

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

• 参数

  • input: any
  • 可选 options: Partial<RunnableConfig<Record<string, any>>>

  返回 AsyncGenerator<any, void, any>

asTool

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

• 将可运行对象转换为工具。返回 RunnableToolLike 的新实例，其中包含可运行对象、名称、描述和模式。

  类型参数

  • T extends any = any

  参数

  • fields: {
        描述?: string;
        名称?: string;
        架构: InteropZodType<T>;
    }

    • 可选 description?: string

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

    • 可选 name?: string

      工具的名称。如果未提供，则默认为可运行对象的名称。

    • 架构: InteropZodType<T>

      工具输入的 Zod 模式。从可运行对象的输入类型推断 Zod 类型。

  返回 RunnableToolLike<InteropZodType<ToolCall | T>, any>

  RunnableToolLike 的一个实例，它是一个可用作工具的可运行对象。

assign

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

• 将新字段分配给此可运行对象的字典输出。返回一个新的可运行对象。

  参数

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

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

batch

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

• 参数

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

  返回 Promise<any[]>

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

• 参数

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

  返回 Promise<any[]>

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

• 参数

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

  返回 Promise<any[]>

已弃用

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

• 使用指定参数绑定可运行对象。

  参数

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

    用于绑定可运行对象的参数。

  返回 RunnableBinding<any, any, RunnableConfig<Record<string, any>>>

  绑定了指定参数的 RunnableBinding 类的新实例。

  已弃用

  请改用 withConfig。这将在下一个重大发布中移除。

getGraph

• getGraph(_?): Graph

• 参数

  • 可选 _: RunnableConfig<Record<string, any>>

  返回 Graph

getName

• getName(suffix?): string

• 参数

  • 可选 suffix: string

  返回 string

invoke

• invoke(input, options?): Promise<any>

• 参数

  • input: any
  • 可选 options: Partial<RunnableConfig<Record<string, any>>>

  返回 Promise<any>

已弃用

• map(): Runnable<any[], any[], RunnableConfig<Record<string, any>>>

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

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

  已弃用

  这将在下一个重大版本中移除。

pick

• pick(keys): Runnable<any, any, RunnableConfig<Record<string, any>>>

• 从此可运行对象的字典输出中选取键。返回一个新的可运行对象。

  参数

  • keys: string | string[]

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

pipe

• pipe<NewRunOutput>(coerceable): Runnable<any, Exclude<NewRunOutput, Error>, RunnableConfig<Record<string, any>>>

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

  类型参数

  • NewRunOutput

  参数

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

    一个 runnable、函数或其值为函数或 runnable 的对象。

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

  一个新的可运行序列。

stream

• stream(input, options?): Promise<IterableReadableStream<any>>

• 参数

  • input: any
  • 可选 options: Partial<RunnableConfig<Record<string, any>>>

  返回 Promise<IterableReadableStream<any>>

streamEvents

• streamEvents(input, options, streamOptions?): IterableReadableStream<StreamEvent>

• 参数

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

  返回 IterableReadableStream<StreamEvent>

• streamEvents(input, options, streamOptions?): IterableReadableStream<Uint8Array<ArrayBufferLike>>

• 参数

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

  返回 IterableReadableStream<Uint8Array<ArrayBufferLike>>

streamLog

• streamLog(input, options?, streamOptions?): AsyncGenerator<RunLogPatch, any, any>

• 将可运行对象的所有输出（如报告给回调系统的那样）流式传输。这包括LLM、检索器、工具等的所有内部运行。输出以日志对象的形式流式传输，其中包含一个jsonpatch操作列表，描述了运行状态在每个步骤中如何变化，以及运行的最终状态。jsonpatch操作可以用于构建状态。

  参数

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

  返回 AsyncGenerator<RunLogPatch, any, any>

toJSON

• toJSON(): Serialized

• 返回 Serialized

toJSONNotImplemented

• toJSONNotImplemented(): SerializedNotImplemented

• 返回 SerializedNotImplemented

transform

• transform(generator, options?): AsyncGenerator<any, any, any>

• 参数

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

  返回 AsyncGenerator<any, any, any>

withConfig

• withConfig(config): Runnable<any, any, RunnableConfig<Record<string, any>>>

• 参数

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

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

withFallbacks

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

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

  参数

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

  返回 RunnableWithFallbacks<any, any>

  一个新的 RunnableWithFallbacks。

withListeners

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

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

  参数

  • 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
          • 可选 配置: RunnableConfig<Record<string, any>>

          返回 void | Promise<void>

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

      如果 runnable 抛出错误，则调用此函数，传入 Run 对象。

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

        • 参数

          • run: Run
          • 可选 配置: RunnableConfig<Record<string, any>>

          返回 void | Promise<void>

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

      在 runnable 开始运行前调用，传入 Run 对象。

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

        • 参数

          • run: Run
          • 可选 配置: RunnableConfig<Record<string, any>>

          返回 void | Promise<void>

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

withRetry

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

• 参数

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

    • 可选 onFailedAttempt?: RunnableRetryFailedAttemptHandler

    • 可选 stopAfterAttempt?: number

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

静态 isRunnable

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

• 参数

  • thing: any

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

静态 isRunnableBinding

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

• 参数

  • thing: any

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

静态 lc_name

• lc_name(): string

• 返回 string