Class RunnableMap<RunInput>

A runnable that runs a mapping of runnables in parallel, and returns a mapping of their outputs.

Example

const mapChain = RunnableMap.from({
joke: PromptTemplate.fromTemplate("Tell me a joke about {topic}").pipe(
new ChatAnthropic({}),
),
poem: PromptTemplate.fromTemplate("write a 2-line poem about {topic}").pipe(
new ChatAnthropic({}),
),
});
const result = await mapChain.invoke({ topic: "bear" });

Type Parameters

  • RunInput

Hierarchy

  • Runnable<RunInput, Record<string, any>>
    • RunnableMap

Constructors

  • Type Parameters

    • RunInput

    Parameters

    • fields: {
          steps: Record<string, RunnableLike<RunInput, any>>;
      }

    Returns RunnableMap<RunInput>

Properties

steps: Record<string, Runnable<RunInput, any, BaseCallbackConfig>>

Methods

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    • inputs: RunInput[]

      Array of inputs to each batch call.

    • Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<Record<string, any>[]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<(Record<string, any> | Error)[]>

  • Parameters

    Returns Promise<(Record<string, any> | Error)[]>

  • Returns string[]

  • Parameters

    Returns Promise<Record<string, any>>

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

    Returns Runnable<RunInput[], Record<string, any>[], BaseCallbackConfig>

  • 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<Record<string, any>, NewRunOutput>

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

    Returns RunnableSequence<RunInput, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<Record<string, any>>>

    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.

    Parameters

    • input: RunInput
    • Optional options: Partial<BaseCallbackConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

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

    Parameters

    Returns AsyncGenerator<Record<string, any>, any, unknown>

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

    Parameters

    Returns RunnableWithFallbacks<RunInput, Record<string, any>>

    A new RunnableWithFallbacks.

  • Type Parameters

    • RunInput

    Parameters

    Returns RunnableMap<RunInput>

Generated using TypeDoc