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

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

from __future__ import annotations
from .apierrortype import APIErrorType
from .chatstreamchoice import ChatStreamChoice, ChatStreamChoiceTypedDict
from .chatusage import ChatUsage, ChatUsageTypedDict
from .openroutermetadata import OpenRouterMetadata, OpenRouterMetadataTypedDict
from openrouter.types import (
    BaseModel,
    Nullable,
    OptionalNullable,
    UNSET,
    UNSET_SENTINEL,
)
from openrouter.utils import validate_open_enum
from pydantic import model_serializer
from pydantic.functional_validators import PlainValidator
from typing import List, Literal, Optional
from typing_extensions import Annotated, NotRequired, TypedDict


class ChatStreamChunkMetadataTypedDict(TypedDict):
    r"""Structured error metadata"""

    error_type: APIErrorType
    r"""Canonical OpenRouter error type, stable across all API formats"""
    provider_code: NotRequired[str]
    r"""Upstream provider-specific error code, when available"""


class ChatStreamChunkMetadata(BaseModel):
    r"""Structured error metadata"""

    error_type: Annotated[APIErrorType, PlainValidator(validate_open_enum(False))]
    r"""Canonical OpenRouter error type, stable across all API formats"""

    provider_code: Optional[str] = None
    r"""Upstream provider-specific error code, when available"""


class ChatStreamChunkErrorTypedDict(TypedDict):
    r"""Error information"""

    code: int
    r"""Error code"""
    message: str
    r"""Error message"""
    metadata: NotRequired[ChatStreamChunkMetadataTypedDict]
    r"""Structured error metadata"""


class ChatStreamChunkError(BaseModel):
    r"""Error information"""

    code: int
    r"""Error code"""

    message: str
    r"""Error message"""

    metadata: Optional[ChatStreamChunkMetadata] = None
    r"""Structured error metadata"""


ChatStreamChunkObject = Literal["chat.completion.chunk",]


class ChatStreamChunkTypedDict(TypedDict):
    r"""Streaming chat completion chunk"""

    choices: List[ChatStreamChoiceTypedDict]
    r"""List of streaming chunk choices"""
    created: int
    r"""Unix timestamp of creation"""
    id: str
    r"""Unique chunk identifier"""
    model: str
    r"""Model used for completion"""
    object: ChatStreamChunkObject
    error: NotRequired[ChatStreamChunkErrorTypedDict]
    r"""Error information"""
    openrouter_metadata: NotRequired[OpenRouterMetadataTypedDict]
    service_tier: NotRequired[Nullable[str]]
    r"""The service tier used by the upstream provider for this request"""
    system_fingerprint: NotRequired[str]
    r"""System fingerprint"""
    usage: NotRequired[ChatUsageTypedDict]
    r"""Token usage statistics"""


class ChatStreamChunk(BaseModel):
    r"""Streaming chat completion chunk"""

    choices: List[ChatStreamChoice]
    r"""List of streaming chunk choices"""

    created: int
    r"""Unix timestamp of creation"""

    id: str
    r"""Unique chunk identifier"""

    model: str
    r"""Model used for completion"""

    object: ChatStreamChunkObject

    error: Optional[ChatStreamChunkError] = None
    r"""Error information"""

    openrouter_metadata: Optional[OpenRouterMetadata] = None

    service_tier: OptionalNullable[str] = UNSET
    r"""The service tier used by the upstream provider for this request"""

    system_fingerprint: Optional[str] = None
    r"""System fingerprint"""

    usage: Optional[ChatUsage] = None
    r"""Token usage statistics"""

    @model_serializer(mode="wrap")
    def serialize_model(self, handler):
        optional_fields = [
            "error",
            "openrouter_metadata",
            "service_tier",
            "system_fingerprint",
            "usage",
        ]
        nullable_fields = ["service_tier"]
        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