Class MapReduceDocumentsChain

Combine documents by mapping a chain over them, then combining results.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

combineDocumentChain documentVariableName ensureMapStep inputKey llmChain maxIterations maxTokens returnIntermediateSteps memory?

Accessors

inputKeys outputKeys

Methods

apply call invoke prepOutputs run serialize deserialize

Constructors

constructor

Properties

combineDocumentChain

combineDocumentChain: StuffDocumentsChain

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

documentVariableName

documentVariableName: string = "context"

Variable name in the LLM chain to put the documents in

ensureMapStep

ensureMapStep: boolean = false

Ensures that the map step is taken regardless of max tokens

inputKey

inputKey: string = "input_documents"

llmChain

llmChain: LLMChain<string, LLMType>

LLM Wrapper to use after formatting documents

maxIterations

maxIterations: number = 10

The maximum number of iterations to run through the map

maxTokens

maxTokens: number = 3000

The maximum number of tokens before requiring to do the reduction

returnIntermediateSteps

returnIntermediateSteps: boolean = false

Return the results of the map steps in the output.

Optional memory

memory?: BaseMemory

Accessors

inputKeys

outputKeys

Methods

apply

  • apply(inputs, config?): Promise<ChainValues[]>

  • Parameters

    • inputs: ChainValues[]
    • Optional config: (RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[])[]

    Returns Promise<ChainValues[]>

    ⚠️ Deprecated ⚠️

    Use .batch() instead. Will be removed in 0.2.0.

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

    It is not recommended for use.

    Call the chain on all inputs in the list

call

  • call(values, config?, tags?): Promise<ChainValues>

  • Parameters

    • values: ChainValues & {
          signal?: AbortSignal;
          timeout?: number;
      }
    • Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]
    • Optional tags: string[]

      Deprecated

    Returns Promise<ChainValues>

    Deprecated

    Use .invoke() instead. Will be removed in 0.2.0.

    Run the core logic of this chain and add to output if desired.

    Wraps _call and handles memory.

invoke

  • invoke(input, options?): Promise<ChainValues>

  • Invoke the chain with the provided input and returns the output.

    Parameters

    • input: ChainValues

      Input values for the chain run.

    • Optional options: RunnableConfig

    Returns Promise<ChainValues>

    Promise that resolves with the output of the chain run.

prepOutputs

  • prepOutputs(inputs, outputs, returnOnlyOutputs?): Promise<Record<string, unknown>>

  • Parameters

    • inputs: Record<string, unknown>
    • outputs: Record<string, unknown>
    • returnOnlyOutputs: boolean = false

    Returns Promise<Record<string, unknown>>

run

  • run(input, config?): Promise<string>

  • Parameters

    • input: any
    • Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

    Returns Promise<string>

    Deprecated

    Use .invoke() instead. Will be removed in 0.2.0.

serialize

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc