Class RunnableEach<RunInputItem, RunOutputItem, CallOptions>

A runnable that delegates calls to another runnable with each element of the input sequence.

Type Parameters

Hierarchy

  • Runnable<RunInputItem[], RunOutputItem[], CallOptions>
    • RunnableEach

Constructors

Properties

bound: Runnable<RunInputItem, RunOutputItem, CallOptions>
lc_runnable: boolean = true

Methods

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

    Parameters

    • inputs: RunInputItem[][]

      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<RunOutputItem[][]>

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

  • Parameters

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

    Returns Promise<(Error | RunOutputItem[])[]>

  • Parameters

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

    Returns Promise<(Error | RunOutputItem[])[]>

  • Invokes the runnable with the specified input and configuration.

    Parameters

    • inputs: RunInputItem[]
    • Optional config: Partial<CallOptions>

      The configuration to invoke the runnable with.

    Returns Promise<RunOutputItem[]>

    A promise that resolves to the output of the runnable.

  • 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<RunOutputItem[], NewRunOutput>

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

    Returns RunnableSequence<RunInputItem[], Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    • input: RunInputItem[]
    • Optional options: Partial<CallOptions>

    Returns Promise<IterableReadableStream<RunOutputItem[]>>

    A readable stream that is also an iterable.

  • 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: RunInputItem[]
    • Optional options: Partial<CallOptions>
    • 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

    • generator: AsyncGenerator<RunInputItem[], any, unknown>
    • options: Partial<CallOptions>

    Returns AsyncGenerator<RunOutputItem[], any, unknown>

  • Type Parameters

    • T extends RunInputItem[]

    Parameters

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

    Returns Promise<RunOutputItem[]>

  • Parameters

    • options: Partial<CallOptions> | Partial<CallOptions>[]
    • length: number = 0

    Returns Partial<CallOptions & {
        runType?: string;
    }>[]

  • A helper method that is used to invoke the runnable with the specified input and configuration.

    Parameters

    • inputs: RunInputItem[]
    • Optional config: Partial<CallOptions>

      The configuration to invoke the runnable with.

    • Optional runManager: CallbackManagerForChainRun

    Returns Promise<RunOutputItem[]>

    A promise that resolves to the output of the runnable.

  • 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 RunInputItem[]

    • O extends RunOutputItem[]

    Parameters

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

          • generator: AsyncGenerator<I, any, unknown>
          • Optional runManager: CallbackManagerForChainRun
          • Optional options: Partial<CallOptions>

          Returns AsyncGenerator<O, any, unknown>

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

    Returns AsyncGenerator<O, any, unknown>

Generated using TypeDoc