Class: RetrievalQAChain

chains.RetrievalQAChain

Base interface that all chains must implement.

Hierarchy

• BaseChain

  ↳ RetrievalQAChain

Implements

• RetrievalQAChainInput

Constructors

constructor

• new RetrievalQAChain(fields)

Parameters

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

Overrides

BaseChain.constructor

Defined in

langchain/src/chains/retrieval_qa.ts:36

Properties

callbackManager

• callbackManager: CallbackManager

Inherited from

BaseChain.callbackManager

Defined in

langchain/src/chains/base.ts:25

---

combineDocumentsChain

• combineDocumentsChain: BaseChain

Implementation of

RetrievalQAChainInput.combineDocumentsChain

Defined in

langchain/src/chains/retrieval_qa.ts:32

---

inputKey

• inputKey: string = "query"

Implementation of

RetrievalQAChainInput.inputKey

Defined in

langchain/src/chains/retrieval_qa.ts:22

---

memory

• Optional memory: BaseMemory

Inherited from

BaseChain.memory

Defined in

langchain/src/chains/base.ts:21

---

outputKey

• outputKey: string = "result"

Implementation of

RetrievalQAChainInput.outputKey

Defined in

langchain/src/chains/retrieval_qa.ts:28

---

retriever

• retriever: BaseRetriever

Implementation of

RetrievalQAChainInput.retriever

Defined in

langchain/src/chains/retrieval_qa.ts:30

---

returnSourceDocuments

• returnSourceDocuments: boolean = false

Implementation of

RetrievalQAChainInput.returnSourceDocuments

Defined in

langchain/src/chains/retrieval_qa.ts:34

---

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/retrieval_qa.ts:24

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/retrieval_qa.ts:52

---

_chainType

▸ _chainType(): "retrieval_qa"

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

Returns

"retrieval_qa"

Overrides

BaseChain._chainType

Defined in

langchain/src/chains/retrieval_qa.ts:69

---

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(): SerializedVectorDBQAChain

Return a json-like object representing this chain.

Returns

SerializedVectorDBQAChain

Overrides

BaseChain.serialize

Defined in

langchain/src/chains/retrieval_qa.ts:80

---

deserialize

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

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

Parameters

Name	Type
_data	SerializedVectorDBQAChain
_values	LoadValues

Returns

Promise<RetrievalQAChain>

Overrides

BaseChain.deserialize

Defined in

langchain/src/chains/retrieval_qa.ts:73

---

fromLLM

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

Parameters

Name	Type
llm	BaseLLM
retriever	BaseRetriever
options?	Partial<Omit<RetrievalQAChainInput, "index" | "combineDocumentsChain">>

Returns

RetrievalQAChain

Defined in

langchain/src/chains/retrieval_qa.ts:84