Class StructuredOutputParser<T>

constructor

• new StructuredOutputParser<T>(schema): StructuredOutputParser<T>

• Type Parameters

  • T extends ZodType<any, any, any, T>

  Parameters

  • schema: T

  Returns StructuredOutputParser<T>

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): Promise<TypeOf<T>>

• Parses the given text according to the schema.

  Parameters

  • text: string

    The text to parse

  Returns Promise<TypeOf<T>>

  The parsed output.

toJSON

• toJSON(): SerializedNotImplemented

• Returns SerializedNotImplemented

Static fromNamesAndDescriptions

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

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

Static fromZodSchema

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

• Creates a new StructuredOutputParser from a Zod schema.

  Type Parameters

  • T extends ZodType<any, any, any, T>

  Parameters

  • schema: T

    The Zod schema which the output should match

  Returns StructuredOutputParser<T>

  A new instance of StructuredOutputParser.