Class MapReduceDocumentsChain

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

Hierarchy

Implements

Constructors

Properties

combineDocumentChain: StuffDocumentsChain

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

documentVariableName: string = "context"

Variable name in the LLM chain to put the documents in

ensureMapStep: boolean = false

Ensures that the map step is taken regardless of max tokens

inputKey: string = "input_documents"
llmChain: LLMChain<string, LLMType>

LLM Wrapper to use after formatting documents

maxIterations: number = 10

The maximum number of iterations to run through the map

maxTokens: number = 3000

The maximum number of tokens before requiring to do the reduction

returnIntermediateSteps: boolean = false

Return the results of the map steps in the output.

memory?: BaseMemory

Accessors

  • get inputKeys(): string[]
  • Returns string[]

  • get outputKeys(): string[]
  • Returns string[]

Methods

  • Call the chain on all inputs in the list

    Parameters

    • inputs: ChainValues[]
    • Optional config: (BaseCallbackConfig | Callbacks)[]

    Returns Promise<ChainValues[]>

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

    Wraps _call and handles memory.

    Parameters

    • values: ChainValues & {
          signal?: AbortSignal;
          timeout?: number;
      }
    • Optional config: BaseCallbackConfig | Callbacks
    • Optional tags: string[]

      Deprecated

    Returns Promise<ChainValues>

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

    Parameters

    • input: ChainValues

      Input values for the chain run.

    • Optional config: BaseCallbackConfig

      Optional configuration for the Runnable.

    Returns Promise<ChainValues>

    Promise that resolves with the output of the chain run.

  • Parameters

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

    Returns Promise<Record<string, unknown>>

  • Parameters

    • input: any
    • Optional config: BaseCallbackConfig | Callbacks

    Returns Promise<string>

Generated using TypeDoc