Class ChatVectorDBQAChain

Deprecated

use ConversationalRetrievalQAChain instead.

Hierarchy

BaseChain
- ChatVectorDBQAChain

Implements

ChatVectorDBQAChainInput

Index

Constructors

constructor

new ChatVectorDBQAChain(fields): ChatVectorDBQAChain
Parameters
- fields: ChatVectorDBQAChainInput
Returns ChatVectorDBQAChain
Overrides BaseChain.constructor
- Defined in docs/api_refs/langchain/src/chains/chat_vector_db_chain.ts:70

Properties

chatHistoryKey

chatHistoryKey: string = "chat_history"

combineDocumentsChain

combineDocumentsChain: BaseChain<ChainValues, ChainValues>

inputKey

inputKey: string = "question"

k

k: number = 4

outputKey

outputKey: string = "result"

questionGeneratorChain

questionGeneratorChain: LLMChain<string, LLMType>

returnSourceDocuments

returnSourceDocuments: boolean = false

vectorstore

vectorstore: VectorStore

`Optional` memory

memory?: BaseMemory

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseChain.inputKeys
- Defined in docs/api_refs/langchain/src/chains/chat_vector_db_chain.ts:52

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides BaseChain.outputKeys
- Defined in docs/api_refs/langchain/src/chains/chat_vector_db_chain.ts:58

Methods

apply

apply(inputs, config?): Promise<ChainValues[]>
Call the chain on all inputs in the list
Parameters
- inputs: ChainValues[]
- Optional config: (BaseCallbackConfig | Callbacks)[]
Returns Promise<ChainValues[]>
Inherited from BaseChain.apply
- Defined in docs/api_refs/langchain/src/chains/base.ts:252

call

call(values, config?, tags?): Promise<ChainValues>
Run the core logic of this chain and add to output if desired.

Wraps _call and handles memory.
Parameters
- values: ChainValues & {
  signal?: AbortSignal;
  timeout?: number;
  }
- Optional config: BaseCallbackConfig | Callbacks
- Optional tags: string[]
  
  Deprecated
Returns Promise<ChainValues>
Inherited from BaseChain.call
- Defined in docs/api_refs/langchain/src/chains/base.ts:192

invoke

invoke(input, config?): Promise<ChainValues>
Invoke the chain with the provided input and returns the output.
Parameters
- input: ChainValues
  
  Input values for the chain run.
- Optional config: BaseCallbackConfig
  
  Optional configuration for the Runnable.
Returns Promise<ChainValues>
Promise that resolves with the output of the chain run.
Inherited from BaseChain.invoke
- Defined in docs/api_refs/langchain/src/chains/base.ts:83

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 BaseChain.prepOutputs
- Defined in docs/api_refs/langchain/src/chains/base.ts:99

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: BaseCallbackConfig | Callbacks
Returns Promise<string>
Inherited from BaseChain.run
- Defined in docs/api_refs/langchain/src/chains/base.ts:140

serialize

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

Returns SerializedChatVectorDBQAChain
Overrides BaseChain.serialize
- Defined in docs/api_refs/langchain/src/chains/chat_vector_db_chain.ts:166

`Static` deserialize

deserialize(data, values): Promise<ChatVectorDBQAChain>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedChatVectorDBQAChain
- values: LoadValues
Returns Promise<ChatVectorDBQAChain>
Overrides BaseChain.deserialize
- Defined in docs/api_refs/langchain/src/chains/chat_vector_db_chain.ts:143

`Static` fromLLM

fromLLM(llm, vectorstore, options?): ChatVectorDBQAChain
Creates an instance of ChatVectorDBQAChain using a BaseLanguageModel and other options.
Parameters
- llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>
  
  Instance of BaseLanguageModel used to generate a new question.
- vectorstore: VectorStore
  
  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.
- Defined in docs/api_refs/langchain/src/chains/chat_vector_db_chain.ts:183

Class ChatVectorDBQAChain

Deprecated

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: ChatVectorDBQAChainInput

Returns ChatVectorDBQAChain

Properties

chatHistoryKey

combineDocumentsChain

inputKey

k

outputKey

questionGeneratorChain

returnSourceDocuments

vectorstore

Optional memory

Accessors

inputKeys

Returns string[]

outputKeys

Returns string[]

Methods

apply

Parameters

inputs: ChainValues[]

Optional config: (BaseCallbackConfig | Callbacks)[]

Returns Promise<ChainValues[]>

call

Parameters

values: ChainValues & { signal?: AbortSignal; timeout?: number; }

Optional config: BaseCallbackConfig | Callbacks

Optional tags: string[]

Deprecated

Returns Promise<ChainValues>

invoke

Parameters

input: ChainValues

Optional config: BaseCallbackConfig

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

Returns Promise<string>

serialize

Returns SerializedChatVectorDBQAChain

Static deserialize

Parameters

data: SerializedChatVectorDBQAChain

values: LoadValues

Returns Promise<ChatVectorDBQAChain>

Static fromLLM

Parameters

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

vectorstore: VectorStore

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

Optional inputKey?: string

Optional k?: number

Optional outputKey?: string

Optional qaTemplate?: string

Optional questionGeneratorTemplate?: string

Optional returnSourceDocuments?: boolean

Optional verbose?: boolean

Returns ChatVectorDBQAChain

Settings

Member Visibility

`Optional` memory

`Optional` config: (BaseCallbackConfig | Callbacks)[]

values: ChainValues & {
signal?: AbortSignal;
timeout?: number;
}

`Optional` config: BaseCallbackConfig | Callbacks

`Optional` tags: string[]

`Optional` config: BaseCallbackConfig

`Optional` config: BaseCallbackConfig | Callbacks

`Static` deserialize

`Static` fromLLM

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

`Optional` inputKey?: string

`Optional` k?: number

`Optional` outputKey?: string

`Optional` qaTemplate?: string

`Optional` questionGeneratorTemplate?: string

`Optional` returnSourceDocuments?: boolean

`Optional` verbose?: boolean