⚠️ Deprecated ⚠️

use ConversationalRetrievalQAChain instead.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Hierarchy

Implements

Constructors

Properties

chatHistoryKey: string = "chat_history"
combineDocumentsChain: BaseChain<ChainValues, ChainValues>
inputKey: string = "question"
k: number = 4
outputKey: string = "result"
questionGeneratorChain: LLMChain<string, any>
returnSourceDocuments: boolean = false
vectorstore: VectorStoreInterface
memory?: any

Accessors

Methods

  • Parameters

    • inputs: ChainValues[]
    • Optional config: any[]

    Returns Promise<ChainValues[]>

    Deprecated

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

    Call the chain on all inputs in the list

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

  • Invoke the chain with the provided input and returns the output.

    Parameters

    • input: ChainValues

      Input values for the chain run.

    • Optional config: any

      Optional configuration for the Runnable.

    Returns Promise<ChainValues>

    Promise that resolves with the output of the chain run.

  • Parameters

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

    Returns Promise<Record<string, unknown>>

  • Parameters

    • input: any
    • Optional config: any

    Returns Promise<string>

    Deprecated

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

  • Creates an instance of ChatVectorDBQAChain using a BaseLanguageModel and other options.

    Parameters

    • llm: BaseLanguageModelInterface

      Instance of BaseLanguageModel used to generate a new question.

    • vectorstore: VectorStoreInterface

      Instance of VectorStore used for vector operations.

    • options: {
          inputKey?: string;
          k?: number;
          outputKey?: string;
          qaTemplate?: string;
          questionGeneratorTemplate?: string;
          returnSourceDocuments?: boolean;
          verbose?: boolean;
      } = {}

      (Optional) Additional options for creating the ChatVectorDBQAChain instance.

      • Optional inputKey?: string
      • Optional k?: number
      • Optional outputKey?: string
      • Optional qaTemplate?: string
      • Optional questionGeneratorTemplate?: string
      • Optional returnSourceDocuments?: boolean
      • Optional verbose?: boolean

    Returns ChatVectorDBQAChain

    New instance of ChatVectorDBQAChain.

Generated using TypeDoc