Class RouterRunnable<RunInput, RunnableInput, RunOutput>

A runnable that routes to a set of runnables based on Input['key']. Returns the output of the selected runnable.

Type Parameters

  • RunInput extends RouterInput

  • RunnableInput

  • RunOutput

Hierarchy

  • Runnable<RunInput, RunOutput>
    • RouterRunnable

Constructors

Properties

runnables: Record<string, Runnable<RunnableInput, RunOutput, BaseCallbackConfig>>
lc_runnable: boolean = true

Methods

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

  • Type Parameters

    • T extends RouterInput

    Parameters

    • func: ((input) => Promise<RunOutput>) | ((input, config?, runManager?) => Promise<RunOutput>)
    • input: T
    • Optional options: Partial<BaseCallbackConfig> & {
          runType?: string;
      }

    Returns Promise<RunOutput>

  • Helper method to transform an Iterator of Input values into an Iterator of Output values, with callbacks. Use this to implement stream() or transform() in Runnable subclasses.

    Type Parameters

    • I extends RouterInput

    • O

    Parameters

    • inputGenerator: AsyncGenerator<I, any, unknown>
    • transformer: ((generator, runManager?, options?) => AsyncGenerator<O, any, unknown>)
        • (generator, runManager?, options?): AsyncGenerator<O, any, unknown>
        • Parameters

          Returns AsyncGenerator<O, any, unknown>

    • Optional options: BaseCallbackConfig & {
          runType?: string;
      }

    Returns AsyncGenerator<O, any, unknown>

Generated using TypeDoc