GitHub

StructuredOutputError

API reference for StructuredOutputError.

The model's structured output did not decode with the schema.

Attributes

AttributeTypeDescription
descriptionstr
response_textstr
metadataProviderMetadata = field(default_factory=(dict[str, JsonValue]))
usageUsageInfo | None = None
is_retryablebool
messagestr

Functions

__init__

__init__(description, response_text, metadata=dict[str, JsonValue](), usage=None) -> None
ParameterTypeDescription
descriptionstr
response_textstr
metadataProviderMetadata = dict[str, JsonValue]()
usageUsageInfo | None = None

from_schema_error

from_schema_error(error, response_text) -> StructuredOutputError
ParameterTypeDescription
errorS.SchemaError
response_textstr

Returns StructuredOutputError

@staticmethod
def from_schema_error(error: S.SchemaError, response_text: str) -> StructuredOutputError:
    return StructuredOutputError(description=error.message, response_text=response_text)