Class: VectorDBQAChain
chains.VectorDBQAChain
Base interface that all chains must implement.
Hierarchy
↳
VectorDBQAChain
Implements
VectorDBQAChainInput
Constructors
constructor
• new VectorDBQAChain(fields)
Parameters
| Name | Type |
|---|---|
fields | Object |
fields.combineDocumentsChain | BaseChain |
fields.inputKey? | string |
fields.k? | number |
fields.outputKey? | string |
fields.returnSourceDocuments? | boolean |
fields.vectorstore | VectorStore |
Overrides
Defined in
langchain/src/chains/vector_db_qa.ts:38
Properties
callbackManager
• callbackManager: CallbackManager
Inherited from
Defined in
langchain/src/chains/base.ts:25
combineDocumentsChain
• combineDocumentsChain: BaseChain
Implementation of
VectorDBQAChainInput.combineDocumentsChain
Defined in
langchain/src/chains/vector_db_qa.ts:34
inputKey
• inputKey: string = "query"
Implementation of
VectorDBQAChainInput.inputKey
Defined in
langchain/src/chains/vector_db_qa.ts:24
k
• k: number = 4
Implementation of
VectorDBQAChainInput.k
Defined in
langchain/src/chains/vector_db_qa.ts:22
memory
• Optional memory: BaseMemory
Inherited from
Defined in
langchain/src/chains/base.ts:21
outputKey
• outputKey: string = "result"
Implementation of
VectorDBQAChainInput.outputKey
Defined in
langchain/src/chains/vector_db_qa.ts:30
returnSourceDocuments
• returnSourceDocuments: boolean = false
Implementation of
VectorDBQAChainInput.returnSourceDocuments
Defined in
langchain/src/chains/vector_db_qa.ts:36
vectorstore
• vectorstore: VectorStore
Implementation of
VectorDBQAChainInput.vectorstore
Defined in
langchain/src/chains/vector_db_qa.ts:32
verbose
• verbose: boolean
Inherited from
Defined in
langchain/src/chains/base.ts:23
Accessors
inputKeys
• get inputKeys(): string[]
Returns
string[]
Overrides
BaseChain.inputKeys
Defined in
langchain/src/chains/vector_db_qa.ts:26
Methods
_call
▸ _call(values): Promise<ChainValues>
Run the core logic of this chain and return the output
Parameters
| Name | Type |
|---|---|
values | ChainValues |
Returns
Promise<ChainValues>
Overrides
Defined in
langchain/src/chains/vector_db_qa.ts:56
_chainType
▸ _chainType(): "vector_db_qa"
Return the string type key uniquely identifying this class of chain.
Returns
"vector_db_qa"
Overrides
Defined in
langchain/src/chains/vector_db_qa.ts:73
apply
▸ apply(inputs): Promise<ChainValues>
Call the chain on all inputs in the list
Parameters
| Name | Type |
|---|---|
inputs | ChainValues[] |
Returns
Promise<ChainValues>
Inherited from
Defined in
langchain/src/chains/base.ts:109
call
▸ call(values): Promise<ChainValues>
Run the core logic of this chain and add to output if desired.
Wraps _call and handles memory.
Parameters
| Name | Type |
|---|---|
values | ChainValues |
Returns
Promise<ChainValues>
Inherited from
Defined in
langchain/src/chains/base.ts:79
run
▸ run(input): Promise<string>
Parameters
| Name | Type |
|---|---|
input | any |
Returns
Promise<string>
Inherited from
Defined in
langchain/src/chains/base.ts:55
serialize
▸ serialize(): SerializedVectorDBQAChain
Return a json-like object representing this chain.
Returns
Overrides
Defined in
langchain/src/chains/vector_db_qa.ts:102
deserialize
▸ Static deserialize(data, values): Promise<VectorDBQAChain>
Load a chain from a json-like object describing it.
Parameters
| Name | Type |
|---|---|
data | SerializedVectorDBQAChain |
values | LoadValues |
Returns
Promise<VectorDBQAChain>
Overrides
Defined in
langchain/src/chains/vector_db_qa.ts:77
fromLLM
▸ Static fromLLM(llm, vectorstore, options?): VectorDBQAChain
Parameters
| Name | Type |
|---|---|
llm | BaseLanguageModel |
vectorstore | VectorStore |
options? | Partial<Omit<VectorDBQAChainInput, "vectorstore" | "combineDocumentsChain">> |
Returns
Defined in
langchain/src/chains/vector_db_qa.ts:110