Class LLMRouterChain

A class that represents an LLM router chain in the LangChain framework. It extends the RouterChain class and implements the LLMRouterChainInput interface. It provides additional functionality specific to LLMs and routing based on LLM predictions.

Hierarchy (view full)

RouterChain
- LLMRouterChain

Implements

LLMRouterChainInput

Index

Constructors

constructor

new LLMRouterChain(fields): LLMRouterChain
Parameters
- fields: LLMRouterChainInput
Returns LLMRouterChain
Overrides RouterChain.constructor
- Defined in langchain/src/chains/router/llm_router.ts:35

Properties

llmChain

llmChain: LLMChain<RouterOutputSchema, any>

`Optional` memory

memory?: any

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides RouterChain.inputKeys
- Defined in langchain/src/chains/router/llm_router.ts:40

outputKeys

get outputKeys(): string[]
Returns string[]
Inherited from RouterChain.outputKeys
- Defined in langchain/src/chains/router/multi_route.ts:45

Methods

apply

apply(inputs, config?): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optional config: any[]
Returns Promise<ChainValues[]>

⚠️ Deprecated ⚠️

Use .batch() instead. Will be removed in 0.2.0.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Call the chain on all inputs in the list
Inherited from RouterChain.apply
- Defined in langchain/src/chains/base.ts:258

call

call(values, config?, tags?): Promise<ChainValues>
Parameters
- values: any
- Optional config: any
- Optional tags: string[]
  Deprecated
Returns Promise<ChainValues>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.

Run the core logic of this chain and add to output if desired.

Wraps _call and handles memory.
Inherited from RouterChain.call
- Defined in langchain/src/chains/base.ts:243

invoke

invoke(input, options?): Promise<ChainValues>
Invoke the chain with the provided input and returns the output.
Parameters
- input: ChainValues
  Input values for the chain run.
- Optional options: any
Returns Promise<ChainValues>
Promise that resolves with the output of the chain run.
Inherited from RouterChain.invoke
- Defined in langchain/src/chains/base.ts:86

prepOutputs

prepOutputs(inputs, outputs, returnOnlyOutputs?): Promise<Record<string, unknown>>
Parameters
- inputs: Record<string, unknown>
- outputs: Record<string, unknown>
- returnOnlyOutputs: boolean = false
Returns Promise<Record<string, unknown>>
Inherited from RouterChain.prepOutputs
- Defined in langchain/src/chains/base.ts:149

route

route(inputs, callbacks?): Promise<Route>
Parameters
- inputs: ChainValues
- Optional callbacks: any
Returns Promise<Route>
Inherited from RouterChain.route
- Defined in langchain/src/chains/router/multi_route.ts:49

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: any
Returns Promise<string>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from RouterChain.run
- Defined in langchain/src/chains/base.ts:190

serialize

serialize(): SerializedBaseChain
Return a json-like object representing this chain.

Returns SerializedBaseChain
Inherited from RouterChain.serialize
- Defined in langchain/src/chains/base.ts:181

`Static` deserialize

deserialize(data, values?): Promise<BaseChain<ChainValues, ChainValues>>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedBaseChain
- values: LoadValues = {}
Returns Promise<BaseChain<ChainValues, ChainValues>>
Inherited from RouterChain.deserialize
- Defined in langchain/src/chains/base.ts:270

`Static` fromLLM

fromLLM(llm, prompt, options?): LLMRouterChain
A static method that creates an instance of LLMRouterChain from a BaseLanguageModel and a BasePromptTemplate. It takes in an optional options object and returns an instance of LLMRouterChain with the specified LLMChain.
Parameters
- llm: BaseLanguageModelInterface
  A BaseLanguageModel instance.
- prompt: BasePromptTemplate
  A BasePromptTemplate instance.
- Optional options: Omit<LLMRouterChainInput, "llmChain">
  Optional LLMRouterChainInput object, excluding "llmChain".
Returns LLMRouterChain
An instance of LLMRouterChain.
- Defined in langchain/src/chains/router/llm_router.ts:65

Class LLMRouterChain

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: LLMRouterChainInput

Returns LLMRouterChain

Properties

llmChain

Optional memory

Accessors

inputKeys

Returns string[]

outputKeys

Returns string[]

Methods

apply

Parameters

inputs: ChainValues[]

Optional config: any[]

Returns Promise<ChainValues[]>

⚠️ Deprecated ⚠️

call

Parameters

values: any

Optional config: any

Optional tags: string[]

Deprecated

Returns Promise<ChainValues>

Deprecated

invoke

Parameters

input: ChainValues

Optional options: any

Returns Promise<ChainValues>

prepOutputs

Parameters

inputs: Record<string, unknown>

outputs: Record<string, unknown>

returnOnlyOutputs: boolean = false

Returns Promise<Record<string, unknown>>

route

Parameters

inputs: ChainValues

Optional callbacks: any

Returns Promise<Route>

run

Parameters

input: any

Optional config: any

Returns Promise<string>

Deprecated

serialize

Returns SerializedBaseChain

Static deserialize

Parameters

data: SerializedBaseChain

values: LoadValues = {}

Returns Promise<BaseChain<ChainValues, ChainValues>>

Static fromLLM

Parameters

llm: BaseLanguageModelInterface

prompt: BasePromptTemplate

Optional options: Omit<LLMRouterChainInput, "llmChain">

Returns LLMRouterChain

Settings

Member Visibility

Theme

On This Page

`Optional` memory

`Optional` config: any[]

`Optional` config: any

`Optional` tags: string[]

`Optional` options: any

`Optional` callbacks: any

`Optional` config: any

`Static` deserialize

`Static` fromLLM

`Optional` options: Omit<LLMRouterChainInput, "llmChain">