API Reference — Overview

On this page

Public exports (__init__.py)
API summary table

This section documents every public class, function, and type exported by output_parser.

Public exports (`init.py`)

Python · 17 lines

from output_parser import (
    # Orchestrator
    OutputParser, ParseError,
    create_answer_parser, create_json_parser, create_tool_call_parser,
    # Schemas & types
    AnswerSchema, FieldSchema, FixStrategy, OutputFormat, ParseMode,
    ParseResult, ParseTrace, RankedAnswersSchema, RetrievalResultSchema,
    ToolCallSchema, ValidationResult, ValidationStatus,
    # Format detection
    FormatCandidate, FormatDetector,
    # Validation
    OutputValidator, ValidationRule, build_answer_validator,
    # Fault tolerance
    OutputFixer, build_answer_fixer,
    # Retry
    RetryHandler, RetryResult, RetryStrategy, graceful_fallback,
)

API summary table

API	Type	Module	Description
`OutputParser`	class	`parser.py`	Main orchestrator: detect → parse → fix → retry → validate pipeline.
`ParseError`	exception	`parser.py`	Raised in `STRICT` mode when all recovery attempts fail.
`create_answer_parser`	function	`parser.py`	Factory for a parser pre-configured for `AnswerSchema`.
`create_tool_call_parser`	function	`parser.py`	Factory for a parser pre-configured for tool/function calls.
`create_json_parser`	function	`parser.py`	Factory for a JSON-only parser with optional schema.
`OutputFormat`	enum	`schema.py`	Detected/expected output shape.
`ParseMode`	enum	`schema.py`	Strictness/fallback behavior.
`ValidationStatus`	enum	`schema.py`	Result status of a validation check.
`FixStrategy`	enum	`schema.py`	Repair strategy applied by `OutputFixer`.
`ValidationResult`	dataclass	`schema.py`	Result of one validation check.
`ParseTrace`	dataclass	`schema.py`	Full audit trail for a parse operation.
`ParseResult`	dataclass	`schema.py`	Final result returned to callers.
`FieldSchema`	dataclass	`schema.py`	Declares one expected output field.
`AnswerSchema`	Pydantic model / dataclass	`schema.py`	Standard RAG answer schema.
`ToolCallSchema`	Pydantic model / dataclass	`schema.py`	Tool/function call schema.
`RetrievalResultSchema`	Pydantic model / dataclass	`schema.py`	Single retrieved document schema.
`RankedAnswersSchema`	Pydantic model / dataclass	`schema.py`	Multiple candidate answers with scores.
`FormatDetector`	class	`format_detector.py`	Multi-signal format detection.
`FormatCandidate`	dataclass	`format_detector.py`	A detected format + confidence + evidence.
`OutputValidator`	class	`validator.py`	Four-layer output validation.
`ValidationRule`	class	`validator.py`	A named validation predicate.
`build_answer_validator`	function	`validator.py`	Pre-configured validator for `AnswerSchema`.
`OutputFixer`	class	`fixer.py`	Four-strategy repair engine.
`build_answer_fixer`	function	`fixer.py`	Pre-configured fixer for `AnswerSchema`.
`RetryHandler`	class	`retry_handler.py`	LLM re-prompt/retry engine.
`RetryResult`	dataclass	`retry_handler.py`	Outcome of a retry run.
`RetryStrategy`	enum	`retry_handler.py`	Retry escalation strategy.
`graceful_fallback`	function	`retry_handler.py`	Last-resort safe fallback payload.
`BaseOutputParser`	ABC	`base_parser.py`	Abstract interface for single-format parsers.
`ParsingError`	exception	`base_parser.py`	Raised by single-format parsers on failure.
`AutoFixingParser`	class	`base_parser.py`	Wraps a parser with retry + fixer callback.
`ChainedParser`	class	`base_parser.py`	Tries multiple parsers in order.
`JSONOutputParser`	class	`json_parser.py`	Standalone JSON parser.
`YAMLOutputParser`	class	`yaml_parser.py`	Standalone YAML parser.
`CSVOutputParser`	class	`csv_parser.py`	Standalone CSV parser.
`ListOutputParser`	class	`list_parser.py`	Standalone list parser.
`StructuredOutputParser`	class	`structured_parser.py`	Named key-value field extractor.
`ResponseSchema`	class	`structured_parser.py`	Field declaration for `StructuredOutputParser`.
`PydanticOutputParser`	class	`pydantic_parser.py`	JSON → validated Pydantic model.

Continue to OutputParser, the main entry point.

API Reference — Overview

Public exports (__init__.py)

API summary table

Related pages

Public exports (`init.py`)