openrouter 0.0.21__py3-none-any.whl → 0.0.22__py3-none-any.whl

openrouter/components/chatgenerationparams.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from ._schema0 import Schema0, Schema0TypedDict
 from .chatstreamoptions import ChatStreamOptions, ChatStreamOptionsTypedDict
 from .message import Message, MessageTypedDict
 from .reasoningsummaryverbosity import ReasoningSummaryVerbosity
@@ -29,6 +30,347 @@ from typing import Any, Dict, List, Literal, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
+ChatGenerationParamsDataCollection = Union[
+    Literal[
+        "deny",
+        "allow",
+    ],
+    UnrecognizedStr,
+]
+
+
+Quantizations = Union[
+    Literal[
+        "int4",
+        "int8",
+        "fp4",
+        "fp6",
+        "fp8",
+        "fp16",
+        "bf16",
+        "fp32",
+        "unknown",
+    ],
+    UnrecognizedStr,
+]
+
+
+Sort = Union[
+    Literal[
+        "price",
+        "throughput",
+        "latency",
+    ],
+    UnrecognizedStr,
+]
+
+
+class ChatGenerationParamsMaxPriceTypedDict(TypedDict):
+    r"""The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion."""
+
+    prompt: NotRequired[Any]
+    completion: NotRequired[Any]
+    image: NotRequired[Any]
+    audio: NotRequired[Any]
+    request: NotRequired[Any]
+
+
+class ChatGenerationParamsMaxPrice(BaseModel):
+    r"""The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion."""
+
+    prompt: Optional[Any] = None
+
+    completion: Optional[Any] = None
+
+    image: Optional[Any] = None
+
+    audio: Optional[Any] = None
+
+    request: Optional[Any] = None
+
+
+class ChatGenerationParamsProviderTypedDict(TypedDict):
+    allow_fallbacks: NotRequired[Nullable[bool]]
+    r"""Whether to allow backup providers to serve requests
+    - true: (default) when the primary provider (or your custom providers in \"order\") is unavailable, use the next best provider.
+    - false: use only the primary/custom provider, and return the upstream error if it's unavailable.
+
+    """
+    require_parameters: NotRequired[Nullable[bool]]
+    r"""Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest."""
+    data_collection: NotRequired[Nullable[ChatGenerationParamsDataCollection]]
+    r"""Data collection setting. If no available model provider meets the requirement, your request will return an error.
+    - allow: (default) allow providers which store user data non-transiently and may train on it
+
+    - deny: use only providers which do not collect user data.
+    """
+    zdr: NotRequired[Nullable[bool]]
+    enforce_distillable_text: NotRequired[Nullable[bool]]
+    order: NotRequired[Nullable[List[Schema0TypedDict]]]
+    r"""An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message."""
+    only: NotRequired[Nullable[List[Schema0TypedDict]]]
+    r"""List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request."""
+    ignore: NotRequired[Nullable[List[Schema0TypedDict]]]
+    r"""List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request."""
+    quantizations: NotRequired[Nullable[List[Quantizations]]]
+    r"""A list of quantization levels to filter the provider by."""
+    sort: NotRequired[Nullable[Sort]]
+    r"""The sorting strategy to use for this request, if \"order\" is not specified. When set, no load balancing is performed."""
+    max_price: NotRequired[ChatGenerationParamsMaxPriceTypedDict]
+    r"""The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion."""
+    min_throughput: NotRequired[Nullable[float]]
+    r"""The minimum throughput (in tokens per second) required for this request. Only providers serving the model with at least this throughput will be used."""
+    max_latency: NotRequired[Nullable[float]]
+    r"""The maximum latency (in seconds) allowed for this request. Only providers serving the model with better than this latency will be used."""
+
+
+class ChatGenerationParamsProvider(BaseModel):
+    allow_fallbacks: OptionalNullable[bool] = UNSET
+    r"""Whether to allow backup providers to serve requests
+    - true: (default) when the primary provider (or your custom providers in \"order\") is unavailable, use the next best provider.
+    - false: use only the primary/custom provider, and return the upstream error if it's unavailable.
+
+    """
+
+    require_parameters: OptionalNullable[bool] = UNSET
+    r"""Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest."""
+
+    data_collection: Annotated[
+        OptionalNullable[ChatGenerationParamsDataCollection],
+        PlainValidator(validate_open_enum(False)),
+    ] = UNSET
+    r"""Data collection setting. If no available model provider meets the requirement, your request will return an error.
+    - allow: (default) allow providers which store user data non-transiently and may train on it
+
+    - deny: use only providers which do not collect user data.
+    """
+
+    zdr: OptionalNullable[bool] = UNSET
+
+    enforce_distillable_text: OptionalNullable[bool] = UNSET
+
+    order: OptionalNullable[List[Schema0]] = UNSET
+    r"""An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message."""
+
+    only: OptionalNullable[List[Schema0]] = UNSET
+    r"""List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request."""
+
+    ignore: OptionalNullable[List[Schema0]] = UNSET
+    r"""List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request."""
+
+    quantizations: OptionalNullable[
+        List[Annotated[Quantizations, PlainValidator(validate_open_enum(False))]]
+    ] = UNSET
+    r"""A list of quantization levels to filter the provider by."""
+
+    sort: Annotated[
+        OptionalNullable[Sort], PlainValidator(validate_open_enum(False))
+    ] = UNSET
+    r"""The sorting strategy to use for this request, if \"order\" is not specified. When set, no load balancing is performed."""
+
+    max_price: Optional[ChatGenerationParamsMaxPrice] = None
+    r"""The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion."""
+
+    min_throughput: OptionalNullable[float] = UNSET
+    r"""The minimum throughput (in tokens per second) required for this request. Only providers serving the model with at least this throughput will be used."""
+
+    max_latency: OptionalNullable[float] = UNSET
+    r"""The maximum latency (in seconds) allowed for this request. Only providers serving the model with better than this latency will be used."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "allow_fallbacks",
+            "require_parameters",
+            "data_collection",
+            "zdr",
+            "enforce_distillable_text",
+            "order",
+            "only",
+            "ignore",
+            "quantizations",
+            "sort",
+            "max_price",
+            "min_throughput",
+            "max_latency",
+        ]
+        nullable_fields = [
+            "allow_fallbacks",
+            "require_parameters",
+            "data_collection",
+            "zdr",
+            "enforce_distillable_text",
+            "order",
+            "only",
+            "ignore",
+            "quantizations",
+            "sort",
+            "min_throughput",
+            "max_latency",
+        ]
+        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 ChatGenerationParamsPluginResponseHealingTypedDict(TypedDict):
+    id: Literal["response-healing"]
+    enabled: NotRequired[bool]
+
+
+class ChatGenerationParamsPluginResponseHealing(BaseModel):
+    ID: Annotated[
+        Annotated[
+            Literal["response-healing"],
+            AfterValidator(validate_const("response-healing")),
+        ],
+        pydantic.Field(alias="id"),
+    ] = "response-healing"
+
+    enabled: Optional[bool] = None
+
+
+ChatGenerationParamsPdfEngine = Union[
+    Literal[
+        "mistral-ocr",
+        "pdf-text",
+        "native",
+    ],
+    UnrecognizedStr,
+]
+
+
+class ChatGenerationParamsPdfTypedDict(TypedDict):
+    engine: NotRequired[ChatGenerationParamsPdfEngine]
+
+
+class ChatGenerationParamsPdf(BaseModel):
+    engine: Annotated[
+        Optional[ChatGenerationParamsPdfEngine],
+        PlainValidator(validate_open_enum(False)),
+    ] = None
+
+
+class ChatGenerationParamsPluginFileParserTypedDict(TypedDict):
+    id: Literal["file-parser"]
+    enabled: NotRequired[bool]
+    max_files: NotRequired[float]
+    pdf: NotRequired[ChatGenerationParamsPdfTypedDict]
+
+
+class ChatGenerationParamsPluginFileParser(BaseModel):
+    ID: Annotated[
+        Annotated[
+            Literal["file-parser"], AfterValidator(validate_const("file-parser"))
+        ],
+        pydantic.Field(alias="id"),
+    ] = "file-parser"
+
+    enabled: Optional[bool] = None
+
+    max_files: Optional[float] = None
+
+    pdf: Optional[ChatGenerationParamsPdf] = None
+
+
+ChatGenerationParamsEngine = Union[
+    Literal[
+        "native",
+        "exa",
+    ],
+    UnrecognizedStr,
+]
+
+
+class ChatGenerationParamsPluginWebTypedDict(TypedDict):
+    id: Literal["web"]
+    enabled: NotRequired[bool]
+    max_results: NotRequired[float]
+    search_prompt: NotRequired[str]
+    engine: NotRequired[ChatGenerationParamsEngine]
+
+
+class ChatGenerationParamsPluginWeb(BaseModel):
+    ID: Annotated[
+        Annotated[Literal["web"], AfterValidator(validate_const("web"))],
+        pydantic.Field(alias="id"),
+    ] = "web"
+
+    enabled: Optional[bool] = None
+
+    max_results: Optional[float] = None
+
+    search_prompt: Optional[str] = None
+
+    engine: Annotated[
+        Optional[ChatGenerationParamsEngine], PlainValidator(validate_open_enum(False))
+    ] = None
+
+
+class ChatGenerationParamsPluginModerationTypedDict(TypedDict):
+    id: Literal["moderation"]
+
+
+class ChatGenerationParamsPluginModeration(BaseModel):
+    ID: Annotated[
+        Annotated[Literal["moderation"], AfterValidator(validate_const("moderation"))],
+        pydantic.Field(alias="id"),
+    ] = "moderation"
+
+
+ChatGenerationParamsPluginUnionTypedDict = TypeAliasType(
+    "ChatGenerationParamsPluginUnionTypedDict",
+    Union[
+        ChatGenerationParamsPluginModerationTypedDict,
+        ChatGenerationParamsPluginResponseHealingTypedDict,
+        ChatGenerationParamsPluginFileParserTypedDict,
+        ChatGenerationParamsPluginWebTypedDict,
+    ],
+)
+
+
+ChatGenerationParamsPluginUnion = Annotated[
+    Union[
+        Annotated[ChatGenerationParamsPluginModeration, Tag("moderation")],
+        Annotated[ChatGenerationParamsPluginWeb, Tag("web")],
+        Annotated[ChatGenerationParamsPluginFileParser, Tag("file-parser")],
+        Annotated[ChatGenerationParamsPluginResponseHealing, Tag("response-healing")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "id", "id")),
+]
+
+
+ChatGenerationParamsRoute = Union[
+    Literal[
+        "fallback",
+        "sort",
+    ],
+    UnrecognizedStr,
+]
+
+
 Effort = Union[
     Literal[
         "none",
@@ -36,6 +378,7 @@ Effort = Union[
         "low",
         "medium",
         "high",
+        "xhigh",
     ],
     UnrecognizedStr,
 ]
@@ -166,6 +509,15 @@ class Debug(BaseModel):
 
 class ChatGenerationParamsTypedDict(TypedDict):
     messages: List[MessageTypedDict]
+    provider: NotRequired[Nullable[ChatGenerationParamsProviderTypedDict]]
+    r"""When multiple model providers are available, optionally indicate your routing preference."""
+    plugins: NotRequired[List[ChatGenerationParamsPluginUnionTypedDict]]
+    r"""Plugins you want to enable for this request, including their settings."""
+    route: NotRequired[Nullable[ChatGenerationParamsRoute]]
+    r"""Routing strategy for multiple models: \"fallback\" (default) uses secondary models as backups, \"sort\" sorts all endpoints together by routing criteria."""
+    user: NotRequired[str]
+    session_id: NotRequired[str]
+    r"""A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters."""
     model: NotRequired[str]
     models: NotRequired[List[str]]
     frequency_penalty: NotRequired[Nullable[float]]
