Class APIChain

Optional memory

apply

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

• Call the chain on all inputs in the list

  Parameters

  • inputs: ChainValues[]

  • Optional config: (BaseCallbackConfig | Callbacks)[]

  Returns Promise<ChainValues[]>

call

• call(values, config?, tags?): 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

• invoke(input, config?): 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.

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>