Optional kwargs: SerializedFieldsRest ..._args: never[]Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.
Array of inputs to each batch call.
Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]Either a single call options object to apply to each batch call or an array for each call.
Optional batchOptions: RunnableBatchOptions & { An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]Optional batchOptions: RunnableBatchOptions & { Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]Optional batchOptions: RunnableBatchOptionsBind arguments to a Runnable, returning a new Runnable.
A new RunnableBinding that, when invoked, will apply the bound args.
Optional options: Partial<RunnableConfig>Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.
Create 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.
Stream output in chunks.
Optional options: Partial<RunnableConfig>A readable stream that is also an iterable.
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">Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.
Bind config to a Runnable, returning a new Runnable.
New configuration parameters to attach to the new runnable.
A new RunnableBinding with a config matching what's passed.
Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.
Other runnables to call if the runnable errors.
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: RunnableConfigAdd retry logic to an existing runnable.
Optional fields: { Optional onOptional stopA new RunnableRetry that, when invoked, will retry according to the parameters.
Static assignA runnable that assigns key-value pairs to the input.
The example below shows how you could use it with an inline function.
const prompt =
PromptTemplate.fromTemplate(`Write a SQL query to answer the question using the following schema: {schema}
Question: {question}
SQL Query:`);
// The `RunnablePassthrough.assign()` is used here to passthrough the input from the `.invoke()`
// call (in this example it's the question), along with any inputs passed to the `.assign()` method.
// In this case, we're passing the schema.
const sqlQueryGeneratorChain = RunnableSequence.from([
RunnablePassthrough.assign({
schema: async () => db.getTableInfo(),
}),
prompt,
new ChatOpenAI({}).bind({ stop: ["\nSQLResult:"] }),
new StringOutputParser(),
]);
const result = await sqlQueryGeneratorChain.invoke({
question: "How many employees are there?",
});
Static isGenerated using TypeDoc
A runnable to passthrough inputs unchanged or with additional keys.
This runnable behaves almost like the identity function, except that it can be configured to add additional keys to the output, if the input is an object.
The example below demonstrates how to use
RunnablePassthrough to passthrough the input from the.invoke()`@example