Class to parse the output of an LLM call to a list with a specific length and separator.

Hierarchy

Constructors

Methods

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

    Parameters

    Returns Promise<string[][]>

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

  • Parameters

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

  • Parameters

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

  • Provides instructions on the expected format of the response for the CustomListOutputParser, including the number of items and the separator.

    Returns string

    A string containing instructions on the expected format of the response.

  • Calls the parser with a given input and optional configuration options. If the input is a string, it creates a generation with the input as text and calls parseResult. If the input is a BaseMessage, it creates a generation with the input as a message and the content of the input as text, and then calls parseResult.

    Parameters

    • input: string | BaseMessage

      The input to the parser, which can be a string or a BaseMessage.

    • Optional options: BaseCallbackConfig

      Optional configuration options.

    Returns Promise<string[]>

    A promise of the parsed output.

  • Parses the given text into an array of strings, using the specified separator. If the parsing fails or the number of items in the list doesn't match the expected length, throws an OutputParserException.

    Parameters

    • text: string

      The text to parse.

    Returns Promise<string[]>

    An array of strings obtained by splitting the input text at each occurrence of the specified separator.

  • Parses the result of an LLM call. This method is meant to be implemented by subclasses to define how the output from the LLM should be parsed.

    Parameters

    Returns Promise<string[]>

    A promise of the parsed output.

  • Parses the result of an LLM call with a given prompt. By default, it simply calls parseResult.

    Parameters

    • generations: Generation[] | ChatGeneration[]

      The generations from an LLM call.

    • _prompt: BasePromptValueInterface

      The prompt used in the LLM call.

    • Optional callbacks: Callbacks

      Optional callbacks.

    Returns Promise<string[]>

    A promise of the parsed output.

  • Parameters

    • text: string
    • _prompt: BasePromptValueInterface
    • Optional callbacks: Callbacks

    Returns Promise<string[]>

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

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

    Returns RunnableSequence<string | BaseMessage, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<string[]>>

    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: string | BaseMessage
    • 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<string[], 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<string | BaseMessage, string[], BaseCallbackConfig>

Generated using TypeDoc