Interface MapReduceDocumentsChainInput

Interface for the input properties of the MapReduceDocumentsChain class.

interface MapReduceDocumentsChainInput {
    combineDocumentChain: StuffDocumentsChain;
    llmChain: LLMChain<string, LLMType>;
    callbackManager?: CallbackManager;
    documentVariableName?: string;
    ensureMapStep?: boolean;
    inputKey?: string;
    maxIterations?: number;
    maxTokens?: number;
    memory?: BaseMemory;
    returnIntermediateSteps?: boolean;
}

Hierarchy (view full)

Implemented by

Properties

combineDocumentChain llmChain callbackManager? documentVariableName? ensureMapStep? inputKey? maxIterations? maxTokens? memory? returnIntermediateSteps?

Properties

combineDocumentChain

combineDocumentChain: StuffDocumentsChain

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

llmChain

llmChain: LLMChain<string, LLMType>

LLM Wrapper to use after formatting documents

Optional callbackManager

callbackManager?: CallbackManager

⚠️ Deprecated ⚠️

Use callbacks instead

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Optional documentVariableName

documentVariableName?: string

Variable name in the LLM chain to put the documents in

Optional ensureMapStep

ensureMapStep?: boolean

Ensures that the map step is taken regardless of max tokens

Optional inputKey

inputKey?: string

Optional maxIterations

maxIterations?: number

The maximum number of iterations to run through the map

Optional maxTokens

maxTokens?: number

The maximum number of tokens before requiring to do the reduction

Optional memory

memory?: BaseMemory

Optional returnIntermediateSteps

returnIntermediateSteps?: boolean

Return the results of the map steps in the output.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc