Class RunnableMap<RunInput, RunOutput>

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 = any

  • RunOutput extends Record<string, any> = Record<string, any>

Hierarchy

Constructors

  • Type Parameters

    • RunInput = any

    • RunOutput extends Record<string, any> = Record<string, any>

    Parameters

    • fields: {
          steps: RunnableMapLike<RunInput, RunOutput>;
      }
      • steps: RunnableMapLike<RunInput, RunOutput>

    Returns RunnableMap<RunInput, RunOutput>

Properties

name?: string
steps: Record<string, Runnable<RunInput, any, RunnableConfig>>

Methods

  • 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<RunOutput, NewRunOutput>

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

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

    A new runnable sequence.

  • 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

    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

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

    Returns AsyncGenerator<RunOutput, any, unknown>

  • 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>)
          • (run, config?): void | Promise<void>
          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

    Returns Runnable<RunInput, RunOutput, RunnableConfig>

Generated using TypeDoc