feat(api): gpt-image-1.5

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 137
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-fe8e67bdc351a518b113ab48e775750190e207807903d6b03ab22c438c38a588.yml
-openapi_spec_hash: 8af972190647ffb9dcec516e19d8761a
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-cded37ac004364c2110ebdacf922ef611b3c51258790c72ca479dcfad4df66aa.yml
+openapi_spec_hash: 6e615d34cf8c6bc76e0c6933fc8569af
 config_hash: d013f4fdd4dd59c6f376a9ca482b7f9e

src/openai/resources/images.py

@@ -13,8 +13,8 @@ class Image(BaseModel):
     b64_json: Optional[str] = None
     """The base64-encoded JSON of the generated image.
 
-    Default value for `gpt-image-1`, and only present if `response_format` is set to
-    `b64_json` for `dall-e-2` and `dall-e-3`.
+    Returned by default for the GPT image models, and only present if
+    `response_format` is set to `b64_json` for `dall-e-2` and `dall-e-3`.
     """
 
     revised_prompt: Optional[str] = None
@@ -23,6 +23,6 @@ class Image(BaseModel):
     url: Optional[str] = None
     """
     When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
-    `response_format` is set to `url` (default value). Unsupported for
-    `gpt-image-1`.
+    `response_format` is set to `url` (default value). Unsupported for the GPT image
+    models.
     """

src/openai/types/image.py

@@ -18,7 +18,9 @@ class UsageInputTokensDetails(BaseModel):
 
 
 class Usage(BaseModel):
-    """For `gpt-image-1` only, the token usage information for the image generation."""
+    """
+    For the GPT image models only, the token usage information for the image generation.
+    """
 
     input_tokens: int
     """The number of tokens (images and text) in the input prompt."""
@@ -58,4 +60,7 @@ class ImageEditCompletedEvent(BaseModel):
     """The type of the event. Always `image_edit.completed`."""
 
     usage: Usage
-    """For `gpt-image-1` only, the token usage information for the image generation."""
+    """
+    For the GPT image models only, the token usage information for the image
+    generation.
+    """

src/openai/types/image_edit_completed_event.py

@@ -15,7 +15,8 @@ class ImageEditParamsBase(TypedDict, total=False):
     image: Required[Union[FileTypes, SequenceNotStr[FileTypes]]]
     """The image(s) to edit. Must be a supported image file or an array of images.
 
-    For `gpt-image-1`, each image should be a `png`, `webp`, or `jpg` file less than
+    For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, and
+    `gpt-image-1.5`), each image should be a `png`, `webp`, or `jpg` file less than
     50MB. You can provide up to 16 images.
 
     For `dall-e-2`, you can only provide one image, and it should be a square `png`
@@ -26,15 +27,15 @@ class ImageEditParamsBase(TypedDict, total=False):
     """A text description of the desired image(s).
 
     The maximum length is 1000 characters for `dall-e-2`, and 32000 characters for
-    `gpt-image-1`.
+    the GPT image models.
     """
 
     background: Optional[Literal["transparent", "opaque", "auto"]]
     """
     Allows to set transparency for the background of the generated image(s). This
-    parameter is only supported for `gpt-image-1`. Must be one of `transparent`,
-    `opaque` or `auto` (default value). When `auto` is used, the model will
-    automatically determine the best background for the image.
+    parameter is only supported for the GPT image models. Must be one of
+    `transparent`, `opaque` or `auto` (default value). When `auto` is used, the
+    model will automatically determine the best background for the image.
 
     If `transparent`, the output format needs to support transparency, so it should
     be set to either `png` (default value) or `webp`.
@@ -59,8 +60,8 @@ class ImageEditParamsBase(TypedDict, total=False):
     model: Union[str, ImageModel, None]
     """The model to use for image generation.
 
-    Only `dall-e-2` and `gpt-image-1` are supported. Defaults to `dall-e-2` unless a
-    parameter specific to `gpt-image-1` is used.
+    Only `dall-e-2` and the GPT image models are supported. Defaults to `dall-e-2`
+    unless a parameter specific to the GPT image models is used.
     """
 
     n: Optional[int]
@@ -69,14 +70,14 @@ class ImageEditParamsBase(TypedDict, total=False):
     output_compression: Optional[int]
     """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, and defaults to 100.
+    This parameter is only supported for the GPT image models with the `webp` or
+    `jpeg` output formats, and defaults to 100.
     """
 
     output_format: Optional[Literal["png", "jpeg", "webp"]]
     """The format in which the generated images are returned.
 
-    This parameter is only supported for `gpt-image-1`. Must be one of `png`,
+    This parameter is only supported for the GPT image models. Must be one of `png`,
     `jpeg`, or `webp`. The default value is `png`.
     """
 
