# This file was auto-generated by Fern from our API Definition.

import typing

import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
from .quality_status import QualityStatus


class QualityAnnotation(UniversalBaseModel):
    """
    Quality check result for a single mandatory parameter.
    """

    key: str = pydantic.Field()
    """
    Parameter name, e.g. 'Farbe (innen/aussen)', 'Glas'
    """

    value: typing.Optional[str] = pydantic.Field(default=None)
    """
    Value found in the source document, null if missing.
    """

    status: QualityStatus
    comment: str = pydantic.Field()
    """
    Human-readable explanation of the status.
    """

    if IS_PYDANTIC_V2:
        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
    else:

        class Config:
            frozen = True
            smart_union = True
            extra = pydantic.Extra.allow
