cc_completion_usage.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, StrictInt
from typing import Any, ClassVar, Dict, List, Optional
from otari._client.models.cc_prompt_tokens_details import CCPromptTokensDetails
from otari._client.models.cck_completion_tokens_details import CCKCompletionTokensDetails
from typing import Optional, Set
from typing_extensions import Self
from pydantic_core import to_jsonable_python

class CCCompletionUsage(BaseModel):
    """
    Usage statistics for the completion request.
    """ # noqa: E501
    completion_tokens: StrictInt
    prompt_tokens: StrictInt
    total_tokens: StrictInt
    completion_tokens_details: Optional[CCKCompletionTokensDetails] = None
    prompt_tokens_details: Optional[CCPromptTokensDetails] = None
    additional_properties: Dict[str, Any] = {}
    __properties: ClassVar[List[str]] = ["completion_tokens", "prompt_tokens", "total_tokens", "completion_tokens_details", "prompt_tokens_details"]

    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 CCCompletionUsage 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 completion_tokens_details
        if self.completion_tokens_details:
            _dict['completion_tokens_details'] = self.completion_tokens_details.to_dict()
        # override the default output from pydantic by calling `to_dict()` of prompt_tokens_details
        if self.prompt_tokens_details:
            _dict['prompt_tokens_details'] = self.prompt_tokens_details.to_dict()
        # 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 completion_tokens_details (nullable) is None
        # and model_fields_set contains the field
        if self.completion_tokens_details is None and "completion_tokens_details" in self.model_fields_set:
            _dict['completion_tokens_details'] = None

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

        return _dict

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

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

        _obj = cls.model_validate({
            "completion_tokens": obj.get("completion_tokens"),
            "prompt_tokens": obj.get("prompt_tokens"),
            "total_tokens": obj.get("total_tokens"),
            "completion_tokens_details": CCKCompletionTokensDetails.from_dict(obj["completion_tokens_details"]) if obj.get("completion_tokens_details") is not None else None,
            "prompt_tokens_details": CCPromptTokensDetails.from_dict(obj["prompt_tokens_details"]) if obj.get("prompt_tokens_details") 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