Optional configOptional kwargsProtected lc_Optional nameA 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.
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.
The final serialized identifier for the module.
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.
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.
The function to be executed for each input value.
Optional options: Partial<RunnableConfig>[]Optional runManagers: (undefined | CallbackManagerForChainRun)[]Optional batchOptions: RunnableBatchOptionsOptional options: Partial<RunnableConfig & { Optional batchOptions: RunnableBatchOptionsA promise that resolves to the output values.
Protected _callExecute a tool invocation
The tool to invoke and the input to pass to it.
Optional config: RunnableConfigOptional configuration to pass to the tool when invoked.
Either the result of the tool invocation (string or ToolMessage, set by the ToolOutput generic) or a string error message.
Protected _getProtected _separateProtected _streamProtected _transformHelper 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.
Convert a runnable to a tool. Return a new instance of RunnableToolLike
which contains the runnable, name, description and schema.
Optional description?: stringThe description of the tool. Falls back to the description on the Zod schema if not provided, or undefined if neither are provided.
Optional name?: stringThe name of the tool. If not provided, it will default to the name of the runnable.
The Zod schema for the input of the tool. Infers the Zod type from the input type of the runnable.
An instance of RunnableToolLike which is a runnable that can be used as a tool.
Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]Optional batchOptions: RunnableBatchOptions & { Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]Optional batchOptions: RunnableBatchOptions & { Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]Optional batchOptions: RunnableBatchOptionsCreate a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.
A runnable, function, or object whose values are functions or runnables.
A new runnable sequence.
Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">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.
Optional options: Partial<RunnableConfig>Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.
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.
The object containing the callback functions.
Optional onCalled after the runnable finishes running, with the Run object.
Optional config: RunnableConfigOptional onCalled if the runnable throws an error, with the Run object.
Optional config: RunnableConfigOptional onCalled before the runnable starts running, with the Run object.
Optional config: RunnableConfigOptional fields: { Optional onOptional stopStatic isStatic isStatic lc_
Deprecated
Use ToolNode instead.