Class JsonMarkdownStructuredOutputParser<T>

A specific type of StructuredOutputParser that parses JSON data formatted as a markdown code snippet.

Type Parameters

  • T extends z.ZodTypeAny

Hierarchy

Constructors

constructor

Properties

schema

Methods

getFormatInstructions parse toJSON fromNamesAndDescriptions fromZodSchema

Constructors

constructor

Properties

schema

schema: T

Methods

getFormatInstructions

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

    Parameters

    Returns string

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

parse

  • Parses the given text according to the schema.

    Parameters

    • text: string

      The text to parse

    Returns Promise<TypeOf<T>>

    The parsed output.

toJSON

  • Returns SerializedNotImplemented

Static fromNamesAndDescriptions

  • 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 JsonMarkdownStructuredOutputParser<ZodObject<{
        [k: string]: T;
    }, "strip", ZodTypeAny, {}, {}>>

    A new instance of StructuredOutputParser.

Static fromZodSchema

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc