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

Constructors

Properties

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

Type declaration

routerChain: RouterChain
silentErrors: boolean = false
verbose: boolean

Whether to print out response text.

callbacks?: Callbacks
memory?: BaseMemory
metadata?: Record<string, unknown>
tags?: string[]

Accessors

Methods

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<ChainValues, NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

    Returns RunnableSequence<ChainValues, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Parameters

    • inputs: Record<string, unknown>
    • outputs: Record<string, unknown>
    • returnOnlyOutputs: boolean = false

    Returns Promise<Record<string, unknown>>

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<ChainValues>>

    A readable stream that is also an iterable.

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    Returns AsyncGenerator<ChainValues, any, unknown>

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

    Returns Runnable<ChainValues, ChainValues, BaseCallbackConfig>

  • 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

    Returns MultiRetrievalQAChain

    A new instance of MultiRetrievalQAChain.

Generated using TypeDoc