Class StructuredOutputParser<T>

constructor

• new StructuredOutputParser<T extends InteropZodType>(
      schema: T,
  ): StructuredOutputParser<T>

  Type Parameters

  • T extends InteropZodType

  Parameters

  • schema: T

  Returns StructuredOutputParser<T>

lc_namespace

schema

getFormatInstructions

• getFormatInstructions(): string

  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.

parse

• parse(text: string): Promise<InferInteropZodOutput<T>>

  Parses the given text according to the schema.

  Parameters

  • text: string

    The text to parse

  Returns Promise<InferInteropZodOutput<T>>

  The parsed output.

toJSON

• toJSON(): any

  Returns any

StaticfromNamesAndDescriptions

• fromNamesAndDescriptions<S extends { [key: string]: string }>(
      schemas: S,
  ): StructuredOutputParser<
      ZodObject<
          { [k: string]: ZodString },
          "strip",
          ZodTypeAny,
          { [key: string]: string },
          { [key: string]: string },
      >,
  >

  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]: ZodString },
          "strip",
          ZodTypeAny,
          { [key: string]: string },
          { [key: string]: string },
      >,
  >

  A new instance of StructuredOutputParser.

StaticfromZodSchema

• fromZodSchema<T extends InteropZodType>(schema: T): StructuredOutputParser<T>

  Creates a new StructuredOutputParser from a Zod schema.

  Type Parameters

  • T extends InteropZodType

  Parameters

  • schema: T

    The Zod schema which the output should match

  Returns StructuredOutputParser<T>

  A new instance of StructuredOutputParser.

Staticlc_name

• lc_name(): string

  Returns string