Class StructuredOutputParser<T>

Class to parse the output of an LLM call.

Type Parameters

  • T extends z.ZodTypeAny

Hierarchy

Constructors

Properties

schema: T

Methods

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

    Parameters

    Returns Promise<TypeOf<T>[]>

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

  • Parameters

    Returns Promise<(Error | TypeOf<T>)[]>

  • Parameters

    Returns Promise<(Error | TypeOf<T>)[]>

  • Returns a markdown code snippet with a JSON object formatted according to the schema.

    Returns string

    A markdown code snippet with a JSON object formatted according to the schema.

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

    A promise of the parsed output.

  • Parses the given text according to the schema.

    Parameters

    • text: string

      The text to parse

    Returns Promise<TypeOf<T>>

    The parsed output.

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

    A promise of the parsed output.

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

    Parameters

    Returns Promise<TypeOf<T>>

    A promise of the parsed output.

  • Parameters

    Returns Promise<TypeOf<T>>

  • 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<TypeOf<T>, 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<TypeOf<T>>>

    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<TypeOf<T>, 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, TypeOf<T>, BaseCallbackConfig>

  • Creates a new StructuredOutputParser from a set of names and descriptions.

    Type Parameters

    • S extends {
          [key: string]: string;
      }

    Parameters

    • schemas: S

      An object where each key is a name and each value is a description

    Returns StructuredOutputParser<ZodObject<{
        [k: string]: T;
    }, "strip", ZodTypeAny, {}, {}>>

    A new instance of StructuredOutputParser.

  • Creates a new StructuredOutputParser from a Zod schema.

    Type Parameters

    • T extends ZodTypeAny

    Parameters

    • schema: T

      The Zod schema which the output should match

    Returns StructuredOutputParser<T>

    A new instance of StructuredOutputParser.

Generated using TypeDoc