Class BaseChain<RunInput, RunOutput>Abstract

Base interface that all chains must implement.

Type Parameters

Hierarchy

Implements

Constructors

Properties

verbose: boolean

Whether to print out response text.

callbacks?: Callbacks
memory?: BaseMemory
metadata?: Record<string, unknown>
tags?: string[]

Accessors

Methods

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

    Wraps _call and handles memory.

    Parameters

    Returns 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.

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<RunOutput, NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

    Returns RunnableSequence<RunInput, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    • input: RunInput
    • Optional options: Partial<BaseCallbackConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    Returns AsyncGenerator<RunOutput, any, unknown>

Generated using TypeDoc