@@ -94,24 +95,24 @@ class ImageEditParamsBase(TypedDict, total=False):
     quality: Optional[Literal["standard", "low", "medium", "high", "auto"]]
     """The quality of the image that will be generated.
 
-    `high`, `medium` and `low` are only supported for `gpt-image-1`. `dall-e-2` only
-    supports `standard` quality. Defaults to `auto`.
+    `high`, `medium` and `low` are only supported for the GPT image models.
+    `dall-e-2` only supports `standard` quality. Defaults to `auto`.
     """
 
     response_format: Optional[Literal["url", "b64_json"]]
     """The format in which the generated images are returned.
 
     Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the
     image has been generated. This parameter is only supported for `dall-e-2`, as
-    `gpt-image-1` will always return base64-encoded images.
+    the GPT image models always return base64-encoded images.
     """
 
     size: Optional[Literal["256x256", "512x512", "1024x1024", "1536x1024", "1024x1536", "auto"]]
     """The size of the generated images.
 
     Must be one of `1024x1024`, `1536x1024` (landscape), `1024x1536` (portrait), or
-    `auto` (default value) for `gpt-image-1`, and one of `256x256`, `512x512`, or
-    `1024x1024` for `dall-e-2`.
+    `auto` (default value) for the GPT image models, and one of `256x256`,
+    `512x512`, or `1024x1024` for `dall-e-2`.
     """
 
     user: str

src/openai/types/image_edit_params.py

@@ -18,7 +18,9 @@ class UsageInputTokensDetails(BaseModel):
 
 
 class Usage(BaseModel):
-    """For `gpt-image-1` only, the token usage information for the image generation."""
+    """
+    For the GPT image models only, the token usage information for the image generation.
+    """
 
     input_tokens: int
     """The number of tokens (images and text) in the input prompt."""
@@ -58,4 +60,7 @@ class ImageGenCompletedEvent(BaseModel):
     """The type of the event. Always `image_generation.completed`."""
 
     usage: Usage
-    """For `gpt-image-1` only, the token usage information for the image generation."""
+    """
+    For the GPT image models only, the token usage information for the image
+    generation.
+    """

src/openai/types/image_gen_completed_event.py

@@ -14,16 +14,16 @@ class ImageGenerateParamsBase(TypedDict, total=False):
     prompt: Required[str]
     """A text description of the desired image(s).
 
-    The maximum length is 32000 characters for `gpt-image-1`, 1000 characters for
-    `dall-e-2` and 4000 characters for `dall-e-3`.
+    The maximum length is 32000 characters for the GPT image models, 1000 characters
+    for `dall-e-2` and 4000 characters for `dall-e-3`.
     """
 
     background: Optional[Literal["transparent", "opaque", "auto"]]
     """
     Allows to set transparency for the background of the generated image(s). This
-    parameter is only supported for `gpt-image-1`. Must be one of `transparent`,
-    `opaque` or `auto` (default value). When `auto` is used, the model will
-    automatically determine the best background for the image.
+    parameter is only supported for the GPT image models. Must be one of
+    `transparent`, `opaque` or `auto` (default value). When `auto` is used, the
+    model will automatically determine the best background for the image.
 
     If `transparent`, the output format needs to support transparency, so it should
     be set to either `png` (default value) or `webp`.
@@ -32,14 +32,16 @@ class ImageGenerateParamsBase(TypedDict, total=False):
     model: Union[str, ImageModel, None]
     """The model to use for image generation.
 
-    One of `dall-e-2`, `dall-e-3`, or `gpt-image-1`. Defaults to `dall-e-2` unless a
-    parameter specific to `gpt-image-1` is used.
+    One of `dall-e-2`, `dall-e-3`, or a GPT image model (`gpt-image-1`,
+    `gpt-image-1-mini`, `gpt-image-1.5`). Defaults to `dall-e-2` unless a parameter
+    specific to the GPT image models is used.
     """
 
     moderation: Optional[Literal["low", "auto"]]
-    """Control the content-moderation level for images generated by `gpt-image-1`.
-
-    Must be either `low` for less restrictive filtering or `auto` (default value).
+    """
+    Control the content-moderation level for images generated by the GPT image
+    models. Must be either `low` for less restrictive filtering or `auto` (default
+    value).
     """
 
     n: Optional[int]
@@ -51,14 +53,14 @@ class ImageGenerateParamsBase(TypedDict, total=False):
     output_compression: Optional[int]
     """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, and defaults to 100.
+    This parameter is only supported for the GPT image models with the `webp` or
+    `jpeg` output formats, and defaults to 100.
     """
 
     output_format: Optional[Literal["png", "jpeg", "webp"]]
     """The format in which the generated images are returned.
 
-    This parameter is only supported for `gpt-image-1`. Must be one of `png`,
+    This parameter is only supported for the GPT image models. Must be one of `png`,
     `jpeg`, or `webp`.
     """
 
