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 Summary)

RouterChain
- LLMRouterChain

Implements

LLMRouterChainInput

Index

Constructors

constructor

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

Properties

llmChain

llmChain: LLMChain<RouterOutputSchema>

`Optional`memory

memory?: any

Accessors

inputKeys

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

lc_namespace

get lc_namespace(): string[]
Returns string[]
Inherited from RouterChain.lc_namespace
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:41

outputKeys

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

Methods

_call

_call(values: ChainValues, runManager?: any): Promise<RouterOutputSchema>
Run the core logic of this chain and return the output
Parameters
- values: ChainValues
- OptionalrunManager: any
Returns Promise<RouterOutputSchema>
Overrides RouterChain._call
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/router/llm_router.ts:44

_chainType

_chainType(): string
Return the string type key uniquely identifying this class of chain.

Returns string
Overrides RouterChain._chainType
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/router/llm_router.ts:51

`Protected`_formatValues

_formatValues(values: any): Promise<any>
Parameters
- values: any
Returns Promise<any>
Inherited from RouterChain._formatValues
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:217

apply

apply(inputs: ChainValues[], config?: any[]): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optionalconfig: any[]
Returns Promise<ChainValues[]>
Deprecated
Use .batch() instead. Will be removed in 0.2.0.

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

call

call(values: any, config?: any, tags?: string[]): Promise<ChainValues>
Parameters
- values: any
- Optionalconfig: any
- Optionaltags: 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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:243

invoke

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

prepOutputs

prepOutputs(
    inputs: Record<string, unknown>,
    outputs: Record<string, unknown>,
    returnOnlyOutputs?: boolean,
): 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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:149

route

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

run

run(input: any, config?: any): Promise<string>
Parameters
- input: any
- Optionalconfig: any
Returns Promise<string>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from RouterChain.run
- Defined in remotes/langchain-ai/langchainjs/v1/libs/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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:181

`Static`deserialize

deserialize(
data: SerializedBaseChain,
values?: LoadValues,
): 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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:270

`Static`fromLLM

fromLLM(
    llm: BaseLanguageModelInterface,
    prompt: BasePromptTemplate,
    options?: Omit<LLMRouterChainInput, "llmChain">,
): 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.
- Optionaloptions: Omit<LLMRouterChainInput, "llmChain">
  Optional LLMRouterChainInput object, excluding "llmChain".
Returns LLMRouterChain
An instance of LLMRouterChain.
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/router/llm_router.ts:65

Class LLMRouterChain

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LLMRouterChain

Properties

llmChain

Optionalmemory

Accessors

inputKeys

Returns string[]

lc_namespace

Returns string[]

outputKeys

Returns string[]

Methods

_call

Parameters

Returns Promise<RouterOutputSchema>

_chainType

Returns string

Protected_formatValues

Parameters

Returns Promise<any>

apply

Parameters

Returns Promise<ChainValues[]>

Deprecated

call

Parameters

Deprecated

Returns Promise<ChainValues>

Deprecated

invoke

Parameters

Returns Promise<ChainValues>

prepOutputs

Parameters

Returns Promise<Record<string, unknown>>

route

Parameters

Returns Promise<Route>

run

Parameters

Returns Promise<string>

Deprecated

serialize

Returns SerializedBaseChain

Staticdeserialize

Parameters

Returns Promise<BaseChain<ChainValues, ChainValues>>

StaticfromLLM

Parameters

Returns LLMRouterChain

Settings

On This Page

`Optional`memory

`Protected`_formatValues

`Static`deserialize

`Static`fromLLM