Skip to content

Transform result

Base schema for transformation operations in Gen AI applications.

This module defines the foundational data structures for representing results from various transformation operations. It provides: - Base class for all transformation results - Common fields and validation rules - Type hints for result attributes

TransformResult

Bases: BaseModel

Base class for all transformation operation results.

This class provides the foundation for structured results from any transformation operation, including: - Image-to-Caption - Image-to-Mermaid

Attributes:

Name Type Description
result str | bytes

The transformed result.

tag str

The tag of the conversion result.

route str

The selected route from the router.

captions str | list[str]

The captions generated during conversion.

text_repr str | list[str] | dict[str, Any]

The text representation of the result.

metadata dict[str, Any] | BaseModel

Additional metadata generated from the transformation.