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 (view full)

StructuredOutputParser<T>
- JsonMarkdownStructuredOutputParser
  - RouterOutputParser

Index

Constructors

Properties

Methods

getFormatInstructions parse toJSON fromNamesAndDescriptions fromZodSchema

Constructors

constructor

new JsonMarkdownStructuredOutputParser<T>(schema): JsonMarkdownStructuredOutputParser<T>
Type Parameters
- T extends ZodTypeAny
Parameters
- schema: T
Returns JsonMarkdownStructuredOutputParser<T>
Inherited from StructuredOutputParser.constructor
- Defined in langchain/src/output_parsers/structured.ts:39

Properties

schema

schema: T

Methods

getFormatInstructions

getFormatInstructions(options?): string
Returns a markdown code snippet with a JSON object formatted according to the schema.
Parameters
- Optionaloptions: JsonMarkdownFormatInstructionsOptions
  Optional. The options for formatting the instructions
Returns string
A markdown code snippet with a JSON object formatted according to the schema.
Overrides StructuredOutputParser.getFormatInstructions
- Defined in langchain/src/output_parsers/structured.ts:128

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.
Inherited from StructuredOutputParser.parse
- Defined in langchain/src/output_parsers/structured.ts:102

toJSON

toJSON(): any
Returns any
Inherited from StructuredOutputParser.toJSON
- Defined in langchain/src/output_parsers/structured.ts:35

`Static`fromNamesAndDescriptions

fromNamesAndDescriptions<S>(schemas): JsonMarkdownStructuredOutputParser<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 JsonMarkdownStructuredOutputParser<ZodObject<{
[k: string]: T;
}, "strip", ZodTypeAny, {}, {}>>
A new instance of StructuredOutputParser.
Overrides StructuredOutputParser.fromNamesAndDescriptions
- Defined in langchain/src/output_parsers/structured.ts:214

`Static`fromZodSchema

fromZodSchema<T>(schema): JsonMarkdownStructuredOutputParser<T>
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 JsonMarkdownStructuredOutputParser<T>
A new instance of StructuredOutputParser.
Overrides StructuredOutputParser.fromZodSchema
- Defined in langchain/src/output_parsers/structured.ts:210