Class VectorDBQAChain

Class that represents a VectorDBQAChain. It extends the BaseChain class and implements the VectorDBQAChainInput interface. It performs a similarity search using a vector store and combines the search results using a specified combine documents chain.

Deprecated

Switch to createRetrievalChain Will be removed in 0.2.0

Hierarchy (view full)

Implements

Constructors

constructor

Properties

combineDocumentsChain inputKey k returnSourceDocuments vectorstore memory?

Accessors

inputKeys outputKeys

Methods

apply call invoke prepOutputs run serialize deserialize fromLLM

Constructors

constructor

Properties

combineDocumentsChain

combineDocumentsChain: BaseChain<ChainValues, ChainValues>

inputKey

inputKey: string = "query"

k

k: number = 4

returnSourceDocuments

returnSourceDocuments: boolean = false

vectorstore

vectorstore: VectorStoreInterface

Optionalmemory

memory?: any

Accessors

inputKeys

outputKeys

Methods

apply

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

  • Parameters

    • inputs: ChainValues[]
    • Optionalconfig: any[]

    Returns Promise<ChainValues[]>

    Deprecated

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

    Call the chain on all inputs in the list

call

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

  • Parameters

    • values: any
    • Optionalconfig: any
    • Optionaltags: 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.

    • Optionaloptions: any

    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
    • Optionalconfig: any

    Returns Promise<string>

    Deprecated

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

serialize

Staticdeserialize

StaticfromLLM

  • fromLLM(llm, vectorstore, options?): VectorDBQAChain

  • Static method that creates a VectorDBQAChain instance from a BaseLanguageModel and a vector store. It also accepts optional options to customize the chain.

    Parameters

    • llm: BaseLanguageModelInterface

      The BaseLanguageModel instance.

    • vectorstore: VectorStoreInterface

      The vector store used for similarity search.

    • Optionaloptions: Partial<Omit<VectorDBQAChainInput, "vectorstore" | "combineDocumentsChain">>

      Optional options to customize the chain.

    Returns VectorDBQAChain

    A new instance of VectorDBQAChain.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods