Interface MapReduceDocumentsChainInput

Interface for the input properties of the MapReduceDocumentsChain class.

interface MapReduceDocumentsChainInput {
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    combineDocumentChain: StuffDocumentsChain;
    documentVariableName?: string;
    ensureMapStep?: boolean;
    inputKey?: string;
    llmChain: LLMChain<string, LLMType>;
    maxIterations?: number;
    maxTokens?: number;
    memory?: BaseMemory;
    metadata?: Record<string, unknown>;
    returnIntermediateSteps?: boolean;
    tags?: string[];
    verbose?: boolean;
}

Hierarchy (view full)

Implemented by

Properties

callbackManager? callbacks? combineDocumentChain documentVariableName? ensureMapStep? inputKey? llmChain maxIterations? maxTokens? memory? metadata? returnIntermediateSteps? tags? verbose?

Properties

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

combineDocumentChain

combineDocumentChain: StuffDocumentsChain

Chain to use to combine results of applying llm_chain to documents.

OptionaldocumentVariableName

documentVariableName?: string

Variable name in the LLM chain to put the documents in

OptionalensureMapStep

ensureMapStep?: boolean

Ensures that the map step is taken regardless of max tokens

OptionalinputKey

inputKey?: string

llmChain

llmChain: LLMChain<string, LLMType>

LLM Wrapper to use after formatting documents

OptionalmaxIterations

maxIterations?: number

The maximum number of iterations to run through the map

OptionalmaxTokens

maxTokens?: number

The maximum number of tokens before requiring to do the reduction

Optionalmemory

memory?: BaseMemory

Optionalmetadata

metadata?: Record<string, unknown>

OptionalreturnIntermediateSteps

returnIntermediateSteps?: boolean

Return the results of the map steps in the output.

Optionaltags

tags?: string[]

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties