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

  • Type Parameters

    Parameters

    • fields: {
          bound: Runnable<RunInputItem, RunOutputItem, CallOptions>;
      }
      • bound: Runnable<RunInputItem, RunOutputItem, CallOptions>

    Returns RunnableEach<RunInputItem, RunOutputItem, CallOptions>

Properties

bound: Runnable<RunInputItem, RunOutputItem, CallOptions>
name?: string

Methods

  • Assigns new fields to the dict output of this runnable. Returns a new runnable.

    Parameters

    • mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

    Returns Runnable<any, any, RunnableConfig>

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

  • Binds the runnable with the specified arguments.

    Parameters

    • kwargs: Partial<CallOptions>

      The arguments to bind the runnable with.

    Returns RunnableEach<RunInputItem, RunOutputItem, CallOptions>

    A new instance of the RunnableEach class that is bound with the specified arguments.

  • Parameters

    • Optional suffix: string

    Returns string

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

  • Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

    Returns Runnable<RunInputItem[][], RunOutputItem[][], CallOptions>

  • Pick keys from the dict output of this runnable. Returns a new runnable.

    Parameters

    • keys: string | string[]

    Returns Runnable<any, any, RunnableConfig>

  • 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 Runnable<RunInputItem[], Exclude<NewRunOutput, Error>, RunnableConfig>

    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>

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

    Parameters

    • config: RunnableConfig

      New configuration parameters to attach to the new runnable.

    Returns RunnableBinding<RunInputItem[], RunOutputItem[], CallOptions>

    A new RunnableBinding with a config matching what's passed.

  • Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.

    Parameters

    Returns RunnableWithFallbacks<RunInputItem[], RunOutputItem[]>

    A new RunnableWithFallbacks.

  • 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<any, any, CallOptions>

  • Add retry logic to an existing runnable.

    Parameters

    Returns RunnableRetry<RunInputItem[], RunOutputItem[], CallOptions>

    A new RunnableRetry that, when invoked, will retry according to the parameters.

Generated using TypeDoc