orq-ai-sdk 4.2.0rc28__py3-none-any.whl → 4.3.0rc7__py3-none-any.whl

orq_ai_sdk/models/createimageop.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 from .publiccontact import PublicContact, PublicContactTypedDict
+from .publicidentity import PublicIdentity, PublicIdentityTypedDict
 from orq_ai_sdk.types import (
     BaseModel,
     Nullable,
@@ -9,9 +10,10 @@ from orq_ai_sdk.types import (
     UNSET,
     UNSET_SENTINEL,
 )
+import pydantic
 from pydantic import model_serializer
-from typing import Any, Dict, List, Literal, Optional
-from typing_extensions import NotRequired, TypedDict, deprecated
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 Background = Literal[
@@ -62,6 +64,16 @@ Style = Literal[
 r"""The style of the generated images. This parameter is only supported for `openai/dall-e-3`. Must be one of `vivid` or `natural`."""
 
 
+class CreateImageFallbacksTypedDict(TypedDict):
+    model: str
+    r"""Fallback model identifier"""
+
+
+class CreateImageFallbacks(BaseModel):
+    model: str
+    r"""Fallback model identifier"""
+
+
 class CreateImageRetryTypedDict(TypedDict):
     r"""Retry configuration for the request"""
 
@@ -80,60 +92,21 @@ class CreateImageRetry(BaseModel):
     on_codes: Optional[List[float]] = None
     r"""HTTP status codes that trigger retry logic"""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["count", "on_codes"])
+        serialized = handler(self)
+        m = {}
 
-class CreateImageFallbacksTypedDict(TypedDict):
-    model: str
-    r"""Fallback model identifier"""
-
-
-class CreateImageFallbacks(BaseModel):
-    model: str
-    r"""Fallback model identifier"""
-
-
-@deprecated(
-    "warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
-)
-class CreateImageContactTypedDict(TypedDict):
-    r"""@deprecated Use identity instead. Information about the contact making the request."""
-
-    id: str
-    r"""Unique identifier for the contact"""
-    display_name: NotRequired[str]
-    r"""Display name of the contact"""
-    email: NotRequired[str]
-    r"""Email address of the contact"""
-    metadata: NotRequired[List[Dict[str, Any]]]
-    r"""A hash of key/value pairs containing any other data about the contact"""
-    logo_url: NotRequired[str]
-    r"""URL to the contact's avatar or logo"""
-    tags: NotRequired[List[str]]
-    r"""A list of tags associated with the contact"""
-
-
-@deprecated(
-    "warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
-)
-class CreateImageContact(BaseModel):
-    r"""@deprecated Use identity instead. Information about the contact making the request."""
-
-    id: str
-    r"""Unique identifier for the contact"""
-
-    display_name: Optional[str] = None
-    r"""Display name of the contact"""
-
-    email: Optional[str] = None
-    r"""Email address of the contact"""
-
-    metadata: Optional[List[Dict[str, Any]]] = None
-    r"""A hash of key/value pairs containing any other data about the contact"""
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
 
-    logo_url: Optional[str] = None
-    r"""URL to the contact's avatar or logo"""
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
 
-    tags: Optional[List[str]] = None
-    r"""A list of tags associated with the contact"""
+        return m
 
 
 CreateImageType = Literal["exact_match",]
@@ -155,32 +128,116 @@ class CreateImageCache(BaseModel):
     ttl: Optional[float] = 1800
     r"""Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)."""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ttl"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
 
 CreateImageLoadBalancerType = Literal["weight_based",]
 
 
-class CreateImageLoadBalancer1TypedDict(TypedDict):
-    type: CreateImageLoadBalancerType
+class CreateImageLoadBalancerModelsTypedDict(TypedDict):
     model: str
     r"""Model identifier for load balancing"""
     weight: NotRequired[float]
     r"""Weight assigned to this model for load balancing"""
 
 
+class CreateImageLoadBalancerModels(BaseModel):
+    model: str
+    r"""Model identifier for load balancing"""
+
+    weight: Optional[float] = 0.5
+    r"""Weight assigned to this model for load balancing"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["weight"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class CreateImageLoadBalancer1TypedDict(TypedDict):
+    type: CreateImageLoadBalancerType
+    models: List[CreateImageLoadBalancerModelsTypedDict]
+
+
 class CreateImageLoadBalancer1(BaseModel):
     type: CreateImageLoadBalancerType
 
+    models: List[CreateImageLoadBalancerModels]
+
+
+class CreateImageLoadBalancerRouterImagesGenerationsModelsTypedDict(TypedDict):
+    model: str
+    r"""Model identifier for load balancing"""
+    weight: NotRequired[float]
+    r"""Weight assigned to this model for load balancing"""
+
+
+class CreateImageLoadBalancerRouterImagesGenerationsModels(BaseModel):
     model: str
     r"""Model identifier for load balancing"""
 
     weight: Optional[float] = 0.5
     r"""Weight assigned to this model for load balancing"""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["weight"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class CreateImageLoadBalancerRouterImagesGenerations1TypedDict(TypedDict):
+    type: CreateImageLoadBalancerRouterImagesGenerationsType
+    models: List[CreateImageLoadBalancerRouterImagesGenerationsModelsTypedDict]
+
+
+class CreateImageLoadBalancerRouterImagesGenerations1(BaseModel):
+    type: CreateImageLoadBalancerRouterImagesGenerationsType
+
+    models: List[CreateImageLoadBalancerRouterImagesGenerationsModels]
+
 
 CreateImageLoadBalancerTypedDict = CreateImageLoadBalancer1TypedDict
+r"""Load balancer configuration for the request."""
 
 
 CreateImageLoadBalancer = CreateImageLoadBalancer1
+r"""Load balancer configuration for the request."""
 
 
 class CreateImageTimeoutTypedDict(TypedDict):
@@ -197,21 +254,132 @@ class CreateImageTimeout(BaseModel):
     r"""Timeout value in milliseconds"""
 
 
+class CreateImageRouterImagesGenerationsRetryTypedDict(TypedDict):
+    r"""Retry configuration for the request"""
+
+    count: NotRequired[float]
+    r"""Number of retry attempts (1-5)"""
+    on_codes: NotRequired[List[float]]
+    r"""HTTP status codes that trigger retry logic"""
+
+
+class CreateImageRouterImagesGenerationsRetry(BaseModel):
+    r"""Retry configuration for the request"""
+
+    count: Optional[float] = 3
+    r"""Number of retry attempts (1-5)"""
+
+    on_codes: Optional[List[float]] = None
+    r"""HTTP status codes that trigger retry logic"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["count", "on_codes"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class CreateImageRouterImagesGenerationsFallbacksTypedDict(TypedDict):
+    model: str
+    r"""Fallback model identifier"""
+
+
+class CreateImageRouterImagesGenerationsFallbacks(BaseModel):
+    model: str
+    r"""Fallback model identifier"""
+
+
+CreateImageRouterImagesGenerationsType = Literal["exact_match",]
+
+
+class CreateImageRouterImagesGenerationsCacheTypedDict(TypedDict):
+    r"""Cache configuration for the request."""
+
+    type: CreateImageRouterImagesGenerationsType
+    ttl: NotRequired[float]
+    r"""Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)."""
+
+
+class CreateImageRouterImagesGenerationsCache(BaseModel):
+    r"""Cache configuration for the request."""
+
+    type: CreateImageRouterImagesGenerationsType
+
+    ttl: Optional[float] = 1800
+    r"""Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ttl"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+CreateImageLoadBalancerRouterImagesGenerationsType = Literal["weight_based",]
+
+
+CreateImageRouterImagesGenerationsLoadBalancerTypedDict = (
+    CreateImageLoadBalancerRouterImagesGenerations1TypedDict
+)
+r"""Array of models with weights for load balancing requests"""
+
+
+CreateImageRouterImagesGenerationsLoadBalancer = (
+    CreateImageLoadBalancerRouterImagesGenerations1
+)
+r"""Array of models with weights for load balancing requests"""
+
+
+class CreateImageRouterImagesGenerationsTimeoutTypedDict(TypedDict):
+    r"""Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured."""
+
+    call_timeout: float
+    r"""Timeout value in milliseconds"""
+
+
+class CreateImageRouterImagesGenerationsTimeout(BaseModel):
+    r"""Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured."""
+
+    call_timeout: float
+    r"""Timeout value in milliseconds"""
+
+
 class CreateImageOrqTypedDict(TypedDict):
     name: NotRequired[str]
     r"""The name to display on the trace. If not specified, the default system name will be used."""
-    retry: NotRequired[CreateImageRetryTypedDict]
+    retry: NotRequired[CreateImageRouterImagesGenerationsRetryTypedDict]
     r"""Retry configuration for the request"""
-    fallbacks: NotRequired[List[CreateImageFallbacksTypedDict]]
+    fallbacks: NotRequired[List[CreateImageRouterImagesGenerationsFallbacksTypedDict]]
     r"""Array of fallback models to use if primary model fails"""
-    identity: NotRequired[PublicContactTypedDict]
+    identity: NotRequired[PublicIdentityTypedDict]
     r"""Information about the identity making the request. If the identity does not exist, it will be created automatically."""
-    contact: NotRequired[CreateImageContactTypedDict]
-    cache: NotRequired[CreateImageCacheTypedDict]
+    contact: NotRequired[PublicContactTypedDict]
+    r"""@deprecated Use identity instead. Information about the contact making the request."""
+    cache: NotRequired[CreateImageRouterImagesGenerationsCacheTypedDict]
     r"""Cache configuration for the request."""
-    load_balancer: NotRequired[List[CreateImageLoadBalancerTypedDict]]
+    load_balancer: NotRequired[CreateImageRouterImagesGenerationsLoadBalancerTypedDict]
     r"""Array of models with weights for load balancing requests"""
-    timeout: NotRequired[CreateImageTimeoutTypedDict]
+    timeout: NotRequired[CreateImageRouterImagesGenerationsTimeoutTypedDict]
     r"""Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured."""
 
 
@@ -219,26 +387,59 @@ class CreateImageOrq(BaseModel):
     name: Optional[str] = None
     r"""The name to display on the trace. If not specified, the default system name will be used."""
 
-    retry: Optional[CreateImageRetry] = None
+    retry: Optional[CreateImageRouterImagesGenerationsRetry] = None
     r"""Retry configuration for the request"""
 
-    fallbacks: Optional[List[CreateImageFallbacks]] = None
+    fallbacks: Optional[List[CreateImageRouterImagesGenerationsFallbacks]] = None
     r"""Array of fallback models to use if primary model fails"""
 
-    identity: Optional[PublicContact] = None
+    identity: Optional[PublicIdentity] = None
     r"""Information about the identity making the request. If the identity does not exist, it will be created automatically."""
 
-    contact: Optional[CreateImageContact] = None
+    contact: Annotated[
+        Optional[PublicContact],
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+        ),
+    ] = None
+    r"""@deprecated Use identity instead. Information about the contact making the request."""
 
-    cache: Optional[CreateImageCache] = None
+    cache: Optional[CreateImageRouterImagesGenerationsCache] = None
     r"""Cache configuration for the request."""
 
-    load_balancer: Optional[List[CreateImageLoadBalancer]] = None
+    load_balancer: Optional[CreateImageRouterImagesGenerationsLoadBalancer] = None
     r"""Array of models with weights for load balancing requests"""
 
-    timeout: Optional[CreateImageTimeout] = None
+    timeout: Optional[CreateImageRouterImagesGenerationsTimeout] = None
     r"""Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured."""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "name",
+                "retry",
+                "fallbacks",
+                "identity",
+                "contact",
+                "cache",
+                "load_balancer",
+                "timeout",
+            ]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
 
 class CreateImageRequestBodyTypedDict(TypedDict):
     r"""input"""
@@ -265,6 +466,18 @@ class CreateImageRequestBodyTypedDict(TypedDict):
     r"""The size of the generated images. Must be one of the specified sizes for each model."""
     style: NotRequired[Nullable[Style]]
     r"""The style of the generated images. This parameter is only supported for `openai/dall-e-3`. Must be one of `vivid` or `natural`."""
+    name: NotRequired[str]
+    r"""The name to display on the trace. If not specified, the default system name will be used."""
+    fallbacks: NotRequired[List[CreateImageFallbacksTypedDict]]
+    r"""Array of fallback models to use if primary model fails"""
+    retry: NotRequired[CreateImageRetryTypedDict]
+    r"""Retry configuration for the request"""
+    cache: NotRequired[CreateImageCacheTypedDict]
+    r"""Cache configuration for the request."""
+    load_balancer: NotRequired[CreateImageLoadBalancerTypedDict]
+    r"""Load balancer configuration for the request."""
+    timeout: NotRequired[CreateImageTimeoutTypedDict]
+    r"""Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured."""
     orq: NotRequired[CreateImageOrqTypedDict]
 
 
@@ -304,56 +517,79 @@ class CreateImageRequestBody(BaseModel):
     style: OptionalNullable[Style] = UNSET
     r"""The style of the generated images. This parameter is only supported for `openai/dall-e-3`. Must be one of `vivid` or `natural`."""
 
+    name: Optional[str] = None
+    r"""The name to display on the trace. If not specified, the default system name will be used."""
+
+    fallbacks: Optional[List[CreateImageFallbacks]] = None
+    r"""Array of fallback models to use if primary model fails"""
+
+    retry: Optional[CreateImageRetry] = None
+    r"""Retry configuration for the request"""
+
+    cache: Optional[CreateImageCache] = None
+    r"""Cache configuration for the request."""
+
+    load_balancer: Optional[CreateImageLoadBalancer] = None
+    r"""Load balancer configuration for the request."""
+
+    timeout: Optional[CreateImageTimeout] = None
+    r"""Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured."""
+
     orq: Optional[CreateImageOrq] = None
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = [
-            "background",
-            "moderation",
-            "n",
-            "output_compression",
-            "output_format",
-            "quality",
-            "response_format",
-            "size",
-            "style",
-            "orq",
-        ]
-        nullable_fields = [
-            "background",
-            "moderation",
-            "n",
-            "output_compression",
-            "output_format",
-            "quality",
-            "response_format",
-            "size",
-            "style",
-        ]
-        null_default_fields = []
-
+        optional_fields = set(
+            [
+                "background",
+                "moderation",
+                "n",
+                "output_compression",
+                "output_format",
+                "quality",
+                "response_format",
+                "size",
+                "style",
+                "name",
+                "fallbacks",
+                "retry",
+                "cache",
+                "load_balancer",
+                "timeout",
+                "orq",
+            ]
+        )
+        nullable_fields = set(
+            [
+                "background",
+                "moderation",
+                "n",
+                "output_compression",
+                "output_format",
+                "quality",
+                "response_format",
+                "size",
+                "style",
+            ]
+        )
         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
+            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
 
@@ -379,31 +615,26 @@ class CreateImageData(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["revised_prompt", "b64_json", "url"]
-        nullable_fields = ["revised_prompt"]
-        null_default_fields = []
-
+        optional_fields = set(["revised_prompt", "b64_json", "url"])
+        nullable_fields = set(["revised_prompt"])
         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
+            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
 
@@ -418,6 +649,22 @@ class InputTokensDetails(BaseModel):
 
     text_tokens: Optional[float] = None
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["image_tokens", "text_tokens"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
 
 class CreateImageUsageTypedDict(TypedDict):
     input_tokens_details: InputTokensDetailsTypedDict
@@ -435,6 +682,22 @@ class CreateImageUsage(BaseModel):
 
     total_tokens: Optional[float] = None
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["input_tokens", "output_tokens", "total_tokens"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
 
 class CreateImageResponseBodyTypedDict(TypedDict):
     r"""Represents an image generation response from the API."""
@@ -456,3 +719,19 @@ class CreateImageResponseBody(BaseModel):
     r"""Represents the url or the content of an image generated."""
 
     usage: Optional[CreateImageUsage] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["usage"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m