Class JsonMarkdownStructuredOutputParser<T>

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

Type Parameters

T extends BaseMessage

Hierarchy (View Summary)

StructuredOutputParser<T>
- JsonMarkdownStructuredOutputParser
  - RouterOutputParser

Index

Constructors

constructor

new JsonMarkdownStructuredOutputParser<T extends InteropZodType>(
schema: T,
): JsonMarkdownStructuredOutputParser<T>
Type Parameters
- T extends InteropZodType
Parameters
- schema: T
Returns JsonMarkdownStructuredOutputParser<T>
Inherited from StructuredOutputParser.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/output_parsers/structured.ts:44

Properties

lc_namespace

lc_namespace: string[] = ...

schema

schema: T

Methods

getFormatInstructions

getFormatInstructions(options?: JsonMarkdownFormatInstructionsOptions): 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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/output_parsers/structured.ts:137

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.
Inherited from StructuredOutputParser.parse
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/output_parsers/structured.ts:107

toJSON

toJSON(): any
Returns any
Inherited from StructuredOutputParser.toJSON
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/output_parsers/structured.ts:40

`Static`fromNamesAndDescriptions

fromNamesAndDescriptions<S extends { [key: string]: string }>(
    schemas: S,
): JsonMarkdownStructuredOutputParser<
    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 JsonMarkdownStructuredOutputParser<
    ZodObject<
        { [k: string]: ZodString },
        "strip",
        ZodTypeAny,
        { [key: string]: string },
        { [key: string]: string },
    >,
>
A new instance of StructuredOutputParser.
Overrides StructuredOutputParser.fromNamesAndDescriptions
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/output_parsers/structured.ts:223

`Static`fromZodSchema

fromZodSchema<T extends InteropZodType>(
schema: T,
): JsonMarkdownStructuredOutputParser<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 JsonMarkdownStructuredOutputParser<T>
A new instance of StructuredOutputParser.
Overrides StructuredOutputParser.fromZodSchema
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/output_parsers/structured.ts:219

`Static`lc_name

lc_name(): string
Returns string
Overrides StructuredOutputParser.lc_name
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/output_parsers/structured.ts:133

Class JsonMarkdownStructuredOutputParser<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns JsonMarkdownStructuredOutputParser<T>

Properties

lc_namespace

schema

Methods

getFormatInstructions

Parameters

Returns string

parse

Parameters

Returns Promise<InferInteropZodOutput<T>>

toJSON

Returns any

`Static`fromNamesAndDescriptions

Type Parameters

Parameters

Returns JsonMarkdownStructuredOutputParser<
    ZodObject<
        { [k: string]: ZodString },
        "strip",
        ZodTypeAny,
        { [key: string]: string },
        { [key: string]: string },
    >,
>

`Static`fromZodSchema

Type Parameters

Parameters

Returns JsonMarkdownStructuredOutputParser<T>

`Static`lc_name

Returns string

Settings

On This Page

Class JsonMarkdownStructuredOutputParser<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns JsonMarkdownStructuredOutputParser<T>

Properties

lc_namespace

schema

Methods

getFormatInstructions

Parameters

Returns string

parse

Parameters

Returns Promise<InferInteropZodOutput<T>>

toJSON

Returns any

StaticfromNamesAndDescriptions

Type Parameters

Parameters

Returns JsonMarkdownStructuredOutputParser< ZodObject< { [k: string]: ZodString }, "strip", ZodTypeAny, { [key: string]: string }, { [key: string]: string }, >,>

StaticfromZodSchema

Type Parameters

Parameters

Returns JsonMarkdownStructuredOutputParser<T>

Staticlc_name

Returns string

Settings

On This Page

`Static`fromNamesAndDescriptions

Returns JsonMarkdownStructuredOutputParser<
ZodObject<
{ [k: string]: ZodString },
"strip",
ZodTypeAny,
{ [key: string]: string },
{ [key: string]: string },
>,
>

`Static`fromZodSchema

`Static`lc_name