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

BaseChain
- VectorDBQAChain

Implements

VectorDBQAChainInput

Index

Constructors

constructor

new VectorDBQAChain(fields): VectorDBQAChain
Parameters
- fields: VectorDBQAChainInput
Returns VectorDBQAChain
Overrides BaseChain.constructor
- Defined in langchain/src/chains/vector_db_qa.ts:65

Properties

combineDocumentsChain

combineDocumentsChain: BaseChain<ChainValues, ChainValues>

inputKey

inputKey: string = "query"

k

k: number = 4

returnSourceDocuments

returnSourceDocuments: boolean = false

vectorstore

vectorstore: VectorStoreInterface

`Optional` memory

memory?: any

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseChain.inputKeys
- Defined in langchain/src/chains/vector_db_qa.ts:49

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides BaseChain.outputKeys
- Defined in langchain/src/chains/vector_db_qa.ts:53

Methods

apply

apply(inputs, config?): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optional config: any[]
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
Inherited from BaseChain.apply
- Defined in langchain/src/chains/base.ts:256

call

call(values, config?, tags?): Promise<ChainValues>
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.
Inherited from BaseChain.call
- Defined in langchain/src/chains/base.ts:241

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: any
  
  Optional configuration for the Runnable.
Returns Promise<ChainValues>
Promise that resolves with the output of the chain run.
Inherited from BaseChain.invoke
- Defined in langchain/src/chains/base.ts:86

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 langchain/src/chains/base.ts:148

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: any
Returns Promise<string>

Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from BaseChain.run
- Defined in langchain/src/chains/base.ts:188

serialize

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

Returns SerializedVectorDBQAChain
Overrides BaseChain.serialize
- Defined in langchain/src/chains/vector_db_qa.ts:133

`Static` deserialize

deserialize(data, values): Promise<VectorDBQAChain>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedVectorDBQAChain
- values: LoadValues
Returns Promise<VectorDBQAChain>
Overrides BaseChain.deserialize
- Defined in langchain/src/chains/vector_db_qa.ts:108

`Static` fromLLM

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.
- Optional options: Partial<Omit<VectorDBQAChainInput, "vectorstore" | "combineDocumentsChain">>
  
  Optional options to customize the chain.
Returns VectorDBQAChain
A new instance of VectorDBQAChain.
- Defined in langchain/src/chains/vector_db_qa.ts:150

Class VectorDBQAChain

Deprecated

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: VectorDBQAChainInput

Returns VectorDBQAChain

Properties

combineDocumentsChain

inputKey

k

returnSourceDocuments

vectorstore

Optional memory

Accessors

inputKeys

Returns string[]

outputKeys

Returns string[]

Methods

apply

Parameters

inputs: ChainValues[]

Optional config: any[]

Returns Promise<ChainValues[]>

⚠️ Deprecated ⚠️

call

Parameters

values: any

Optional config: any

Optional tags: string[]

Deprecated

Returns Promise<ChainValues>

Deprecated

invoke

Parameters

input: ChainValues

Optional config: any

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

Returns Promise<string>

Deprecated

serialize

Returns SerializedVectorDBQAChain

Static deserialize

Parameters

data: SerializedVectorDBQAChain

values: LoadValues

Returns Promise<VectorDBQAChain>

Static fromLLM

Parameters

llm: BaseLanguageModelInterface

vectorstore: VectorStoreInterface

Optional options: Partial<Omit<VectorDBQAChainInput, "vectorstore" | "combineDocumentsChain">>

Returns VectorDBQAChain

Settings

Member Visibility

Theme

On This Page

`Optional` memory

`Optional` config: any[]

`Optional` config: any

`Optional` tags: string[]

`Optional` config: any

`Optional` config: any

`Static` deserialize

`Static` fromLLM

`Optional` options: Partial<Omit<VectorDBQAChainInput, "vectorstore" | "combineDocumentsChain">>