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

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

from __future__ import annotations
from openrouter.types import (
    BaseModel,
    Nullable,
    OptionalNullable,
    UNSET,
    UNSET_SENTINEL,
    UnrecognizedStr,
)
import pydantic
from pydantic import model_serializer
from typing import Any, Dict, Literal, Union
from typing_extensions import Annotated, NotRequired, TypedDict


MessagesOutputConfigEffort = Union[
    Literal[
        "low",
        "medium",
        "high",
        "xhigh",
        "max",
    ],
    UnrecognizedStr,
]
r"""How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`."""


MessagesOutputConfigTypeJSONSchema = Literal["json_schema",]


class MessagesOutputConfigFormatTypedDict(TypedDict):
    r"""A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)."""

    schema_: Dict[str, Nullable[Any]]
    type: MessagesOutputConfigTypeJSONSchema


class MessagesOutputConfigFormat(BaseModel):
    r"""A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)."""

    schema_: Annotated[Dict[str, Nullable[Any]], pydantic.Field(alias="schema")]

    type: MessagesOutputConfigTypeJSONSchema


TypeTokens = Literal["tokens",]


class TaskBudgetTypedDict(TypedDict):
    r"""Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap."""

    total: int
    type: TypeTokens
    remaining: NotRequired[Nullable[int]]


class TaskBudget(BaseModel):
    r"""Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap."""

    total: int

    type: TypeTokens

    remaining: OptionalNullable[int] = UNSET

    @model_serializer(mode="wrap")
    def serialize_model(self, handler):
        optional_fields = set(["remaining"])
        nullable_fields = set(["remaining"])
        serialized = handler(self)
        m = {}

        for n, f in type(self).model_fields.items():
            k = f.alias or n
            val = serialized.get(k, serialized.get(n))
            is_nullable_and_explicitly_set = (
                k in nullable_fields
                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
            )

            if val != UNSET_SENTINEL:
                if (
                    val is not None
                    or k not in optional_fields
                    or is_nullable_and_explicitly_set
                ):
                    m[k] = val

        return m


class MessagesOutputConfigTypedDict(TypedDict):
    r"""Configuration for controlling output behavior. Supports the effort parameter and structured output format."""

    effort: NotRequired[Nullable[MessagesOutputConfigEffort]]
    r"""How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`."""
    format_: NotRequired[Nullable[MessagesOutputConfigFormatTypedDict]]
    r"""A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)."""
    task_budget: NotRequired[Nullable[TaskBudgetTypedDict]]
    r"""Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap."""


class MessagesOutputConfig(BaseModel):
    r"""Configuration for controlling output behavior. Supports the effort parameter and structured output format."""

    effort: OptionalNullable[MessagesOutputConfigEffort] = UNSET
    r"""How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`."""

    format_: Annotated[
        OptionalNullable[MessagesOutputConfigFormat], pydantic.Field(alias="format")
    ] = UNSET
    r"""A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)."""

    task_budget: OptionalNullable[TaskBudget] = UNSET
    r"""Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap."""

    @model_serializer(mode="wrap")
    def serialize_model(self, handler):
        optional_fields = set(["effort", "format", "task_budget"])
        nullable_fields = set(["effort", "format", "task_budget"])
        serialized = handler(self)
        m = {}

        for n, f in type(self).model_fields.items():
            k = f.alias or n
            val = serialized.get(k, serialized.get(n))
            is_nullable_and_explicitly_set = (
                k in nullable_fields
                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
            )

            if val != UNSET_SENTINEL:
                if (
                    val is not None
                    or k not in optional_fields
                    or is_nullable_and_explicitly_set
                ):
                    m[k] = val

        return m


try:
    MessagesOutputConfigFormat.model_rebuild()
except NameError:
    pass
try:
    MessagesOutputConfig.model_rebuild()
except NameError:
    pass