Class: StuffDocumentsChain

chains.StuffDocumentsChain

Chain that combines documents by stuffing into context.

Hierarchy

• BaseChain

  ↳ StuffDocumentsChain

Implements

• StuffDocumentsChainInput

Constructors

constructor

• new StuffDocumentsChain(fields)

Parameters

Name	Type
fields	Object
fields.documentVariableName?	string
fields.inputKey?	string
fields.llmChain	LLMChain
fields.outputKey?	string

Overrides

BaseChain.constructor

Defined in

langchain/src/chains/combine_docs_chain.ts:42

Properties

callbackManager

• callbackManager: CallbackManager

Inherited from

BaseChain.callbackManager

Defined in

langchain/src/chains/base.ts:25

---

documentVariableName

• documentVariableName: string = "context"

Implementation of

StuffDocumentsChainInput.documentVariableName

Defined in

langchain/src/chains/combine_docs_chain.ts:36

---

inputKey

• inputKey: string = "input_documents"

Implementation of

StuffDocumentsChainInput.inputKey

Defined in

langchain/src/chains/combine_docs_chain.ts:32

---

llmChain

• llmChain: LLMChain

Implementation of

StuffDocumentsChainInput.llmChain

Defined in

langchain/src/chains/combine_docs_chain.ts:30

---

memory

• Optional memory: BaseMemory

Inherited from

BaseChain.memory

Defined in

langchain/src/chains/base.ts:21

---

outputKey

• outputKey: string = "output_text"

Implementation of

StuffDocumentsChainInput.outputKey

Defined in

langchain/src/chains/combine_docs_chain.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/combine_docs_chain.ts:38

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/combine_docs_chain.ts:56

---

_chainType

▸ _chainType(): "stuff_documents_chain"

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

Returns

"stuff_documents_chain"

Overrides

BaseChain._chainType

Defined in

langchain/src/chains/combine_docs_chain.ts:70

---

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

Return a json-like object representing this chain.

Returns

SerializedStuffDocumentsChain

Overrides

BaseChain.serialize

Defined in

langchain/src/chains/combine_docs_chain.ts:84

---

deserialize

▸ Static deserialize(data): Promise<StuffDocumentsChain>

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

Parameters

Name	Type
data	SerializedStuffDocumentsChain

Returns

Promise<StuffDocumentsChain>

Overrides

BaseChain.deserialize

Defined in

langchain/src/chains/combine_docs_chain.ts:74