Class: ChatVectorDBQAChain
chains.ChatVectorDBQAChain
Base interface that all chains must implement.
Hierarchy
↳
ChatVectorDBQAChain
Implements
ChatVectorDBQAChainInput
Constructors
constructor
• new ChatVectorDBQAChain(fields
)
Parameters
Name | Type |
---|---|
fields | Object |
fields.combineDocumentsChain | BaseChain |
fields.inputKey? | string |
fields.k? | number |
fields.outputKey? | string |
fields.questionGeneratorChain | LLMChain |
fields.returnSourceDocuments? | boolean |
fields.vectorstore | VectorStore |
Overrides
Defined in
langchain/src/chains/chat_vector_db_chain.ts:60
Properties
callbackManager
• callbackManager: CallbackManager
Inherited from
Defined in
langchain/src/chains/base.ts:25
chatHistoryKey
• chatHistoryKey: string
= "chat_history"
Defined in
langchain/src/chains/chat_vector_db_chain.ts:44
combineDocumentsChain
• combineDocumentsChain: BaseChain
Implementation of
ChatVectorDBQAChainInput.combineDocumentsChain
Defined in
langchain/src/chains/chat_vector_db_chain.ts:54
inputKey
• inputKey: string
= "question"
Implementation of
ChatVectorDBQAChainInput.inputKey
Defined in
langchain/src/chains/chat_vector_db_chain.ts:42
k
• k: number
= 4
Implementation of
ChatVectorDBQAChainInput.k
Defined in
langchain/src/chains/chat_vector_db_chain.ts:40
memory
• Optional
memory: BaseMemory
Inherited from
Defined in
langchain/src/chains/base.ts:21
outputKey
• outputKey: string
= "result"
Implementation of
ChatVectorDBQAChainInput.outputKey
Defined in
langchain/src/chains/chat_vector_db_chain.ts:50
questionGeneratorChain
• questionGeneratorChain: LLMChain
Implementation of
ChatVectorDBQAChainInput.questionGeneratorChain
Defined in
langchain/src/chains/chat_vector_db_chain.ts:56
returnSourceDocuments
• returnSourceDocuments: boolean
= false
Defined in
langchain/src/chains/chat_vector_db_chain.ts:58
vectorstore
• vectorstore: VectorStore
Implementation of
ChatVectorDBQAChainInput.vectorstore
Defined in
langchain/src/chains/chat_vector_db_chain.ts:52
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/chat_vector_db_chain.ts:46
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/chat_vector_db_chain.ts:80
_chainType
▸ _chainType(): "chat-vector-db"
Return the string type key uniquely identifying this class of chain.
Returns
"chat-vector-db"
Overrides
Defined in
langchain/src/chains/chat_vector_db_chain.ts:120
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(): SerializedChatVectorDBQAChain
Return a json-like object representing this chain.
Returns
Overrides
Defined in
langchain/src/chains/chat_vector_db_chain.ts:147
deserialize
▸ Static
deserialize(data
, values
): Promise
<ChatVectorDBQAChain
>
Load a chain from a json-like object describing it.
Parameters
Name | Type |
---|---|
data | SerializedChatVectorDBQAChain |
values | LoadValues |
Returns
Promise
<ChatVectorDBQAChain
>
Overrides
Defined in
langchain/src/chains/chat_vector_db_chain.ts:124
fromLLM
▸ Static
fromLLM(llm
, vectorstore
, options?
): ChatVectorDBQAChain
Parameters
Name | Type |
---|---|
llm | BaseLanguageModel |
vectorstore | VectorStore |
options | Object |
options.inputKey? | string |
options.k? | number |
options.outputKey? | string |
options.qaTemplate? | string |
options.questionGeneratorTemplate? | string |
options.returnSourceDocuments? | boolean |
Returns
Defined in
langchain/src/chains/chat_vector_db_chain.ts:156