cc_chat_completion_token_logprob.py

# coding: utf-8

"""
    otari-gateway

    A clean FastAPI gateway for otari with API key management

    The version of the OpenAPI document: 0.0.0-dev
    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, StrictFloat, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional, Union
from otari._client.models.cck_top_logprob import CCKTopLogprob
from typing import Optional, Set
from typing_extensions import Self
from pydantic_core import to_jsonable_python

class CCChatCompletionTokenLogprob(BaseModel):
    """
    CCChatCompletionTokenLogprob
    """ # noqa: E501
    token: StrictStr
    bytes: Optional[List[StrictInt]] = None
    logprob: Union[StrictFloat, StrictInt]
    top_logprobs: List[CCKTopLogprob]
    additional_properties: Dict[str, Any] = {}
    __properties: ClassVar[List[str]] = ["token", "bytes", "logprob", "top_logprobs"]

    model_config = ConfigDict(
        validate_by_name=True,
        validate_by_alias=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"""
        return json.dumps(to_jsonable_python(self.to_dict()))

    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of CCChatCompletionTokenLogprob 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.
        * Fields in `self.additional_properties` are added to the output dict.
        """
        excluded_fields: Set[str] = set([
            "additional_properties",
        ])

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        # override the default output from pydantic by calling `to_dict()` of each item in top_logprobs (list)
        _items = []
        if self.top_logprobs:
            for _item_top_logprobs in self.top_logprobs:
                if _item_top_logprobs:
                    _items.append(_item_top_logprobs.to_dict())
            _dict['top_logprobs'] = _items
        # puts key-value pairs in additional_properties in the top level
        if self.additional_properties is not None:
            for _key, _value in self.additional_properties.items():
                _dict[_key] = _value

        # set to None if bytes (nullable) is None
        # and model_fields_set contains the field
        if self.bytes is None and "bytes" in self.model_fields_set:
            _dict['bytes'] = None

        return _dict

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

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

        _obj = cls.model_validate({
            "token": obj.get("token"),
            "bytes": obj.get("bytes"),
            "logprob": obj.get("logprob"),
            "top_logprobs": [CCKTopLogprob.from_dict(_item) for _item in obj["top_logprobs"]] if obj.get("top_logprobs") is not None else None
        })
        # store additional fields in additional_properties
        for _key in obj.keys():
            if _key not in cls.__properties:
                _obj.additional_properties[_key] = obj.get(_key)

        return _obj