Class: MapReduceDocumentsChain
chains.MapReduceDocumentsChain
Chain that combines documents by stuffing into context.
Hierarchy
↳
MapReduceDocumentsChain
Implements
Constructors
constructor
• new MapReduceDocumentsChain(fields)
Parameters
| Name | Type |
|---|---|
fields | Object |
fields.combineDocumentChain | BaseChain |
fields.documentVariableName? | string |
fields.ensureMapStep? | boolean |
fields.inputKey? | string |
fields.llmChain | LLMChain |
fields.maxIterations? | number |
fields.maxTokens? | number |
fields.outputKey? | string |
Overrides
Defined in
langchain/src/chains/combine_docs_chain.ts:131
Properties
callbackManager
• callbackManager: CallbackManager
Inherited from
Defined in
langchain/src/chains/base.ts:25
combineDocumentChain
• combineDocumentChain: BaseChain
Defined in
langchain/src/chains/combine_docs_chain.ts:129
documentVariableName
• documentVariableName: string = "context"
Variable name in the LLM chain to put the documents in
Implementation of
StuffDocumentsChainInput.documentVariableName
Defined in
langchain/src/chains/combine_docs_chain.ts:117
ensureMapStep
• ensureMapStep: boolean = false
Defined in
langchain/src/chains/combine_docs_chain.ts:127
inputKey
• inputKey: string = "input_documents"
Implementation of
StuffDocumentsChainInput.inputKey
Defined in
langchain/src/chains/combine_docs_chain.ts:113
llmChain
• llmChain: LLMChain
LLM Wrapper to use after formatting documents
Implementation of
StuffDocumentsChainInput.llmChain
Defined in
langchain/src/chains/combine_docs_chain.ts:111
maxIterations
• maxIterations: number = 10
Defined in
langchain/src/chains/combine_docs_chain.ts:125
maxTokens
• maxTokens: number = 3000
Defined in
langchain/src/chains/combine_docs_chain.ts:123
memory
• Optional memory: BaseMemory
Inherited from
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:115
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/combine_docs_chain.ts:119
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/combine_docs_chain.ts:153
_chainType
▸ _chainType(): "map_reduce_documents_chain"
Return the string type key uniquely identifying this class of chain.
Returns
"map_reduce_documents_chain"
Overrides
Defined in
langchain/src/chains/combine_docs_chain.ts:193
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(): SerializedMapReduceDocumentsChain
Return a json-like object representing this chain.
Returns
SerializedMapReduceDocumentsChain
Overrides
Defined in
langchain/src/chains/combine_docs_chain.ts:216
deserialize
▸ Static deserialize(data): Promise<MapReduceDocumentsChain>
Load a chain from a json-like object describing it.
Parameters
| Name | Type |
|---|---|
data | SerializedMapReduceDocumentsChain |
Returns
Promise<MapReduceDocumentsChain>
Overrides
Defined in
langchain/src/chains/combine_docs_chain.ts:197