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 (view full)

MultiRouteChain
- MultiRetrievalQAChain

Index

Constructors

constructor

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

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?: any

Accessors

inputKeys

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

outputKeys

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

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

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 MultiRouteChain.run
- Defined in langchain/src/chains/base.ts:190

serialize

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

Returns SerializedBaseChain
Inherited from MultiRouteChain.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 MultiRouteChain.deserialize
- Defined in langchain/src/chains/base.ts:270

`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: BaseLanguageModelInterface
  A BaseLanguageModel instance.
- __namedParameters: {
      retrieverDescriptions: string[];
      retrieverNames: string[];
      retrievers: BaseRetrieverInterface[];
      defaults?: MultiRetrievalDefaults;
      multiRetrievalChainOpts?: Omit<MultiRouteChainInput, "defaultChain">;
      retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, "retriever" | "combineDocumentsChain">> & {
          prompt?: any;
      };
      retrieverPrompts?: PromptTemplate[];
  }
  - retrieverDescriptions: string[]
  - retrieverNames: string[]
  - retrievers: BaseRetrieverInterface[]
  - Optional defaults?: MultiRetrievalDefaults
  - Optional multiRetrievalChainOpts?: Omit<MultiRouteChainInput, "defaultChain">
  - Optional retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, "retriever" | "combineDocumentsChain">> & {
    prompt?: any;
    }
  - Optional retrieverPrompts?: PromptTemplate[]
Returns MultiRetrievalQAChain
A new instance of MultiRetrievalQAChain.
- Defined in langchain/src/chains/router/multi_retrieval_qa.ts:109

`Static` fromRetrievers

fromRetrievers(llm, retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts?, defaults?, options?): MultiRetrievalQAChain
Parameters
- llm: BaseLanguageModelInterface
- retrieverNames: string[]
- retrieverDescriptions: string[]
- retrievers: BaseRetrieverInterface[]
- Optional retrieverPrompts: PromptTemplate[]
- Optional defaults: MultiRetrievalDefaults
- Optional options: Omit<MultiRouteChainInput, "defaultChain">
Returns MultiRetrievalQAChain
Deprecated
Use fromRetrieversAndPrompts instead
- Defined in langchain/src/chains/router/multi_retrieval_qa.ts:74

Class MultiRetrievalQAChain

Example

Hierarchy (view full)

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

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 fromLLMAndRetrievers

Parameters

llm: BaseLanguageModelInterface

retrieverDescriptions: string[]

retrieverNames: string[]

retrievers: BaseRetrieverInterface[]

Optional defaults?: MultiRetrievalDefaults

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

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

Optional retrieverPrompts?: PromptTemplate[]

Returns MultiRetrievalQAChain

Static fromRetrievers

Parameters

llm: BaseLanguageModelInterface

retrieverNames: string[]

`Optional` memory

`Optional` config: any[]

`Optional` config: any

`Optional` tags: string[]

`Optional` options: any

`Optional` config: any

`Static` deserialize

`Static` fromLLMAndRetrievers

`Optional` defaults?: MultiRetrievalDefaults

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

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

`Optional` retrieverPrompts?: PromptTemplate[]

`Static` fromRetrievers

`Optional` retrieverPrompts: PromptTemplate[]

`Optional` defaults: MultiRetrievalDefaults

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