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

orq_ai_sdk/generations.py

@@ -0,0 +1,370 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from orq_ai_sdk import models, utils
+from orq_ai_sdk._hooks import HookContext
+from orq_ai_sdk.models import createimageop as models_createimageop
+from orq_ai_sdk.types import OptionalNullable, UNSET
+from orq_ai_sdk.utils import get_security_from_env
+from orq_ai_sdk.utils.unmarshal_json_response import unmarshal_json_response
+from typing import List, Mapping, Optional, Union
+
+
+class Generations(BaseSDK):
+    def create(
+        self,
+        *,
+        prompt: str,
+        model: str,
+        background: OptionalNullable[models_createimageop.Background] = UNSET,
+        moderation: OptionalNullable[models_createimageop.Moderation] = UNSET,
+        n: OptionalNullable[int] = 1,
+        output_compression: OptionalNullable[int] = UNSET,
+        output_format: OptionalNullable[models_createimageop.OutputFormat] = UNSET,
+        quality: OptionalNullable[models_createimageop.Quality] = UNSET,
+        response_format: OptionalNullable[
+            models_createimageop.CreateImageResponseFormat
+        ] = UNSET,
+        size: OptionalNullable[str] = UNSET,
+        style: OptionalNullable[models_createimageop.Style] = UNSET,
+        name: Optional[str] = None,
+        fallbacks: Optional[
+            Union[
+                List[models_createimageop.CreateImageFallbacks],
+                List[models_createimageop.CreateImageFallbacksTypedDict],
+            ]
+        ] = None,
+        retry: Optional[
+            Union[
+                models_createimageop.CreateImageRetry,
+                models_createimageop.CreateImageRetryTypedDict,
+            ]
+        ] = None,
+        cache: Optional[
+            Union[
+                models_createimageop.CreateImageCache,
+                models_createimageop.CreateImageCacheTypedDict,
+            ]
+        ] = None,
+        load_balancer: Optional[
+            Union[
+                models_createimageop.CreateImageLoadBalancer,
+                models_createimageop.CreateImageLoadBalancerTypedDict,
+            ]
+        ] = None,
+        timeout: Optional[
+            Union[
+                models_createimageop.CreateImageTimeout,
+                models_createimageop.CreateImageTimeoutTypedDict,
+            ]
+        ] = None,
+        orq: Optional[
+            Union[
+                models_createimageop.CreateImageOrq,
+                models_createimageop.CreateImageOrqTypedDict,
+            ]
+        ] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.CreateImageResponseBody:
+        r"""Create image
+
+        Create an Image
+
+        :param prompt: A text description of the desired image(s).
+        :param model: The model to use for image generation. One of `openai/dall-e-2`, `openai/dall-e-3`, or `openai/gpt-image-1`.
+        :param background: Allows to set transparency for the background of the generated image(s). This parameter is only supported for `openai/gpt-image-1`.
+        :param moderation: Control the content-moderation level for images generated by `gpt-image-1`. Must be either `low` or `auto`.
+        :param n: The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.
+        :param output_compression: The compression level (0-100%) for the generated images. This parameter is only supported for `gpt-image-1` with the `webp` or `jpeg` output formats.
+        :param output_format: The format in which the generated images are returned. This parameter is only supported for `openai/gpt-image-1`.
+        :param quality: The quality of the image that will be generated. `auto` will automatically select the best quality for the given model.
+        :param response_format: The format in which generated images are returned. Must be one of `url` or `b64_json`. This parameter isn't supported for `gpt-image-1` which will always return base64-encoded images.
+        :param size: The size of the generated images. Must be one of the specified sizes for each model.
+        :param style: The style of the generated images. This parameter is only supported for `openai/dall-e-3`. Must be one of `vivid` or `natural`.
+        :param name: The name to display on the trace. If not specified, the default system name will be used.
+        :param fallbacks: Array of fallback models to use if primary model fails
+        :param retry: Retry configuration for the request
+        :param cache: Cache configuration for the request.
+        :param load_balancer: Load balancer configuration for the request.
+        :param timeout: 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.
+        :param orq:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if timeout_ms is None:
+            timeout_ms = 600000
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.CreateImageRequestBody(
+            prompt=prompt,
+            background=background,
+            model=model,
+            moderation=moderation,
+            n=n,
+            output_compression=output_compression,
+            output_format=output_format,
+            quality=quality,
+            response_format=response_format,
+            size=size,
+            style=style,
+            name=name,
+            fallbacks=utils.get_pydantic_model(
+                fallbacks, Optional[List[models.CreateImageFallbacks]]
+            ),
+            retry=utils.get_pydantic_model(retry, Optional[models.CreateImageRetry]),
+            cache=utils.get_pydantic_model(cache, Optional[models.CreateImageCache]),
+            load_balancer=utils.get_pydantic_model(
+                load_balancer, Optional[models.CreateImageLoadBalancer]
+            ),
+            timeout=utils.get_pydantic_model(
+                timeout, Optional[models.CreateImageTimeout]
+            ),
+            orq=utils.get_pydantic_model(orq, Optional[models.CreateImageOrq]),
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/v2/router/images/generations",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.CreateImageRequestBody
+            ),
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="createImage",
+                oauth2_scopes=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["4XX", "5XX"],
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.CreateImageResponseBody, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise models.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise models.APIError("API error occurred", http_res, http_res_text)
+
+        raise models.APIError("Unexpected response received", http_res)
+
+    async def create_async(
+        self,
+        *,
+        prompt: str,
+        model: str,
+        background: OptionalNullable[models_createimageop.Background] = UNSET,
+        moderation: OptionalNullable[models_createimageop.Moderation] = UNSET,
+        n: OptionalNullable[int] = 1,
+        output_compression: OptionalNullable[int] = UNSET,
+        output_format: OptionalNullable[models_createimageop.OutputFormat] = UNSET,
+        quality: OptionalNullable[models_createimageop.Quality] = UNSET,
+        response_format: OptionalNullable[
+            models_createimageop.CreateImageResponseFormat
+        ] = UNSET,
+        size: OptionalNullable[str] = UNSET,
+        style: OptionalNullable[models_createimageop.Style] = UNSET,
+        name: Optional[str] = None,
+        fallbacks: Optional[
+            Union[
+                List[models_createimageop.CreateImageFallbacks],
+                List[models_createimageop.CreateImageFallbacksTypedDict],
+            ]
+        ] = None,
+        retry: Optional[
+            Union[
+                models_createimageop.CreateImageRetry,
+                models_createimageop.CreateImageRetryTypedDict,
+            ]
+        ] = None,
+        cache: Optional[
+            Union[
+                models_createimageop.CreateImageCache,
+                models_createimageop.CreateImageCacheTypedDict,
+            ]
+        ] = None,
+        load_balancer: Optional[
+            Union[
+                models_createimageop.CreateImageLoadBalancer,
+                models_createimageop.CreateImageLoadBalancerTypedDict,
+            ]
+        ] = None,
+        timeout: Optional[
+            Union[
+                models_createimageop.CreateImageTimeout,
+                models_createimageop.CreateImageTimeoutTypedDict,
+            ]
+        ] = None,
+        orq: Optional[
+            Union[
+                models_createimageop.CreateImageOrq,
+                models_createimageop.CreateImageOrqTypedDict,
+            ]
+        ] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.CreateImageResponseBody:
+        r"""Create image
+
+        Create an Image
+
+        :param prompt: A text description of the desired image(s).
+        :param model: The model to use for image generation. One of `openai/dall-e-2`, `openai/dall-e-3`, or `openai/gpt-image-1`.
+        :param background: Allows to set transparency for the background of the generated image(s). This parameter is only supported for `openai/gpt-image-1`.
+        :param moderation: Control the content-moderation level for images generated by `gpt-image-1`. Must be either `low` or `auto`.
+        :param n: The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.
+        :param output_compression: The compression level (0-100%) for the generated images. This parameter is only supported for `gpt-image-1` with the `webp` or `jpeg` output formats.
+        :param output_format: The format in which the generated images are returned. This parameter is only supported for `openai/gpt-image-1`.
+        :param quality: The quality of the image that will be generated. `auto` will automatically select the best quality for the given model.
+        :param response_format: The format in which generated images are returned. Must be one of `url` or `b64_json`. This parameter isn't supported for `gpt-image-1` which will always return base64-encoded images.
+        :param size: The size of the generated images. Must be one of the specified sizes for each model.
+        :param style: The style of the generated images. This parameter is only supported for `openai/dall-e-3`. Must be one of `vivid` or `natural`.
+        :param name: The name to display on the trace. If not specified, the default system name will be used.
+        :param fallbacks: Array of fallback models to use if primary model fails
+        :param retry: Retry configuration for the request
+        :param cache: Cache configuration for the request.
+        :param load_balancer: Load balancer configuration for the request.
+        :param timeout: 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.
+        :param orq:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if timeout_ms is None:
+            timeout_ms = 600000
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.CreateImageRequestBody(
+            prompt=prompt,
+            background=background,
+            model=model,
+            moderation=moderation,
+            n=n,
+            output_compression=output_compression,
+            output_format=output_format,
+            quality=quality,
+            response_format=response_format,
+            size=size,
+            style=style,
+            name=name,
+            fallbacks=utils.get_pydantic_model(
+                fallbacks, Optional[List[models.CreateImageFallbacks]]
+            ),
+            retry=utils.get_pydantic_model(retry, Optional[models.CreateImageRetry]),
+            cache=utils.get_pydantic_model(cache, Optional[models.CreateImageCache]),
+            load_balancer=utils.get_pydantic_model(
+                load_balancer, Optional[models.CreateImageLoadBalancer]
+            ),
+            timeout=utils.get_pydantic_model(
+                timeout, Optional[models.CreateImageTimeout]
+            ),
+            orq=utils.get_pydantic_model(orq, Optional[models.CreateImageOrq]),
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/v2/router/images/generations",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.CreateImageRequestBody
+            ),
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="createImage",
+                oauth2_scopes=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["4XX", "5XX"],
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.CreateImageResponseBody, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise models.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise models.APIError("API error occurred", http_res, http_res_text)
+
+        raise models.APIError("Unexpected response received", http_res)