Class BaseChain<RunInput, RunOutput>Abstract

constructor

• new BaseChain<RunInput, RunOutput>(fields?, verbose?, callbacks?): BaseChain<RunInput, RunOutput>

• Type Parameters

  • RunInput extends ChainValues = ChainValues
  • RunOutput extends ChainValues = ChainValues

  Parameters

  • Optionalfields: any
  • Optionalverbose: boolean

    Deprecated

  • Optionalcallbacks: any

    Deprecated

  Returns BaseChain<RunInput, RunOutput>

Optionalmemory

AbstractinputKeys

• get inputKeys(): string[]

• Returns string[]

AbstractoutputKeys

• get outputKeys(): string[]

• Returns string[]

apply

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

• Parameters

  • inputs: RunInput[]
  • Optionalconfig: any[]

  Returns Promise<RunOutput[]>

  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<RunOutput>

• Parameters

  • values: any
  • Optionalconfig: any
  • Optionaltags: string[]

    Deprecated

  Returns Promise<RunOutput>

  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<RunOutput>

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

  Parameters

  • input: RunInput

    Input values for the chain run.
  • Optionaloptions: any

  Returns Promise<RunOutput>

  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.

serialize

• serialize(): SerializedBaseChain

• Return a json-like object representing this chain.

  Returns SerializedBaseChain

Staticdeserialize

• deserialize(data, values?): Promise<BaseChain<ChainValues, ChainValues>>

• Load a chain from a json-like object describing it.

  Parameters

  • data: SerializedBaseChain
  • values: LoadValues = {}

  Returns Promise<BaseChain<ChainValues, ChainValues>>