@@ -186,13 +538,29 @@ class ChatGenerationParamsTypedDict(TypedDict):
     tool_choice: NotRequired[Any]
     tools: NotRequired[List[ToolDefinitionJSONTypedDict]]
     top_p: NotRequired[Nullable[float]]
-    user: NotRequired[str]
     debug: NotRequired[DebugTypedDict]
 
 
 class ChatGenerationParams(BaseModel):
     messages: List[Message]
 
+    provider: OptionalNullable[ChatGenerationParamsProvider] = UNSET
+    r"""When multiple model providers are available, optionally indicate your routing preference."""
+
+    plugins: Optional[List[ChatGenerationParamsPluginUnion]] = None
+    r"""Plugins you want to enable for this request, including their settings."""
+
+    route: Annotated[
+        OptionalNullable[ChatGenerationParamsRoute],
+        PlainValidator(validate_open_enum(False)),
+    ] = UNSET
+    r"""Routing strategy for multiple models: \"fallback\" (default) uses secondary models as backups, \"sort\" sorts all endpoints together by routing criteria."""
+
+    user: Optional[str] = None
+
+    session_id: Optional[str] = None
+    r"""A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters."""
+
     model: Optional[str] = None
 
     models: Optional[List[str]] = None
@@ -233,13 +601,16 @@ class ChatGenerationParams(BaseModel):
 
     top_p: OptionalNullable[float] = UNSET
 
-    user: Optional[str] = None
-
     debug: Optional[Debug] = None
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
+            "provider",
+            "plugins",
+            "route",
+            "user",
+            "session_id",
             "model",
             "models",
             "frequency_penalty",
@@ -260,10 +631,11 @@ class ChatGenerationParams(BaseModel):
             "tool_choice",
             "tools",
             "top_p",
-            "user",
             "debug",
         ]
         nullable_fields = [
+            "provider",
+            "route",
             "frequency_penalty",
             "logit_bias",
             "logprobs",

openrouter/components/openairesponsesreasoningeffort.py

@@ -7,6 +7,7 @@ from typing import Literal, Union
 
 OpenAIResponsesReasoningEffort = Union[
     Literal[
+        "xhigh",
         "high",
         "medium",
         "low",