Class MultiRetrievalQAChain

A class that represents a multi-retrieval question answering chain in the LangChain framework. It extends the MultiRouteChain class and provides additional functionality specific to multi-retrieval QA chains.

Example

const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(
  new ChatOpenAI(),
  {
    retrieverNames: ["aqua teen", "mst3k", "animaniacs"],
    retrieverDescriptions: [
      "Good for answering questions about Aqua Teen Hunger Force theme song",
      "Good for answering questions about Mystery Science Theater 3000 theme song",
      "Good for answering questions about Animaniacs theme song",
    ],
    retrievers: [
      new MemoryVectorStore().asRetriever(3),
      new MemoryVectorStore().asRetriever(3),
      new MemoryVectorStore().asRetriever(3),
    ],
    retrievalQAChainOpts: {
      returnSourceDocuments: true,
    },
  },
);

const result = await multiRetrievalQAChain.call({
  input:
    "In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?",
});

console.log(result.sourceDocuments, result.text);

Hierarchy

MultiRouteChain
- MultiRetrievalQAChain

Index

Constructors

constructor

new MultiRetrievalQAChain(fields): MultiRetrievalQAChain
Parameters
- fields: MultiRouteChainInput
Returns MultiRetrievalQAChain
Inherited from MultiRouteChain.constructor
- Defined in docs/api_refs/langchain/src/chains/router/multi_route.ts:77

Properties

defaultChain

defaultChain: BaseChain<ChainValues, ChainValues>

destinationChains

destinationChains: {
[name: string]: BaseChain;
}

Type declaration

[name: string]: BaseChain

routerChain

routerChain: RouterChain

silentErrors

silentErrors: boolean = false

`Optional` memory

memory?: BaseMemory

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Inherited from MultiRouteChain.inputKeys
- Defined in docs/api_refs/langchain/src/chains/router/multi_route.ts:85

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides MultiRouteChain.outputKeys
- Defined in docs/api_refs/langchain/src/chains/router/multi_retrieval_qa.ts:68

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

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: BaseCallbackConfig | Callbacks
Returns Promise<string>
Inherited from MultiRouteChain.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 MultiRouteChain.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 MultiRouteChain.deserialize
- Defined in docs/api_refs/langchain/src/chains/base.ts:264

`Static` fromLLMAndRetrievers

fromLLMAndRetrievers(llm, __namedParameters): MultiRetrievalQAChain
A static method that creates an instance of MultiRetrievalQAChain from a BaseLanguageModel and a set of retrievers. It takes in optional parameters for the retriever names, descriptions, prompts, defaults, and additional options. It is an alternative method to fromRetrievers and provides more flexibility in configuring the underlying chains.
Parameters
- llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>
  
  A BaseLanguageModel instance.
- __namedParameters: {
      retrieverDescriptions: string[];
      retrieverNames: string[];
      retrievers: BaseRetriever[];
      defaults?: MultiRetrievalDefaults;
      multiRetrievalChainOpts?: Omit<MultiRouteChainInput, "defaultChain">;
      retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, "combineDocumentsChain" | "retriever">> & {
          prompt?: PromptTemplate<any, any>;
      };
      retrieverPrompts?: PromptTemplate<any, any>[];
  }
  - retrieverDescriptions: string[]
  - retrieverNames: string[]
  - retrievers: BaseRetriever[]
  - Optional defaults?: MultiRetrievalDefaults
  - Optional multiRetrievalChainOpts?: Omit<MultiRouteChainInput, "defaultChain">
  - Optional retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, "combineDocumentsChain" | "retriever">> & {
    prompt?: PromptTemplate<any, any>;
    }
  - Optional retrieverPrompts?: PromptTemplate<any, any>[]
Returns MultiRetrievalQAChain
A new instance of MultiRetrievalQAChain.
- Defined in docs/api_refs/langchain/src/chains/router/multi_retrieval_qa.ts:110

`Static` fromRetrievers

fromRetrievers(llm, retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts?, defaults?, options?): MultiRetrievalQAChain
Parameters
- llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>
- retrieverNames: string[]
- retrieverDescriptions: string[]
- retrievers: BaseRetriever[]
- Optional retrieverPrompts: PromptTemplate<any, any>[]
- Optional defaults: MultiRetrievalDefaults
- Optional options: Omit<MultiRouteChainInput, "defaultChain">
Returns MultiRetrievalQAChain

Deprecated
Use fromRetrieversAndPrompts instead
- Defined in docs/api_refs/langchain/src/chains/router/multi_retrieval_qa.ts:75

Class MultiRetrievalQAChain

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: MultiRouteChainInput

Returns MultiRetrievalQAChain

Properties

defaultChain

destinationChains

Type declaration

[name: string]: BaseChain

routerChain

silentErrors

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

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 fromLLMAndRetrievers

Parameters

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

retrieverDescriptions: string[]

retrieverNames: string[]

retrievers: BaseRetriever[]

Optional defaults?: MultiRetrievalDefaults

Optional multiRetrievalChainOpts?: Omit<MultiRouteChainInput, "defaultChain">

Optional retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, "combineDocumentsChain" | "retriever">> & { prompt?: PromptTemplate<any, any>; }

Optional retrieverPrompts?: PromptTemplate<any, any>[]

Returns MultiRetrievalQAChain

Static fromRetrievers

Parameters

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

retrieverNames: string[]

retrieverDescriptions: string[]

retrievers: BaseRetriever[]

Optional retrieverPrompts: PromptTemplate<any, any>[]

`Optional` memory

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

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

`Optional` config: BaseCallbackConfig | Callbacks

`Optional` tags: string[]

`Optional` config: BaseCallbackConfig

`Optional` config: BaseCallbackConfig | Callbacks

`Static` deserialize

`Static` fromLLMAndRetrievers

`Optional` defaults?: MultiRetrievalDefaults

`Optional` multiRetrievalChainOpts?: Omit<MultiRouteChainInput, "defaultChain">

`Optional` retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, "combineDocumentsChain" | "retriever">> & {
prompt?: PromptTemplate<any, any>;
}

`Optional` retrieverPrompts?: PromptTemplate<any, any>[]

`Static` fromRetrievers

`Optional` retrieverPrompts: PromptTemplate<any, any>[]

`Optional` defaults: MultiRetrievalDefaults

`Optional` options: Omit<MultiRouteChainInput, "defaultChain">