openrouter-python-sdk-retry-errors/src/openrouter/components/chatusage.py

"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""

from __future__ import annotations
from .costdetails import CostDetails, CostDetailsTypedDict
from openrouter.types import (
    BaseModel,
    Nullable,
    OptionalNullable,
    UNSET,
    UNSET_SENTINEL,
)
from pydantic import model_serializer
from typing import Optional
from typing_extensions import NotRequired, TypedDict


class CompletionTokensDetailsTypedDict(TypedDict):
    r"""Detailed completion token usage"""

    accepted_prediction_tokens: NotRequired[Nullable[int]]
    r"""Accepted prediction tokens"""
    audio_tokens: NotRequired[Nullable[int]]
    r"""Tokens used for audio output"""
    reasoning_tokens: NotRequired[Nullable[int]]
    r"""Tokens used for reasoning"""
    rejected_prediction_tokens: NotRequired[Nullable[int]]
    r"""Rejected prediction tokens"""


class CompletionTokensDetails(BaseModel):
    r"""Detailed completion token usage"""

    accepted_prediction_tokens: OptionalNullable[int] = UNSET
    r"""Accepted prediction tokens"""

    audio_tokens: OptionalNullable[int] = UNSET
    r"""Tokens used for audio output"""

    reasoning_tokens: OptionalNullable[int] = UNSET
    r"""Tokens used for reasoning"""

    rejected_prediction_tokens: OptionalNullable[int] = UNSET
    r"""Rejected prediction tokens"""

    @model_serializer(mode="wrap")
    def serialize_model(self, handler):
        optional_fields = [
            "accepted_prediction_tokens",
            "audio_tokens",
            "reasoning_tokens",
            "rejected_prediction_tokens",
        ]
        nullable_fields = [
            "accepted_prediction_tokens",
            "audio_tokens",
            "reasoning_tokens",
            "rejected_prediction_tokens",
        ]
        null_default_fields = []

        serialized = handler(self)

        m = {}

        for n, f in type(self).model_fields.items():
            k = f.alias or n
            val = serialized.get(k)
            serialized.pop(k, None)

            optional_nullable = k in optional_fields and k in nullable_fields
            is_set = (
                self.__pydantic_fields_set__.intersection({n})
                or k in null_default_fields
            )  # pylint: disable=no-member

            if val is not None and val != UNSET_SENTINEL:
                m[k] = val
            elif val != UNSET_SENTINEL and (
                not k in optional_fields or (optional_nullable and is_set)
            ):
                m[k] = val

        return m


class PromptTokensDetailsTypedDict(TypedDict):
    r"""Detailed prompt token usage"""

    audio_tokens: NotRequired[int]
    r"""Audio input tokens"""
    cache_write_tokens: NotRequired[int]
    r"""Tokens written to cache. Only returned for models with explicit caching and cache write pricing."""
    cached_tokens: NotRequired[int]
    r"""Cached prompt tokens"""
    video_tokens: NotRequired[int]
    r"""Video input tokens"""


class PromptTokensDetails(BaseModel):
    r"""Detailed prompt token usage"""

    audio_tokens: Optional[int] = None
    r"""Audio input tokens"""

    cache_write_tokens: Optional[int] = None
    r"""Tokens written to cache. Only returned for models with explicit caching and cache write pricing."""

    cached_tokens: Optional[int] = None
    r"""Cached prompt tokens"""

    video_tokens: Optional[int] = None
    r"""Video input tokens"""


class ChatUsageTypedDict(TypedDict):
    r"""Token usage statistics"""

    completion_tokens: int
    r"""Number of tokens in the completion"""
    prompt_tokens: int
    r"""Number of tokens in the prompt"""
    total_tokens: int
    r"""Total number of tokens"""
    completion_tokens_details: NotRequired[Nullable[CompletionTokensDetailsTypedDict]]
    r"""Detailed completion token usage"""
    cost: NotRequired[Nullable[float]]
    r"""Cost of the completion"""
    cost_details: NotRequired[Nullable[CostDetailsTypedDict]]
    r"""Breakdown of upstream inference costs"""
    is_byok: NotRequired[bool]
    r"""Whether a request was made using a Bring Your Own Key configuration"""
    prompt_tokens_details: NotRequired[Nullable[PromptTokensDetailsTypedDict]]
    r"""Detailed prompt token usage"""


class ChatUsage(BaseModel):
    r"""Token usage statistics"""

    completion_tokens: int
    r"""Number of tokens in the completion"""

    prompt_tokens: int
    r"""Number of tokens in the prompt"""

    total_tokens: int
    r"""Total number of tokens"""

    completion_tokens_details: OptionalNullable[CompletionTokensDetails] = UNSET
    r"""Detailed completion token usage"""

    cost: OptionalNullable[float] = UNSET
    r"""Cost of the completion"""

    cost_details: OptionalNullable[CostDetails] = UNSET
    r"""Breakdown of upstream inference costs"""

    is_byok: Optional[bool] = None
    r"""Whether a request was made using a Bring Your Own Key configuration"""

    prompt_tokens_details: OptionalNullable[PromptTokensDetails] = UNSET
    r"""Detailed prompt token usage"""

    @model_serializer(mode="wrap")
    def serialize_model(self, handler):
        optional_fields = [
            "completion_tokens_details",
            "cost",
            "cost_details",
            "is_byok",
            "prompt_tokens_details",
        ]
        nullable_fields = [
            "completion_tokens_details",
            "cost",
            "cost_details",
            "prompt_tokens_details",
        ]
        null_default_fields = []

        serialized = handler(self)

        m = {}

        for n, f in type(self).model_fields.items():
            k = f.alias or n
            val = serialized.get(k)
            serialized.pop(k, None)

            optional_nullable = k in optional_fields and k in nullable_fields
            is_set = (
                self.__pydantic_fields_set__.intersection({n})
                or k in null_default_fields
            )  # pylint: disable=no-member

            if val is not None and val != UNSET_SENTINEL:
                m[k] = val
            elif val != UNSET_SENTINEL and (
                not k in optional_fields or (optional_nullable and is_set)
            ):
                m[k] = val

        return m