@@ -78,7 +80,7 @@ class ImageGenerateParamsBase(TypedDict, total=False):
 
     - `auto` (default value) will automatically select the best quality for the
       given model.
-    - `high`, `medium` and `low` are supported for `gpt-image-1`.
+    - `high`, `medium` and `low` are supported for the GPT image models.
     - `hd` and `standard` are supported for `dall-e-3`.
     - `standard` is the only option for `dall-e-2`.
     """
@@ -88,8 +90,8 @@ class ImageGenerateParamsBase(TypedDict, total=False):
     returned.
 
     Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the
-    image has been generated. This parameter isn't supported for `gpt-image-1` which
-    will always return base64-encoded images.
+    image has been generated. This parameter isn't supported for the GPT image
+    models, which always return base64-encoded images.
     """
 
     size: Optional[
@@ -98,7 +100,7 @@ class ImageGenerateParamsBase(TypedDict, total=False):
     """The size of the generated images.
 
     Must be one of `1024x1024`, `1536x1024` (landscape), `1024x1536` (portrait), or
-    `auto` (default value) for `gpt-image-1`, one of `256x256`, `512x512`, or
+    `auto` (default value) for the GPT image models, one of `256x256`, `512x512`, or
     `1024x1024` for `dall-e-2`, and one of `1024x1024`, `1792x1024`, or `1024x1792`
     for `dall-e-3`.
     """
@@ -126,7 +128,7 @@ class ImageGenerateParamsNonStreaming(ImageGenerateParamsBase, total=False):
 
     Defaults to `false`. See the
     [Image generation guide](https://platform.openai.com/docs/guides/image-generation)
-    for more information. This parameter is only supported for `gpt-image-1`.
+    for more information. This parameter is only supported for the GPT image models.
     """
 
 
@@ -136,7 +138,7 @@ class ImageGenerateParamsStreaming(ImageGenerateParamsBase):
 
     Defaults to `false`. See the
     [Image generation guide](https://platform.openai.com/docs/guides/image-generation)
-    for more information. This parameter is only supported for `gpt-image-1`.
+    for more information. This parameter is only supported for the GPT image models.
     """
 
 

src/openai/types/image_generate_params.py

@@ -4,4 +4,4 @@
 
 __all__ = ["ImageModel"]
 
-ImageModel: TypeAlias = Literal["dall-e-2", "dall-e-3", "gpt-image-1", "gpt-image-1-mini"]
+ImageModel: TypeAlias = Literal["gpt-image-1.5", "dall-e-2", "dall-e-3", "gpt-image-1", "gpt-image-1-mini"]

src/openai/types/image_model.py

@@ -6,7 +6,7 @@
 from .image import Image
 from .._models import BaseModel
 
-__all__ = ["ImagesResponse", "Usage", "UsageInputTokensDetails"]
+__all__ = ["ImagesResponse", "Usage", "UsageInputTokensDetails", "UsageOutputTokensDetails"]
 
 
 class UsageInputTokensDetails(BaseModel):
@@ -19,6 +19,16 @@ class UsageInputTokensDetails(BaseModel):
     """The number of text tokens in the input prompt."""
 
 
+class UsageOutputTokensDetails(BaseModel):
+    """The output token details for the image generation."""
+
+    image_tokens: int
+    """The number of image output tokens generated by the model."""
+
+    text_tokens: int
+    """The number of text output tokens generated by the model."""
+
+
 class Usage(BaseModel):
     """For `gpt-image-1` only, the token usage information for the image generation."""
 
@@ -34,6 +44,9 @@ class Usage(BaseModel):
     total_tokens: int
     """The total number of tokens (images and text) used for the image generation."""
 
+    output_tokens_details: Optional[UsageOutputTokensDetails] = None
+    """The output token details for the image generation."""
+
 
 class ImagesResponse(BaseModel):
     """The response from the image generation endpoint."""

src/openai/types/images_response.py

@@ -221,7 +221,7 @@ class ImageGenerationInputImageMask(BaseModel):
 
 
 class ImageGeneration(BaseModel):
-    """A tool that generates images using a model like `gpt-image-1`."""
+    """A tool that generates images using the GPT image models."""
 
     type: Literal["image_generation"]
     """The type of the image generation tool. Always `image_generation`."""
@@ -246,7 +246,7 @@ class ImageGeneration(BaseModel):
     Contains `image_url` (string, optional) and `file_id` (string, optional).
     """
 
-    model: Optional[Literal["gpt-image-1", "gpt-image-1-mini"]] = None
+    model: Union[str, Literal["gpt-image-1", "gpt-image-1-mini"], None] = None
     """The image generation model to use. Default: `gpt-image-1`."""
 
     moderation: Optional[Literal["auto", "low"]] = None