Class Runnable<RunInput, RunOutput, CallOptions>Abstract

A Runnable is a generic unit of work that can be invoked, batched, streamed, and/or transformed.

Type Parameters

Hierarchy

Implements

Constructors

Properties

name?: string

Methods

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    • inputs: RunInput[]

      Array of inputs to each batch call.

    • Optional options: Partial<CallOptions> | Partial<CallOptions>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<RunOutput[]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    • inputs: RunInput[]
    • Optional options: Partial<CallOptions> | Partial<CallOptions>[]
    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions: true;
      }

    Returns Promise<(Error | RunOutput)[]>

  • Parameters

    • inputs: RunInput[]
    • Optional options: Partial<CallOptions> | Partial<CallOptions>[]
    • Optional batchOptions: RunnableBatchOptions

    Returns Promise<(Error | RunOutput)[]>

  • Bind arguments to a Runnable, returning a new Runnable.

    Parameters

    • kwargs: Partial<CallOptions>

    Returns Runnable<RunInput, RunOutput, CallOptions>

    A new RunnableBinding that, when invoked, will apply the bound args.

  • 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 Runnable<RunInput, Exclude<NewRunOutput, Error>, RunnableConfig>

    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

    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

    • generator: AsyncGenerator<RunInput, any, unknown>
    • options: Partial<CallOptions>

    Returns AsyncGenerator<RunOutput, any, unknown>

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

    Returns Runnable<RunInput, RunOutput, CallOptions>

Generated using TypeDoc