Class: ConversationalRetrievalQAChain

chains.ConversationalRetrievalQAChain

Base interface that all chains must implement.

Hierarchy

• BaseChain

  ↳ ConversationalRetrievalQAChain

Implements

• ConversationalRetrievalQAChainInput

Constructors

constructor

• new ConversationalRetrievalQAChain(fields)

Parameters

Name	Type
fields	Object
fields.combineDocumentsChain	BaseChain
fields.inputKey?	string
fields.outputKey?	string
fields.questionGeneratorChain	LLMChain
fields.retriever	BaseRetriever
fields.returnSourceDocuments?	boolean

Overrides

BaseChain.constructor

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:56

Properties

callbackManager

• callbackManager: CallbackManager

Inherited from

BaseChain.callbackManager

Defined in

langchain/src/chains/base.ts:25

---

chatHistoryKey

• chatHistoryKey: string = "chat_history"

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:40

---

combineDocumentsChain

• combineDocumentsChain: BaseChain

Implementation of

ConversationalRetrievalQAChainInput.combineDocumentsChain

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:50

---

inputKey

• inputKey: string = "question"

Implementation of

ConversationalRetrievalQAChainInput.inputKey

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:38

---

memory

• Optional memory: BaseMemory

Inherited from

BaseChain.memory

Defined in

langchain/src/chains/base.ts:21

---

outputKey

• outputKey: string = "result"

Implementation of

ConversationalRetrievalQAChainInput.outputKey

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:46

---

questionGeneratorChain

• questionGeneratorChain: LLMChain

Implementation of

ConversationalRetrievalQAChainInput.questionGeneratorChain

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:52

---

retriever

• retriever: BaseRetriever

Implementation of

ConversationalRetrievalQAChainInput.retriever

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:48

---

returnSourceDocuments

• returnSourceDocuments: boolean = false

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:54

---

verbose

• verbose: boolean

Inherited from

BaseChain.verbose

Defined in

langchain/src/chains/base.ts:23

Accessors

inputKeys

• get inputKeys(): string[]

Returns

string[]

Overrides

BaseChain.inputKeys

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:42

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

BaseChain._call

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:74

---

_chainType

▸ _chainType(): string

Return the string type key uniquely identifying this class of chain.

Returns

string

Overrides

BaseChain._chainType

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:114

---

apply

▸ apply(inputs): Promise<ChainValues>

Call the chain on all inputs in the list

Parameters

Name	Type
inputs	ChainValues[]

Returns

Promise<ChainValues>

Inherited from

BaseChain.apply

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

BaseChain.call

Defined in

langchain/src/chains/base.ts:79

---

run

▸ run(input): Promise<string>

Parameters

Name	Type
input	any

Returns

Promise<string>

Inherited from

BaseChain.run

Defined in

langchain/src/chains/base.ts:55

---

serialize

▸ serialize(): SerializedChatVectorDBQAChain

Return a json-like object representing this chain.

Returns

SerializedChatVectorDBQAChain

Overrides

BaseChain.serialize

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:125

---

deserialize

▸ Static deserialize(_data, _values): Promise<ConversationalRetrievalQAChain>

Load a chain from a json-like object describing it.

Parameters

Name	Type
_data	SerializedChatVectorDBQAChain
_values	LoadValues

Returns

Promise<ConversationalRetrievalQAChain>

Overrides

BaseChain.deserialize

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:118

---

fromLLM

▸ Static fromLLM(llm, retriever, options?): ConversationalRetrievalQAChain

Parameters

Name	Type
llm	BaseLLM
retriever	BaseRetriever
options	Object
options.inputKey?	string
options.outputKey?	string
options.qaTemplate?	string
options.questionGeneratorTemplate?	string
options.returnSourceDocuments?	boolean

Returns

ConversationalRetrievalQAChain

Defined in

langchain/src/chains/conversational_retrieval_chain.ts:129