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)

Constructors

constructor

Properties

defaultChain destinationChains routerChain silentErrors memory?

Accessors

inputKeys outputKeys

Methods

apply call invoke prepOutputs run serialize deserialize fromLLMAndRetrievers fromRetrievers

Constructors

constructor

Properties

defaultChain

defaultChain: BaseChain<ChainValues, ChainValues>

destinationChains

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

Type declaration

routerChain

routerChain: RouterChain

silentErrors

silentErrors: boolean = false

Optional memory

memory?: BaseMemory

Accessors

inputKeys

outputKeys

Methods

apply

  • apply(inputs, config?): Promise<ChainValues[]>

  • Parameters

    • inputs: ChainValues[]
    • Optional config: (RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[])[]

    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

call

  • call(values, config?, tags?): Promise<ChainValues>

  • Parameters

    • values: ChainValues & {
          signal?: AbortSignal;
          timeout?: number;
      }
    • Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]
    • 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.

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

    Returns Promise<ChainValues>

    Promise that resolves with the output of the chain run.

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

run

  • run(input, config?): Promise<string>

  • Parameters

    • input: any
    • Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

    Returns Promise<string>

    Deprecated

    Use .invoke() instead. Will be removed in 0.2.0.

serialize

Static deserialize

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<any, BaseLanguageModelCallOptions>

      A BaseLanguageModel instance.

    • __namedParameters: {
          retrieverDescriptions: string[];
          retrieverNames: string[];
          retrievers: BaseRetrieverInterface<Record<string, any>>[];
          defaults?: MultiRetrievalDefaults;
          multiRetrievalChainOpts?: Omit<MultiRouteChainInput, "defaultChain">;
          retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, "retriever" | "combineDocumentsChain">> & {
              prompt?: PromptTemplate<any, any>;
          };
          retrieverPrompts?: PromptTemplate<any, any>[];
      }
      • retrieverDescriptions: string[]
      • retrieverNames: string[]
      • retrievers: BaseRetrieverInterface<Record<string, any>>[]
      • Optional defaults?: MultiRetrievalDefaults
      • Optional multiRetrievalChainOpts?: Omit<MultiRouteChainInput, "defaultChain">
      • Optional retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, "retriever" | "combineDocumentsChain">> & {
            prompt?: PromptTemplate<any, any>;
        }
      • Optional retrieverPrompts?: PromptTemplate<any, any>[]

    Returns MultiRetrievalQAChain

    A new instance of MultiRetrievalQAChain.

Static fromRetrievers

  • fromRetrievers(llm, retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts?, defaults?, options?): MultiRetrievalQAChain

  • Parameters

    • llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>
    • retrieverNames: string[]
    • retrieverDescriptions: string[]
    • retrievers: BaseRetrieverInterface<Record<string, any>>[]
    • Optional retrieverPrompts: PromptTemplate<any, any>[]
    • Optional defaults: MultiRetrievalDefaults
    • Optional options: Omit<MultiRouteChainInput, "defaultChain">

    Returns MultiRetrievalQAChain

    Deprecated

    Use fromRetrieversAndPrompts instead

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc