openai 0.39.0 → 0.41.0

data/rbi/openai/models/image_generate_params.rbi

@@ -12,15 +12,15 @@ module OpenAI
         end
 
       # 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`.
+      # characters for the GPT image models, 1000 characters for `dall-e-2` and 4000
+      # characters for `dall-e-3`.
       sig { returns(String) }
       attr_accessor :prompt
 
       # 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`.
@@ -29,14 +29,15 @@ module OpenAI
       end
       attr_accessor :background
 
-      # 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.
+      # The model to use for image generation. 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.
       sig { returns(T.nilable(T.any(String, OpenAI::ImageModel::OrSymbol))) }
       attr_accessor :model
 
-      # 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).
       sig do
         returns(T.nilable(OpenAI::ImageGenerateParams::Moderation::OrSymbol))
       end
@@ -48,13 +49,13 @@ module OpenAI
       attr_accessor :n
 
       # 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
+      # supported for the GPT image models with the `webp` or `jpeg` output formats, and
       # defaults to 100.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :output_compression
 
       # The format in which the generated images are returned. This parameter is only
-      # supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`.
+      # supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`.
       sig do
         returns(T.nilable(OpenAI::ImageGenerateParams::OutputFormat::OrSymbol))
       end
@@ -73,7 +74,7 @@ module OpenAI
       #
       # - `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`.
       sig { returns(T.nilable(OpenAI::ImageGenerateParams::Quality::OrSymbol)) }
@@ -81,8 +82,8 @@ module OpenAI
 
       # The format in which generated images with `dall-e-2` and `dall-e-3` 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 isn't supported for
-      # `gpt-image-1` which will always return base64-encoded images.
+      # after the image has been generated. This parameter isn't supported for the GPT
+      # image models, which always return base64-encoded images.
       sig do
         returns(
           T.nilable(OpenAI::ImageGenerateParams::ResponseFormat::OrSymbol)
@@ -91,9 +92,9 @@ module OpenAI
       attr_accessor :response_format
 
       # 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 `1024x1024` for `dall-e-2`, and
-      # one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3`.
+      # (landscape), `1024x1536` (portrait), 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`.
       sig { returns(T.nilable(OpenAI::ImageGenerateParams::Size::OrSymbol)) }
       attr_accessor :size
 
@@ -137,33 +138,34 @@ module OpenAI
       end
       def self.new(
         # 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`.
+        # characters for the GPT image models, 1000 characters for `dall-e-2` and 4000
+        # characters for `dall-e-3`.
         prompt:,
         # 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`.
         background: nil,
-        # 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.
+        # The model to use for image generation. 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.
         model: nil,
-        # 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).
         moderation: nil,
         # The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
         # `n=1` is supported.
         n: nil,
         # 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
+        # supported for the GPT image models with the `webp` or `jpeg` output formats, and
         # defaults to 100.
         output_compression: nil,
         # The format in which the generated images are returned. This parameter is only
-        # supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`.
+        # supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`.
         output_format: nil,
         # The number of partial images to generate. This parameter is used for streaming
         # responses that return partial images. Value must be between 0 and 3. When set to
@@ -176,19 +178,19 @@ module OpenAI
         #
         # - `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`.
         quality: nil,
         # The format in which generated images with `dall-e-2` and `dall-e-3` 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 isn't supported for
-        # `gpt-image-1` which will always return base64-encoded images.
+        # after the image has been generated. This parameter isn't supported for the GPT
+        # image models, which always return base64-encoded images.
         response_format: nil,
         # 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 `1024x1024` for `dall-e-2`, and
-        # one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3`.
+        # (landscape), `1024x1536` (portrait), 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`.
         size: nil,
         # The style of the generated images. This parameter is only supported for
         # `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean
@@ -231,9 +233,9 @@ module OpenAI
       end
 
       # 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`.
@@ -265,9 +267,9 @@ module OpenAI
         end
       end
 
-      # 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.
+      # The model to use for image generation. 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.
       module Model
         extend OpenAI::Internal::Type::Union
 
@@ -283,8 +285,9 @@ module OpenAI
         end
       end
 
-      # 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).
       module Moderation
         extend OpenAI::Internal::Type::Enum
 
@@ -308,7 +311,7 @@ module OpenAI
       end
 
       # The format in which the generated images are returned. This parameter is only
-      # supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`.
+      # supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`.
       module OutputFormat
         extend OpenAI::Internal::Type::Enum
 
@@ -338,7 +341,7 @@ module OpenAI
       #
       # - `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`.
       module Quality
@@ -368,8 +371,8 @@ module OpenAI
 
       # The format in which generated images with `dall-e-2` and `dall-e-3` 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 isn't supported for
-      # `gpt-image-1` which will always return base64-encoded images.
+      # after the image has been generated. This parameter isn't supported for the GPT
+      # image models, which always return base64-encoded images.
       module ResponseFormat
         extend OpenAI::Internal::Type::Enum
 
@@ -397,9 +400,9 @@ module OpenAI
       end
 
       # 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 `1024x1024` for `dall-e-2`, and
-      # one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3`.
+      # (landscape), `1024x1536` (portrait), 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`.
       module Size
         extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/image_model.rbi

@@ -8,6 +8,7 @@ module OpenAI
       TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::ImageModel) }
       OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+      GPT_IMAGE_1_5 = T.let(:"gpt-image-1.5", OpenAI::ImageModel::TaggedSymbol)
       DALL_E_2 = T.let(:"dall-e-2", OpenAI::ImageModel::TaggedSymbol)
       DALL_E_3 = T.let(:"dall-e-3", OpenAI::ImageModel::TaggedSymbol)
       GPT_IMAGE_1 = T.let(:"gpt-image-1", OpenAI::ImageModel::TaggedSymbol)

data/rbi/openai/models/images_response.rbi

@@ -232,6 +232,20 @@ module OpenAI
         sig { returns(Integer) }
         attr_accessor :total_tokens
 
+        # The output token details for the image generation.
+        sig do
+          returns(T.nilable(OpenAI::ImagesResponse::Usage::OutputTokensDetails))
+        end
+        attr_reader :output_tokens_details
+
+        sig do
+          params(
+            output_tokens_details:
+              OpenAI::ImagesResponse::Usage::OutputTokensDetails::OrHash
+          ).void
+        end
+        attr_writer :output_tokens_details
+
         # For `gpt-image-1` only, the token usage information for the image generation.
         sig do
           params(
@@ -239,7 +253,9 @@ module OpenAI
             input_tokens_details:
               OpenAI::ImagesResponse::Usage::InputTokensDetails::OrHash,
             output_tokens: Integer,
-            total_tokens: Integer
+            total_tokens: Integer,
+            output_tokens_details:
+              OpenAI::ImagesResponse::Usage::OutputTokensDetails::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -250,7 +266,9 @@ module OpenAI
           # The number of output tokens generated by the model.
           output_tokens:,
           # The total number of tokens (images and text) used for the image generation.
-          total_tokens:
+          total_tokens:,
+          # The output token details for the image generation.
+          output_tokens_details: nil
         )
         end
 
@@ -261,7 +279,9 @@ module OpenAI
               input_tokens_details:
                 OpenAI::ImagesResponse::Usage::InputTokensDetails,
               output_tokens: Integer,
-              total_tokens: Integer
+              total_tokens: Integer,
+              output_tokens_details:
+                OpenAI::ImagesResponse::Usage::OutputTokensDetails
             }
           )
         end
@@ -305,6 +325,44 @@ module OpenAI
           def to_hash
           end
         end
+
+        class OutputTokensDetails < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::ImagesResponse::Usage::OutputTokensDetails,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The number of image output tokens generated by the model.
+          sig { returns(Integer) }
+          attr_accessor :image_tokens
+
+          # The number of text output tokens generated by the model.
+          sig { returns(Integer) }
+          attr_accessor :text_tokens
+
+          # The output token details for the image generation.
+          sig do
+            params(image_tokens: Integer, text_tokens: Integer).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The number of image output tokens generated by the model.
+            image_tokens:,
+            # The number of text output tokens generated by the model.
+            text_tokens:
+          )
+          end
+
+          sig do
+            override.returns({ image_tokens: Integer, text_tokens: Integer })
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/openai/models/responses/tool.rbi

@@ -888,7 +888,10 @@ module OpenAI
           sig do
             returns(
               T.nilable(
-                OpenAI::Responses::Tool::ImageGeneration::Model::OrSymbol
+                T.any(
+                  String,
+                  OpenAI::Responses::Tool::ImageGeneration::Model::OrSymbol
+                )
               )
             )
           end
@@ -896,7 +899,11 @@ module OpenAI
 
           sig do
             params(
-              model: OpenAI::Responses::Tool::ImageGeneration::Model::OrSymbol
+              model:
+                T.any(
+                  String,
+                  OpenAI::Responses::Tool::ImageGeneration::Model::OrSymbol
+                )
             ).void
           end
           attr_writer :model
@@ -990,7 +997,7 @@ module OpenAI
           end
           attr_writer :size
 
-          # A tool that generates images using a model like `gpt-image-1`.
+          # A tool that generates images using the GPT image models.
           sig do
             params(
               background:
@@ -1001,7 +1008,11 @@ module OpenAI
                 ),
               input_image_mask:
                 OpenAI::Responses::Tool::ImageGeneration::InputImageMask::OrHash,
-              model: OpenAI::Responses::Tool::ImageGeneration::Model::OrSymbol,
+              model:
+                T.any(
+                  String,
+                  OpenAI::Responses::Tool::ImageGeneration::Model::OrSymbol
+                ),
               moderation:
                 OpenAI::Responses::Tool::ImageGeneration::Moderation::OrSymbol,
               output_compression: Integer,
@@ -1062,7 +1073,10 @@ module OpenAI
                 input_image_mask:
                   OpenAI::Responses::Tool::ImageGeneration::InputImageMask,
                 model:
-                  OpenAI::Responses::Tool::ImageGeneration::Model::OrSymbol,
+                  T.any(
+                    String,
+                    OpenAI::Responses::Tool::ImageGeneration::Model::OrSymbol
+                  ),
                 moderation:
                   OpenAI::Responses::Tool::ImageGeneration::Moderation::OrSymbol,
                 output_compression: Integer,
@@ -1202,7 +1216,25 @@ module OpenAI
 
           # The image generation model to use. Default: `gpt-image-1`.
           module Model
-            extend OpenAI::Internal::Type::Enum
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  String,
+                  OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::Tool::ImageGeneration::Model::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
 
             TaggedSymbol =
               T.type_alias do
@@ -1220,16 +1252,6 @@ module OpenAI
                 :"gpt-image-1-mini",
                 OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
               )
-
-            sig do
-              override.returns(
-                T::Array[
-                  OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
           end
 
           # Moderation level for the generated image. Default: `auto`.

data/rbi/openai/models/video_model.rbi

@@ -10,6 +10,12 @@ module OpenAI
 
       SORA_2 = T.let(:"sora-2", OpenAI::VideoModel::TaggedSymbol)
       SORA_2_PRO = T.let(:"sora-2-pro", OpenAI::VideoModel::TaggedSymbol)
+      SORA_2_2025_10_06 =
+        T.let(:"sora-2-2025-10-06", OpenAI::VideoModel::TaggedSymbol)
+      SORA_2_PRO_2025_10_06 =
+        T.let(:"sora-2-pro-2025-10-06", OpenAI::VideoModel::TaggedSymbol)
+      SORA_2_2025_12_08 =
+        T.let(:"sora-2-2025-12-08", OpenAI::VideoModel::TaggedSymbol)
 
       sig { override.returns(T::Array[OpenAI::VideoModel::TaggedSymbol]) }
       def self.values