Package com.tnsai.parser

Class FormatAwareOutputParser<T>

java.lang.Object

com.tnsai.parser.FormatAwareOutputParser<T>

Type Parameters:

T - the target type

All Implemented Interfaces:

OutputParser<T>

public class FormatAwareOutputParser<T>
extends Object
implements OutputParser<T>

Output parser that supports multiple formats (JSON, YAML, TOON, TONL). Delegates to appropriate serializer based on configured format.

Usage:

 // For JSON output (default)
 OutputParser<User> parser = FormatAwareOutputParser.json(User.class);

 // For YAML output
 OutputParser<Spec> parser = FormatAwareOutputParser.yaml(Spec.class);

 // For token-optimized TOON format
 OutputParser<Report> parser = FormatAwareOutputParser.toon(Report.class);

 // Use with agent
 User user = agent.chatWithStructure("Get user info", parser, 3);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormatAwareOutputParser.Builder<T>	Builder for FormatAwareOutputParser with fluent API.

Constructor Summary

Constructors

Constructor	Description
FormatAwareOutputParser(Class<T> targetType, OutputFormat format)	Creates a parser for single object output.
FormatAwareOutputParser(Class<T> targetType, OutputFormat format, boolean isListOutput)	Creates a parser with list output option.

Method Summary

Modifier and Type	Method	Description
static <T> FormatAwareOutputParser.Builder<T>	builder(Class<T> targetType)	Creates a builder for more complex parser configurations.
static <T> FormatAwareOutputParser<T>	forFormat(Class<T> targetType, OutputFormat format)
OutputFormat	getFormat()	Gets the output format this parser uses.
String	getFormatInstruction()	Returns a format instruction string to include in the LLM prompt.
String	getSchemaDescription()	Returns a schema description of the expected output format.
Class<T>	getTargetType()	Returns the target class this parser produces.
static <T> FormatAwareOutputParser<T>	json(Class<T> targetType)
ParseResult<T>	parse(String output)	Parses the raw LLM output into the target type.
static <T> FormatAwareOutputParser<T>	text(Class<T> targetType)
static <T> FormatAwareOutputParser<T>	tonl(Class<T> targetType)
static <T> FormatAwareOutputParser<T>	toon(Class<T> targetType)
static <T> FormatAwareOutputParser<T>	yaml(Class<T> targetType)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tnsai.parser.OutputParser

getErrorCorrectionPrompt, parseOptional, parseOrThrow

Constructor Details

FormatAwareOutputParser

public FormatAwareOutputParser(Class<T> targetType,
 OutputFormat format)

Creates a parser for single object output.

FormatAwareOutputParser

public FormatAwareOutputParser(Class<T> targetType,
 OutputFormat format,
 boolean isListOutput)

Creates a parser with list output option.

Method Details

json

public static <T> FormatAwareOutputParser<T> json(Class<T> targetType)

yaml

public static <T> FormatAwareOutputParser<T> yaml(Class<T> targetType)

toon

public static <T> FormatAwareOutputParser<T> toon(Class<T> targetType)

tonl

public static <T> FormatAwareOutputParser<T> tonl(Class<T> targetType)

text

public static <T> FormatAwareOutputParser<T> text(Class<T> targetType)

forFormat

public static <T> FormatAwareOutputParser<T> forFormat(Class<T> targetType,
 OutputFormat format)

parse

public ParseResult<T> parse(String output)

Description copied from interface: OutputParser

Parses the raw LLM output into the target type.

Specified by:

parse in interface OutputParser<T>

Parameters:

output - the raw string output from the LLM

Returns:

parse result containing either the parsed object or error details

getTargetType

public Class<T> getTargetType()

Description copied from interface: OutputParser

Returns the target class this parser produces.

Specified by:

getTargetType in interface OutputParser<T>

Returns:

the target class

getFormatInstruction

public String getFormatInstruction()

Description copied from interface: OutputParser

Returns a format instruction string to include in the LLM prompt.

This helps guide the LLM to produce output in the expected format.

Specified by:

getFormatInstruction in interface OutputParser<T>

Returns:

format instruction for the prompt

getSchemaDescription

public String getSchemaDescription()

Description copied from interface: OutputParser

Returns a schema description of the expected output format.

Specified by:

getSchemaDescription in interface OutputParser<T>

Returns:

schema description (e.g., JSON Schema, example)

getFormat

public OutputFormat getFormat()

Gets the output format this parser uses.

builder

public static <T>
FormatAwareOutputParser.Builder<T> builder(Class<T> targetType)

Creates a builder for more complex parser configurations.