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

Index

Constructors

constructor

new RunnableMap<RunInput>(fields): RunnableMap<RunInput>
Type Parameters
- RunInput
Parameters
- fields: {
  steps: Record<string, RunnableLike<RunInput, any>>;
  }
  - steps: Record<string, RunnableLike<RunInput, any>>
Returns RunnableMap<RunInput>
Overrides Runnable.constructor
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:1332

Properties

`Protected` steps

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

Methods

batch

batch(inputs, options?, batchOptions?): Promise<Record<string, any>[]>
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
Inherited from Runnable.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:159
batch(inputs, options?, batchOptions?): Promise<(Record<string, any> | Error)[]>
Parameters
- inputs: RunInput[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(Record<string, any> | Error)[]>
Inherited from Runnable.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:165
batch(inputs, options?, batchOptions?): Promise<(Record<string, any> | Error)[]>
Parameters
- inputs: RunInput[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(Record<string, any> | Error)[]>
Inherited from Runnable.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:171

bind

bind(kwargs): Runnable<RunInput, Record<string, any>, BaseCallbackConfig>
Bind arguments to a Runnable, returning a new Runnable.
Parameters
- kwargs: Partial<BaseCallbackConfig>
Returns Runnable<RunInput, Record<string, any>, BaseCallbackConfig>
A new RunnableBinding that, when invoked, will apply the bound args.
Inherited from Runnable.bind
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:67

getStepsKeys

getStepsKeys(): string[]
Returns string[]
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:1328

invoke

invoke(input, options?): Promise<Record<string, any>>
Parameters
- input: RunInput
- Optional options: Partial<BaseCallbackConfig>
Returns Promise<Record<string, any>>
Overrides Runnable.invoke
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:1344

map

map(): Runnable<RunInput[], Record<string, any>[], BaseCallbackConfig>
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>
Inherited from Runnable.map
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:78

pipe

pipe<NewRunOutput>(coerceable): RunnableSequence<RunInput, Exclude<NewRunOutput, Error>>
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.
Inherited from Runnable.pipe
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:461

stream

stream(input, options?): Promise<IterableReadableStream<Record<string, any>>>
Stream output in chunks.
Parameters
- input: RunInput
- Optional options: Partial<BaseCallbackConfig>
Returns Promise<IterableReadableStream<Record<string, any>>>
A readable stream that is also an iterable.
Inherited from Runnable.stream
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:225

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<BaseCallbackConfig>
- Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">
Returns AsyncGenerator<RunLogPatch, any, unknown>
Inherited from Runnable.streamLog
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:507

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from Runnable.toJSON
- Defined in docs/api_refs/langchain/src/load/serializable.ts:148

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from Runnable.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/load/serializable.ts:222

transform

transform(generator, options): AsyncGenerator<Record<string, any>, 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>
- options: Partial<BaseCallbackConfig>
Returns AsyncGenerator<Record<string, any>, any, unknown>
Inherited from Runnable.transform
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:478

withConfig

withConfig(config): RunnableBinding<RunInput, Record<string, any>, BaseCallbackConfig>
Bind config to a Runnable, returning a new Runnable.
Parameters
- config: BaseCallbackConfig
  
  New configuration parameters to attach to the new runnable.
Returns RunnableBinding<RunInput, Record<string, any>, BaseCallbackConfig>
A new RunnableBinding with a config matching what's passed.
Inherited from Runnable.withConfig
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:107

withFallbacks

withFallbacks(fields): RunnableWithFallbacks<RunInput, Record<string, any>>
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, Record<string, any>, BaseCallbackConfig>[];
  }
  - fallbacks: Runnable<RunInput, Record<string, any>, BaseCallbackConfig>[]
    
    Other runnables to call if the runnable errors.
Returns RunnableWithFallbacks<RunInput, Record<string, any>>
A new RunnableWithFallbacks.
Inherited from Runnable.withFallbacks
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:124

withRetry

withRetry(fields?): RunnableRetry<RunInput, Record<string, any>, BaseCallbackConfig>
Add retry logic to an existing runnable.
Parameters
- Optional fields: {
  onFailedAttempt?: RunnableRetryFailedAttemptHandler;
  stopAfterAttempt?: number;
  }
  - Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
  - Optional stopAfterAttempt?: number
Returns RunnableRetry<RunInput, Record<string, any>, BaseCallbackConfig>
A new RunnableRetry that, when invoked, will retry according to the parameters.
Inherited from Runnable.withRetry
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:88

`Static` from

from<RunInput>(steps): RunnableMap<RunInput>
Type Parameters
- RunInput
Parameters
- steps: Record<string, RunnableLike<RunInput, any>>
Returns RunnableMap<RunInput>
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:1340

`Static` isRunnable

isRunnable(thing): thing is Runnable<any, any, BaseCallbackConfig>
Parameters
- thing: any
Returns thing is Runnable<any, any, BaseCallbackConfig>
Inherited from Runnable.isRunnable
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:557

Class RunnableMap<RunInput>

Example

Type Parameters

RunInput

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

RunInput

Parameters

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

steps: Record<string, RunnableLike<RunInput, any>>

Returns RunnableMap<RunInput>

Properties

Protected steps

Methods

batch

Parameters

inputs: RunInput[]

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

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

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

Parameters

inputs: RunInput[]

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

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

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

Parameters

inputs: RunInput[]

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

Optional batchOptions: RunnableBatchOptions

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

bind

Parameters

kwargs: Partial<BaseCallbackConfig>

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

getStepsKeys

Returns string[]

invoke

Parameters

input: RunInput

Optional options: Partial<BaseCallbackConfig>

Returns Promise<Record<string, any>>

map

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

pipe

Type Parameters

NewRunOutput

Parameters

coerceable: RunnableLike<Record<string, any>, NewRunOutput>

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

stream

Parameters

input: RunInput

Optional options: Partial<BaseCallbackConfig>

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

streamLog

Parameters

input: RunInput

Optional options: Partial<BaseCallbackConfig>

Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

Returns AsyncGenerator<RunLogPatch, any, unknown>

toJSON

Returns Serialized

toJSONNotImplemented

Returns SerializedNotImplemented

transform

Parameters

generator: AsyncGenerator<RunInput, any, unknown>

options: Partial<BaseCallbackConfig>

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

withConfig

Parameters

config: BaseCallbackConfig

Returns RunnableBinding<RunInput, Record<string, any>, BaseCallbackConfig>

withFallbacks

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

`Protected` steps

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

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

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

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

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

`Optional` batchOptions: RunnableBatchOptions

`Optional` options: Partial<BaseCallbackConfig>

`Optional` options: Partial<BaseCallbackConfig>

`Optional` options: Partial<BaseCallbackConfig>

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

fields: {
fallbacks: Runnable<RunInput, Record<string, any>, BaseCallbackConfig>[];
}

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

`Optional` onFailedAttempt?: RunnableRetryFailedAttemptHandler

`Optional` stopAfterAttempt?: number

`Static` from

`Static` isRunnable