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

Runnable<RunInput, RunOutput>
- RunnableMap
  - RunnableParallel

Index

Constructors

constructor

new RunnableMap<RunInput, RunOutput>(fields): RunnableMap<RunInput, RunOutput>
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>
Overrides Runnable.constructor
- Defined in langchain-core/src/runnables/base.ts:1507

Properties

`Optional` name

name?: string

`Protected` steps

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

Methods

assign

assign(mapping): Runnable<any, any, RunnableConfig>
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>
Inherited from Runnable.assign
- Defined in langchain-core/src/runnables/base.ts:576

batch

batch(inputs, options?, batchOptions?): Promise<RunOutput[]>
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<RunnableConfig> | Partial<RunnableConfig>[]
  
  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<RunOutput[]>
An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
Inherited from Runnable.batch
- Defined in langchain-core/src/runnables/base.ts:247
batch(inputs, options?, batchOptions?): Promise<(Error | RunOutput)[]>
Parameters
- inputs: RunInput[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(Error | RunOutput)[]>
Inherited from Runnable.batch
- Defined in langchain-core/src/runnables/base.ts:253
batch(inputs, options?, batchOptions?): Promise<(Error | RunOutput)[]>
Parameters
- inputs: RunInput[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(Error | RunOutput)[]>
Inherited from Runnable.batch
- Defined in langchain-core/src/runnables/base.ts:259

bind

bind(kwargs): Runnable<RunInput, RunOutput, RunnableConfig>
Bind arguments to a Runnable, returning a new Runnable.
Parameters
- kwargs: Partial<RunnableConfig>
Returns Runnable<RunInput, RunOutput, RunnableConfig>
A new RunnableBinding that, when invoked, will apply the bound args.
Inherited from Runnable.bind
- Defined in langchain-core/src/runnables/base.ts:157

getName

getName(suffix?): string
Parameters
- Optional suffix: string
Returns string
Inherited from Runnable.getName
- Defined in langchain-core/src/runnables/base.ts:140

getStepsKeys

getStepsKeys(): string[]
Returns string[]
- Defined in langchain-core/src/runnables/base.ts:1503

invoke

invoke(input, options?): Promise<RunOutput>
Parameters
- input: RunInput
- Optional options: Partial<RunnableConfig>
Returns Promise<RunOutput>
Overrides Runnable.invoke
- Defined in langchain-core/src/runnables/base.ts:1525

map

map(): Runnable<RunInput[], RunOutput[], RunnableConfig>
Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

Returns Runnable<RunInput[], RunOutput[], RunnableConfig>
Inherited from Runnable.map
- Defined in langchain-core/src/runnables/base.ts:168

pick

pick(keys): 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>
Inherited from Runnable.pick
- Defined in langchain-core/src/runnables/base.ts:568

pipe

pipe<NewRunOutput>(coerceable): Runnable<RunInput, Exclude<NewRunOutput, Error>, 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<RunOutput, NewRunOutput>
  
  A runnable, function, or object whose values are functions or runnables.
Returns Runnable<RunInput, Exclude<NewRunOutput, Error>, RunnableConfig>
A new runnable sequence.
Inherited from Runnable.pipe
- Defined in langchain-core/src/runnables/base.ts:555

stream

stream(input, options?): Promise<IterableReadableStream<RunOutput>>
Stream output in chunks.
Parameters
- input: RunInput
- Optional options: Partial<RunnableConfig>
Returns Promise<IterableReadableStream<RunOutput>>
A readable stream that is also an iterable.
Overrides Runnable.stream
- Defined in langchain-core/src/runnables/base.ts:1610

streamLog

streamLog(input, options?, streamOptions?): AsyncGenerator<RunLogPatch, any, unknown>
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<RunnableConfig>
- Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">
Returns AsyncGenerator<RunLogPatch, any, unknown>
Inherited from Runnable.streamLog
- Defined in langchain-core/src/runnables/base.ts:624

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from Runnable.toJSON
- Defined in langchain-core/src/load/serializable.ts:140

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from Runnable.toJSONNotImplemented
- Defined in langchain-core/src/load/serializable.ts:214

transform

transform(generator, options?): AsyncGenerator<RunOutput, 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>
Overrides Runnable.transform
- Defined in langchain-core/src/runnables/base.ts:1599

withConfig

withConfig(config): RunnableBinding<RunInput, RunOutput, RunnableConfig>
Bind config to a Runnable, returning a new Runnable.
Parameters
- config: RunnableConfig
  
  New configuration parameters to attach to the new runnable.
Returns RunnableBinding<RunInput, RunOutput, RunnableConfig>
A new RunnableBinding with a config matching what's passed.
Inherited from Runnable.withConfig
- Defined in langchain-core/src/runnables/base.ts:197

withFallbacks

withFallbacks(fields): RunnableWithFallbacks<RunInput, RunOutput>
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<RunInput, RunOutput, RunnableConfig>[];
  }
  - fallbacks: Runnable<RunInput, RunOutput, RunnableConfig>[]
    
    Other runnables to call if the runnable errors.
Returns RunnableWithFallbacks<RunInput, RunOutput>
A new RunnableWithFallbacks.
Inherited from Runnable.withFallbacks
- Defined in langchain-core/src/runnables/base.ts:214

withListeners

withListeners(params): Runnable<RunInput, RunOutput, RunnableConfig>
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
      
      run: Run
      
      Optional config: RunnableConfig
      
      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
      
      run: Run
      
      Optional config: RunnableConfig
      
      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
      
      run: Run
      
      Optional config: RunnableConfig
      
      Returns void | Promise<void>
Returns Runnable<RunInput, RunOutput, RunnableConfig>
Inherited from Runnable.withListeners
- Defined in langchain-core/src/runnables/base.ts:690

withRetry

withRetry(fields?): RunnableRetry<RunInput, RunOutput, RunnableConfig>
Add retry logic to an existing runnable.
Parameters
- Optional fields: {
  onFailedAttempt?: RunnableRetryFailedAttemptHandler;
  stopAfterAttempt?: number;
  }
  - Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
  - Optional stopAfterAttempt?: number
Returns RunnableRetry<RunInput, RunOutput, RunnableConfig>
A new RunnableRetry that, when invoked, will retry according to the parameters.
Inherited from Runnable.withRetry
- Defined in langchain-core/src/runnables/base.ts:178

`Static` from

from<RunInput, RunOutput>(steps): RunnableMap<RunInput, RunOutput>
Type Parameters
- RunInput
- RunOutput extends Record<string, any> = Record<string, any>
Parameters
- steps: RunnableMapLike<RunInput, RunOutput>
Returns RunnableMap<RunInput, RunOutput>
- Defined in langchain-core/src/runnables/base.ts:1515

`Static` isRunnable

isRunnable(thing): thing is Runnable<any, any, RunnableConfig>
Parameters
- thing: any
Returns thing is Runnable<any, any, RunnableConfig>
Inherited from Runnable.isRunnable
- Defined in langchain-core/src/runnables/base.ts:675

Class RunnableMap<RunInput, RunOutput>

Example

Type Parameters

RunInput = any

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

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

Optional name

Protected steps

Methods

assign

Parameters

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

Returns Runnable<any, any, RunnableConfig>

batch

Parameters

inputs: RunInput[]

Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

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

Returns Promise<RunOutput[]>

Parameters

inputs: RunInput[]

Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(Error | RunOutput)[]>

Parameters

inputs: RunInput[]

Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

Optional batchOptions: RunnableBatchOptions

Returns Promise<(Error | RunOutput)[]>

bind

Parameters

kwargs: Partial<RunnableConfig>

Returns Runnable<RunInput, RunOutput, RunnableConfig>

getName

Parameters

Optional suffix: string

Returns string

getStepsKeys

Returns string[]

invoke

Parameters

input: RunInput

Optional options: Partial<RunnableConfig>

Returns Promise<RunOutput>

map

Returns Runnable<RunInput[], RunOutput[], RunnableConfig>

pick

Parameters

keys: string | string[]

Returns Runnable<any, any, RunnableConfig>

pipe

Type Parameters

NewRunOutput

Parameters

coerceable: RunnableLike<RunOutput, NewRunOutput>

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

stream

Parameters

input: RunInput

Optional options: Partial<RunnableConfig>

Returns Promise<IterableReadableStream<RunOutput>>

streamLog

Parameters

input: RunInput

Optional options: Partial<RunnableConfig>

Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

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

`Optional` name

`Protected` steps

`Optional` options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

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

`Optional` options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions: true;
}

`Optional` options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

`Optional` batchOptions: RunnableBatchOptions

`Optional` suffix: string

`Optional` options: Partial<RunnableConfig>

`Optional` options: Partial<RunnableConfig>

`Optional` options: Partial<RunnableConfig>

`Optional` streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

`Optional` options: Partial<RunnableConfig>

fields: {
fallbacks: Runnable<RunInput, RunOutput, RunnableConfig>[];
}

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

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

`Optional` config: RunnableConfig

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

`Optional` config: RunnableConfig

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

`Optional` config: RunnableConfig

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

`Optional` onFailedAttempt?: RunnableRetryFailedAttemptHandler

`Optional` stopAfterAttempt?: number

`Static` from

`Static` isRunnable