Hierarchy

  • RunnableBinding<ToolExecutorInputType, ToolExecutorOutputType>
    • ToolExecutor

Constructors

  • Parameters

    Returns ToolExecutor

Properties

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

Type declaration

    • (config): RunnableConfig | Promise<RunnableConfig>
    • Parameters

      • config: RunnableConfig

      Returns RunnableConfig | Promise<RunnableConfig>

invalidToolMsgTemplate: 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, StructuredTool<ZodAny>>
tools: StructuredTool<ZodAny>[]

Accessors

  • get lc_aliases(): undefined | {
        [key: string]: string;
    }
  • A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

    Returns undefined | {
        [key: string]: string;
    }

  • get lc_attributes(): undefined | SerializedFields
  • A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

    Returns undefined | SerializedFields

  • get lc_id(): string[]
  • The final serialized identifier for the module.

    Returns string[]

  • get lc_secrets(): undefined | {
        [key: string]: string;
    }
  • A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

    Returns undefined | {
        [key: string]: string;
    }

Methods

  • Internal method that handles batching and configuration for a runnable It takes a function, input values, and optional configuration, and returns a promise that resolves to the output values.

    Type Parameters

    • T extends any

    Parameters

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

      The function to be executed for each input value.

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

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

          Returns Promise<any[]>

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

    Returns Promise<any[]>

    A promise that resolves to the output values.

  • Type Parameters

    • T extends any

    Parameters

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

    Returns Promise<any>

  • Parameters

    Returns Promise<string>

  • Type Parameters

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

    Parameters

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

    Returns Partial<O>[]

  • Parameters

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

    Returns Promise<Partial<RunnableConfig>>

  • Parameters

    • Optional options: Partial<RunnableConfig>

    Returns [RunnableConfig, Omit<Partial<RunnableConfig>, keyof RunnableConfig>]

  • Parameters

    • input: any
    • Optional options: Partial<RunnableConfig>

    Returns AsyncGenerator<any, void, unknown>

  • Parameters

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

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • 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.

    Type Parameters

    • I extends any
    • O extends any

    Parameters

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

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

          Returns AsyncGenerator<O, any, unknown>

    • Optional options: RunnableConfig & {
          runType?: string;
      }

    Returns AsyncGenerator<O, any, unknown>

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

    Parameters

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

    Returns Runnable<any, any, RunnableConfig>

  • Parameters

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

    Returns Promise<any[]>

  • Parameters

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

    Returns Promise<any[]>

  • Parameters

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

    Returns Promise<any[]>

  • Parameters

    • kwargs: Partial<RunnableConfig>

    Returns RunnableBinding<any, any, RunnableConfig>

  • Parameters

    • Optional _: RunnableConfig

    Returns Graph

  • Parameters

    • Optional suffix: string

    Returns string

  • Parameters

    • input: any
    • Optional options: Partial<RunnableConfig>

    Returns Promise<any>

  • Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

    Returns Runnable<any[], any[], RunnableConfig>

  • Pick keys from the dict output of this runnable. Returns a new runnable.

    Parameters

    • keys: string | string[]

    Returns Runnable<any, any, RunnableConfig>

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<any, NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

    Returns Runnable<any, Exclude<NewRunOutput, Error>, RunnableConfig>

    A new runnable sequence.

  • Parameters

    • input: any
    • Optional options: Partial<RunnableConfig>

    Returns Promise<IterableReadableStream<any>>

  • Parameters

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

    Returns IterableReadableStream<StreamEvent>

  • Parameters

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

    Returns IterableReadableStream<Uint8Array>

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

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

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Returns Serialized

  • Returns SerializedNotImplemented

  • Parameters

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

    Returns AsyncGenerator<any, any, unknown>

  • Parameters

    • config: RunnableConfig

    Returns RunnableBinding<any, any, RunnableConfig>

  • Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.

    Parameters

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

        Other runnables to call if the runnable errors.

    Returns RunnableWithFallbacks<any, any>

    A new RunnableWithFallbacks.

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

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

      The object containing the callback functions.

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

        Called after the runnable finishes running, with the Run object.

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

            • run: Run
            • Optional config: RunnableConfig

            Returns void | Promise<void>

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

        Called if the runnable throws an error, with the Run object.

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

            • run: Run
            • Optional config: RunnableConfig

            Returns void | Promise<void>

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

        Called before the runnable starts running, with the Run object.

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

            • run: Run
            • Optional config: RunnableConfig

            Returns void | Promise<void>

    Returns Runnable<any, any, RunnableConfig>

  • Parameters

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

    Returns RunnableRetry<any, any, RunnableConfig>

  • Parameters

    • thing: any

    Returns thing is Runnable<any, any, RunnableConfig>

  • Parameters

    • thing: any

    Returns thing is RunnableBinding<any, any, any>

  • Returns string