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

RouterChain
- LLMRouterChain

Implements

LLMRouterChainInput

Index

Constructors

constructor

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

Properties

llmChain

llmChain: LLMChain<RouterOutputSchema, LLMType>

`Optional` memory

memory?: BaseMemory

Accessors

inputKeys

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

outputKeys

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

Methods

apply

apply(inputs, config?): Promise<ChainValues[]>
Call the chain on all inputs in the list
Parameters
- inputs: ChainValues[]
- Optional config: (BaseCallbackConfig | Callbacks)[]
Returns Promise<ChainValues[]>
Inherited from RouterChain.apply
- Defined in docs/api_refs/langchain/src/chains/base.ts:252

call

call(values, config?, tags?): Promise<ChainValues>
Run the core logic of this chain and add to output if desired.

Wraps _call and handles memory.
Parameters
- values: ChainValues & {
  signal?: AbortSignal;
  timeout?: number;
  }
- Optional config: BaseCallbackConfig | Callbacks
- Optional tags: string[]
  
  Deprecated
Returns Promise<ChainValues>
Inherited from RouterChain.call
- Defined in docs/api_refs/langchain/src/chains/base.ts:192

invoke

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

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 docs/api_refs/langchain/src/chains/base.ts:99

route

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

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: BaseCallbackConfig | Callbacks
Returns Promise<string>
Inherited from RouterChain.run
- Defined in docs/api_refs/langchain/src/chains/base.ts:140

serialize

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

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

`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 docs/api_refs/langchain/src/chains/base.ts:264

`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: BaseLanguageModel<any, BaseLanguageModelCallOptions>
  
  A BaseLanguageModel instance.
- prompt: BasePromptTemplate<any, BasePromptValue, any>
  
  A BasePromptTemplate instance.
- Optional options: Omit<LLMRouterChainInput, "llmChain">
  
  Optional LLMRouterChainInput object, excluding "llmChain".
Returns LLMRouterChain
An instance of LLMRouterChain.
- Defined in docs/api_refs/langchain/src/chains/router/llm_router.ts:67

Class LLMRouterChain

Hierarchy

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: (BaseCallbackConfig | Callbacks)[]

Returns Promise<ChainValues[]>

call

Parameters

values: ChainValues & { signal?: AbortSignal; timeout?: number; }

Optional config: BaseCallbackConfig | Callbacks

Optional tags: string[]

Deprecated

Returns Promise<ChainValues>

invoke

Parameters

input: ChainValues

Optional config: BaseCallbackConfig

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: Callbacks

Returns Promise<Route>

run

Parameters

input: any

Optional config: BaseCallbackConfig | Callbacks

Returns Promise<string>

serialize

Returns SerializedBaseChain

Static deserialize

Parameters

data: SerializedBaseChain

values: LoadValues = {}

Returns Promise<BaseChain<ChainValues, ChainValues>>

Static fromLLM

Parameters

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

prompt: BasePromptTemplate<any, BasePromptValue, any>

Optional options: Omit<LLMRouterChainInput, "llmChain">

Returns LLMRouterChain

Settings

Member Visibility

Theme

On This Page

`Optional` memory

`Optional` config: (BaseCallbackConfig | Callbacks)[]

values: ChainValues & {
signal?: AbortSignal;
timeout?: number;
}

`Optional` config: BaseCallbackConfig | Callbacks

`Optional` tags: string[]

`Optional` config: BaseCallbackConfig

`Optional` callbacks: Callbacks

`Optional` config: BaseCallbackConfig | Callbacks

`Static` deserialize

`Static` fromLLM

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