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

  • Optional fields: ChainInputs | BaseMemory

  • Optional verbose: boolean

    Deprecated

  • Optional callbacks: Callbacks

    Deprecated

  Returns BaseChain<RunInput, RunOutput>

Optional memory

Abstract inputKeys

• get inputKeys(): string[]

• Returns string[]

Abstract outputKeys

• get outputKeys(): string[]

• Returns string[]

apply

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

• Call the chain on all inputs in the list

  Parameters

  • inputs: RunInput[]

  • Optional config: (BaseCallbackConfig | Callbacks)[]

  Returns Promise<RunOutput[]>

call

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

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

invoke

• invoke(input, config?): Promise<RunOutput>

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

  Parameters

  • input: RunInput

    Input values for the chain run.

  • Optional config: BaseCallbackConfig

    Optional configuration for the Runnable.

  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

  • Optional config: BaseCallbackConfig | Callbacks

  Returns Promise<string>

serialize

• serialize(): SerializedBaseChain

• Return a json-like object representing this chain.

  Returns SerializedBaseChain

Static deserialize

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