Class StuffDocumentsChain

Optionalmemory

apply

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

• Parameters

  • inputs: ChainValues[]
  • Optionalconfig: any[]

  Returns Promise<ChainValues[]>

  Deprecated

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

  Call the chain on all inputs in the list

call

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

• Parameters

  • values: any
  • Optionalconfig: any
  • Optionaltags: 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.
  • Optionaloptions: any

  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
  • Optionalconfig: any

  Returns Promise<string>

  Deprecated

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