Source code for arize._generated.api_client.models.annotation_input

# coding: utf-8

"""
    Arize REST API

    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 

    The version of the OpenAPI document: 2.0.0
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""  # noqa: E501


from __future__ import annotations
import pprint
import re  # noqa: F401
import json

from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional, Union
from typing import Optional, Set
from typing_extensions import Self



class AnnotationInput(BaseModel):
    """
    An annotation value to set on a record, identified by its annotation config name. Omitting a field leaves the existing value unchanged.
    """ # noqa: E501
    name: StrictStr = Field(description="The annotation config name")
    score: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Numeric score for the annotation. Omit to leave unchanged.")
    label: Optional[StrictStr] = Field(default=None, description="Categorical label for the annotation. Omit to leave unchanged.")
    text: Optional[StrictStr] = Field(default=None, description="Free-form text note for the annotation. Omit to leave unchanged.")
    __properties: ClassVar[List[str]] = ["name", "score", "label", "text"]

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )




    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))




    def to_json(self) -> str:
        """Returns the JSON representation of the model using alias"""
        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
        return json.dumps(self.to_dict())




    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of AnnotationInput from a JSON string"""
        return cls.from_dict(json.loads(json_str))




    def to_dict(self) -> Dict[str, Any]:
        """Return the dictionary representation of the model using alias.

        This has the following differences from calling pydantic's
        `self.model_dump(by_alias=True)`:

        * `None` is only added to the output dict for nullable fields that
          were set at model initialization. Other fields with value `None`
          are ignored.
        """
        excluded_fields: Set[str] = set([
        ])

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        return _dict




    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of AnnotationInput from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        # raise errors for additional fields in the input
        for _key in obj.keys():
            if _key not in cls.__properties:
                raise ValueError("Error due to additional fields (not defined in AnnotationInput) in the input: " + _key)

        _obj = cls.model_validate({
            "name": obj.get("name"),
            "score": obj.get("score"),
            "label": obj.get("label"),
            "text": obj.get("text")
        })
        return _obj