src/agentscope/model/_model_usage.py

# -*- coding: utf-8 -*-
"""The model usage class in agentscope."""
from dataclasses import dataclass, field
from typing import Any, Literal

from .._utils._mixin import DictMixin


@dataclass
class ChatUsage(DictMixin):
    """The usage of a chat model API invocation."""

    input_tokens: int
    """The number of input tokens."""

    output_tokens: int
    """The number of output tokens."""

    time: float
    """The time used in seconds."""

    cache_creation_input_tokens: int = field(default_factory=lambda: 0)
    """The number of input tokens used to create the prompt cache."""

    cache_input_tokens: int = field(default_factory=lambda: 0)
    """The number of input tokens read from the prompt cache."""

    type: Literal["chat"] = field(default_factory=lambda: "chat")
    """The type of the usage, must be `chat`."""

    metadata: dict[str, Any] | None = field(default_factory=lambda: None)
    """Optional metadata associated with the usage."""