openai 0.13.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a91e66a63e35f1e79017e4e2270ff4d5792d7e7def4d703afc6f12817b8ea728
-  data.tar.gz: 7be53dbd53923afcbf0754423182d8d8d8795458974c6a449d72178ce807377e
+  metadata.gz: e15e098317bf9151fffc0d83be9fd3ead36872a58ea53628f2d0dd3028735c78
+  data.tar.gz: 04a779ac9f0b4418138bf4a7216e01109e48d608d76c33fc83f76e9de82d574e
 SHA512:
-  metadata.gz: 7dd389f0f8d5d978dbf4ac02696b97b874abcd31f1095ce5eef44cdb19282f910a6bda9941d4502be90181850bbddb6d999d88ed05def140efa762454e068999
-  data.tar.gz: 8e4fbbc22ceb381a8fd83e3899e7440661dc41914fa140c264b7338141e4bbb5dc9d8f4ee14d6c9e68cef995aad053b730ea0d127923201e049ef16b42c94dc8
+  metadata.gz: d3673d18e0d3cfcd0db2ddc4c9c45bc6da8dd86371a38d85f7ad181f45780e6a17b48b9478e621c47a17c1708a2ec775ae8b61c0f6eb39c6b9d6686e09edfb65
+  data.tar.gz: a7fc556be0b4ba6ea16e6a2ba37bb0e9f62c2f7e39344a372b02b4c54b752e5718e15bfea4ffd8c277dd8db4f6d19530dc29e1ee5aee3fb2fc9a253269944b8f

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 0.15.0 (2025-07-21)
+
+Full Changelog: [v0.14.0...v0.15.0](https://github.com/openai/openai-ruby/compare/v0.14.0...v0.15.0)
+
+### Features
+
+* **api:** manual updates ([fb53071](https://github.com/openai/openai-ruby/commit/fb530713d08a4ba49e8bdaecd9848674bb35c333))
+
+
+### Bug Fixes
+
+* **internal:** tests should use normalized property names ([801e9c2](https://github.com/openai/openai-ruby/commit/801e9c29f65e572a3b49f5cf7891d3053e1d087f))
+
+
+### Chores
+
+* **api:** event shapes more accurate ([29f32ce](https://github.com/openai/openai-ruby/commit/29f32cedf6112d38fe8de454658a5afd7ad0d2cb))
+
+## 0.14.0 (2025-07-16)
+
+Full Changelog: [v0.13.1...v0.14.0](https://github.com/openai/openai-ruby/compare/v0.13.1...v0.14.0)
+
+### Features
+
+* **api:** manual updates ([b749baf](https://github.com/openai/openai-ruby/commit/b749baf0d1b52c35ff6e50b889301aa7b8ee2ba1))
+
 ## 0.13.1 (2025-07-15)
 
 Full Changelog: [v0.13.0...v0.13.1](https://github.com/openai/openai-ruby/compare/v0.13.0...v0.13.1)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openai", "~> 0.13.1"
+gem "openai", "~> 0.15.0"
 ```
 
 <!-- x-release-please-end -->
@@ -443,7 +443,7 @@ You can provide typesafe request parameters like so:
 
 ```ruby
 openai.chat.completions.create(
-  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
+  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(content: "Say this is a test")],
   model: :"gpt-4.1"
 )
 ```
@@ -459,7 +459,7 @@ openai.chat.completions.create(
 
 # You can also splat a full Params class:
 params = OpenAI::Chat::CompletionCreateParams.new(
-  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
+  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(content: "Say this is a test")],
   model: :"gpt-4.1"
 )
 openai.chat.completions.create(**params)

data/lib/openai/models/audio/speech_create_params.rb

@@ -111,12 +111,6 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::ECHO }
 
-          variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::FABLE }
-
-          variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::ONYX }
-
-          variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::NOVA }
-
           variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::SAGE }
 
           variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::SHIMMER }
@@ -137,9 +131,6 @@ module OpenAI
           BALLAD = :ballad
           CORAL = :coral
           ECHO = :echo
-          FABLE = :fable
-          ONYX = :onyx
-          NOVA = :nova
           SAGE = :sage
           SHIMMER = :shimmer
           VERSE = :verse

data/lib/openai/models/chat/chat_completion.rb

@@ -44,7 +44,7 @@ module OpenAI
         #   - If set to 'auto', then the request will be processed with the service tier
         #     configured in the Project settings. Unless otherwise configured, the Project
         #     will use 'default'.
-        #   - If set to 'default', then the requset will be processed with the standard
+        #   - If set to 'default', then the request will be processed with the standard
         #     pricing and performance for the selected model.
         #   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #     'priority', then the request will be processed with the corresponding service
@@ -193,7 +193,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/lib/openai/models/chat/chat_completion_audio_param.rb

@@ -67,12 +67,6 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::ECHO }
 
-          variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::FABLE }
-
-          variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::ONYX }
-
-          variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::NOVA }
-
           variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::SAGE }
 
           variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::SHIMMER }
@@ -93,9 +87,6 @@ module OpenAI
           BALLAD = :ballad
           CORAL = :coral
           ECHO = :echo
-          FABLE = :fable
-          ONYX = :onyx
-          NOVA = :nova
           SAGE = :sage
           SHIMMER = :shimmer
           VERSE = :verse

data/lib/openai/models/chat/chat_completion_chunk.rb

@@ -43,7 +43,7 @@ module OpenAI
         #   - If set to 'auto', then the request will be processed with the service tier
         #     configured in the Project settings. Unless otherwise configured, the Project
         #     will use 'default'.
-        #   - If set to 'default', then the requset will be processed with the standard
+        #   - If set to 'default', then the request will be processed with the standard
         #     pricing and performance for the selected model.
         #   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #     'priority', then the request will be processed with the corresponding service
@@ -376,7 +376,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/lib/openai/models/chat/completion_create_params.rb

@@ -224,7 +224,7 @@ module OpenAI
         #   - If set to 'auto', then the request will be processed with the service tier
         #     configured in the Project settings. Unless otherwise configured, the Project
         #     will use 'default'.
-        #   - If set to 'default', then the requset will be processed with the standard
+        #   - If set to 'default', then the request will be processed with the standard
         #     pricing and performance for the selected model.
         #   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #     'priority', then the request will be processed with the corresponding service
@@ -553,7 +553,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/lib/openai/models/function_definition.rb

@@ -34,7 +34,7 @@ module OpenAI
       #   set to true, the model will follow the exact schema defined in the `parameters`
       #   field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn
       #   more about Structured Outputs in the
-      #   [function calling guide](docs/guides/function-calling).
+      #   [function calling guide](https://platform.openai.com/docs/guides/function-calling).
       #
       #   @return [Boolean, nil]
       optional :strict, OpenAI::Internal::Type::Boolean, nil?: true

data/lib/openai/models/image_edit_completed_event.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    class ImageEditCompletedEvent < OpenAI::Internal::Type::BaseModel
+      # @!attribute b64_json
+      #   Base64-encoded final edited image data, suitable for rendering as an image.
+      #
+      #   @return [String]
+      required :b64_json, String
+
+      # @!attribute background
+      #   The background setting for the edited image.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditCompletedEvent::Background]
+      required :background, enum: -> { OpenAI::ImageEditCompletedEvent::Background }
+
+      # @!attribute created_at
+      #   The Unix timestamp when the event was created.
+      #
+      #   @return [Integer]
+      required :created_at, Integer
+
+      # @!attribute output_format
+      #   The output format for the edited image.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditCompletedEvent::OutputFormat]
+      required :output_format, enum: -> { OpenAI::ImageEditCompletedEvent::OutputFormat }
+
+      # @!attribute quality
+      #   The quality setting for the edited image.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditCompletedEvent::Quality]
+      required :quality, enum: -> { OpenAI::ImageEditCompletedEvent::Quality }
+
+      # @!attribute size
+      #   The size of the edited image.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditCompletedEvent::Size]
+      required :size, enum: -> { OpenAI::ImageEditCompletedEvent::Size }
+
+      # @!attribute type
+      #   The type of the event. Always `image_edit.completed`.
+      #
+      #   @return [Symbol, :"image_edit.completed"]
+      required :type, const: :"image_edit.completed"
+
+      # @!attribute usage
+      #   For `gpt-image-1` only, the token usage information for the image generation.
+      #
+      #   @return [OpenAI::Models::ImageEditCompletedEvent::Usage]
+      required :usage, -> { OpenAI::ImageEditCompletedEvent::Usage }
+
+      # @!method initialize(b64_json:, background:, created_at:, output_format:, quality:, size:, usage:, type: :"image_edit.completed")
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::ImageEditCompletedEvent} for more details.
+      #
+      #   Emitted when image editing has completed and the final image is available.
+      #
+      #   @param b64_json [String] Base64-encoded final edited image data, suitable for rendering as an image.
+      #
+      #   @param background [Symbol, OpenAI::Models::ImageEditCompletedEvent::Background] The background setting for the edited image.
+      #
+      #   @param created_at [Integer] The Unix timestamp when the event was created.
+      #
+      #   @param output_format [Symbol, OpenAI::Models::ImageEditCompletedEvent::OutputFormat] The output format for the edited image.
+      #
+      #   @param quality [Symbol, OpenAI::Models::ImageEditCompletedEvent::Quality] The quality setting for the edited image.
+      #
+      #   @param size [Symbol, OpenAI::Models::ImageEditCompletedEvent::Size] The size of the edited image.
+      #
+      #   @param usage [OpenAI::Models::ImageEditCompletedEvent::Usage] For `gpt-image-1` only, the token usage information for the image generation.
+      #
+      #   @param type [Symbol, :"image_edit.completed"] The type of the event. Always `image_edit.completed`.
+
+      # The background setting for the edited image.
+      #
+      # @see OpenAI::Models::ImageEditCompletedEvent#background
+      module Background
+        extend OpenAI::Internal::Type::Enum
+
+        TRANSPARENT = :transparent
+        OPAQUE = :opaque
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The output format for the edited image.
+      #
+      # @see OpenAI::Models::ImageEditCompletedEvent#output_format
+      module OutputFormat
+        extend OpenAI::Internal::Type::Enum
+
+        PNG = :png
+        WEBP = :webp
+        JPEG = :jpeg
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The quality setting for the edited image.
+      #
+      # @see OpenAI::Models::ImageEditCompletedEvent#quality
+      module Quality
+        extend OpenAI::Internal::Type::Enum
+
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The size of the edited image.
+      #
+      # @see OpenAI::Models::ImageEditCompletedEvent#size
+      module Size
+        extend OpenAI::Internal::Type::Enum
+
+        SIZE_1024X1024 = :"1024x1024"
+        SIZE_1024X1536 = :"1024x1536"
+        SIZE_1536X1024 = :"1536x1024"
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see OpenAI::Models::ImageEditCompletedEvent#usage
+      class Usage < OpenAI::Internal::Type::BaseModel
+        # @!attribute input_tokens
+        #   The number of tokens (images and text) in the input prompt.
+        #
+        #   @return [Integer]
+        required :input_tokens, Integer
+
+        # @!attribute input_tokens_details
+        #   The input tokens detailed information for the image generation.
+        #
+        #   @return [OpenAI::Models::ImageEditCompletedEvent::Usage::InputTokensDetails]
+        required :input_tokens_details, -> { OpenAI::ImageEditCompletedEvent::Usage::InputTokensDetails }
+
+        # @!attribute output_tokens
+        #   The number of image tokens in the output image.
+        #
+        #   @return [Integer]
+        required :output_tokens, Integer
+
+        # @!attribute total_tokens
+        #   The total number of tokens (images and text) used for the image generation.
+        #
+        #   @return [Integer]
+        required :total_tokens, Integer
+
+        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, total_tokens:)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::ImageEditCompletedEvent::Usage} for more details.
+        #
+        #   For `gpt-image-1` only, the token usage information for the image generation.
+        #
+        #   @param input_tokens [Integer] The number of tokens (images and text) in the input prompt.
+        #
+        #   @param input_tokens_details [OpenAI::Models::ImageEditCompletedEvent::Usage::InputTokensDetails] The input tokens detailed information for the image generation.
+        #
+        #   @param output_tokens [Integer] The number of image tokens in the output image.
+        #
+        #   @param total_tokens [Integer] The total number of tokens (images and text) used for the image generation.
+
+        # @see OpenAI::Models::ImageEditCompletedEvent::Usage#input_tokens_details
+        class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute image_tokens
+          #   The number of image tokens in the input prompt.
+          #
+          #   @return [Integer]
+          required :image_tokens, Integer
+
+          # @!attribute text_tokens
+          #   The number of text tokens in the input prompt.
+          #
+          #   @return [Integer]
+          required :text_tokens, Integer
+
+          # @!method initialize(image_tokens:, text_tokens:)
+          #   The input tokens detailed information for the image generation.
+          #
+          #   @param image_tokens [Integer] The number of image tokens in the input prompt.
+          #
+          #   @param text_tokens [Integer] The number of text tokens in the input prompt.
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/image_edit_params.rb

@@ -3,6 +3,8 @@
 module OpenAI
   module Models
     # @see OpenAI::Resources::Images#edit
+    #
+    # @see OpenAI::Resources::Images#edit_stream_raw
     class ImageEditParams < OpenAI::Internal::Type::BaseModel
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
@@ -38,6 +40,14 @@ module OpenAI
       #   @return [Symbol, OpenAI::Models::ImageEditParams::Background, nil]
       optional :background, enum: -> { OpenAI::ImageEditParams::Background }, nil?: true
 
+      # @!attribute input_fidelity
+      #   Control how much effort the model will exert to match the style and features,
+      #   especially facial features, of input images. This parameter is only supported
+      #   for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
+      optional :input_fidelity, enum: -> { OpenAI::ImageEditParams::InputFidelity }, nil?: true
+
       # @!attribute mask
       #   An additional image whose fully transparent areas (e.g. where alpha is zero)
       #   indicate where `image` should be edited. If there are multiple images provided,
@@ -77,6 +87,17 @@ module OpenAI
       #   @return [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil]
       optional :output_format, enum: -> { OpenAI::ImageEditParams::OutputFormat }, nil?: true
 
+      # @!attribute partial_images
+      #   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
+      #   0, the response will be a single image sent in one streaming event.
+      #
+      #   Note that the final image may be sent before the full number of partial images
+      #   are generated if the full image is generated more quickly.
+      #
+      #   @return [Integer, nil]
+      optional :partial_images, Integer, nil?: true
+
       # @!attribute quality
       #   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.
@@ -110,7 +131,7 @@ module OpenAI
       #   @return [String, nil]
       optional :user, String
 
-      # @!method initialize(image:, prompt:, background: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
+      # @!method initialize(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {OpenAI::Models::ImageEditParams} for more details.
       #
@@ -120,6 +141,8 @@ module OpenAI
       #
       #   @param background [Symbol, OpenAI::Models::ImageEditParams::Background, nil] Allows to set transparency for the background of the generated image(s).
       #
+      #   @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil] Control how much effort the model will exert to match the style and features,
+      #
       #   @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart] An additional image whose fully transparent areas (e.g. where alpha is zero) ind
       #
       #   @param model [String, Symbol, OpenAI::Models::ImageModel, nil] The model to use for image generation. Only `dall-e-2` and `gpt-image-1` are sup
@@ -130,6 +153,8 @@ module OpenAI
       #
       #   @param output_format [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil] The format in which the generated images are returned. This parameter is
       #
+      #   @param partial_images [Integer, nil] The number of partial images to generate. This parameter is used for
+      #
       #   @param quality [Symbol, OpenAI::Models::ImageEditParams::Quality, nil] The quality of the image that will be generated. `high`, `medium` and `low` are
       #
       #   @param response_format [Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil] The format in which the generated images are returned. Must be one of `url` or `
@@ -179,6 +204,19 @@ module OpenAI
         #   @return [Array<Symbol>]
       end
 
+      # Control how much effort the model will exert to match the style and features,
+      # especially facial features, of input images. This parameter is only supported
+      # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
+      module InputFidelity
+        extend OpenAI::Internal::Type::Enum
+
+        HIGH = :high
+        LOW = :low
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # 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.

data/lib/openai/models/image_edit_partial_image_event.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    class ImageEditPartialImageEvent < OpenAI::Internal::Type::BaseModel
+      # @!attribute b64_json
+      #   Base64-encoded partial image data, suitable for rendering as an image.
+      #
+      #   @return [String]
+      required :b64_json, String
+
+      # @!attribute background
+      #   The background setting for the requested edited image.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditPartialImageEvent::Background]
+      required :background, enum: -> { OpenAI::ImageEditPartialImageEvent::Background }
+
+      # @!attribute created_at
+      #   The Unix timestamp when the event was created.
+      #
+      #   @return [Integer]
+      required :created_at, Integer
+
+      # @!attribute output_format
+      #   The output format for the requested edited image.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditPartialImageEvent::OutputFormat]
+      required :output_format, enum: -> { OpenAI::ImageEditPartialImageEvent::OutputFormat }
+
+      # @!attribute partial_image_index
+      #   0-based index for the partial image (streaming).
+      #
+      #   @return [Integer]
+      required :partial_image_index, Integer
+
+      # @!attribute quality
+      #   The quality setting for the requested edited image.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditPartialImageEvent::Quality]
+      required :quality, enum: -> { OpenAI::ImageEditPartialImageEvent::Quality }
+
+      # @!attribute size
+      #   The size of the requested edited image.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageEditPartialImageEvent::Size]
+      required :size, enum: -> { OpenAI::ImageEditPartialImageEvent::Size }
+
+      # @!attribute type
+      #   The type of the event. Always `image_edit.partial_image`.
+      #
+      #   @return [Symbol, :"image_edit.partial_image"]
+      required :type, const: :"image_edit.partial_image"
+
+      # @!method initialize(b64_json:, background:, created_at:, output_format:, partial_image_index:, quality:, size:, type: :"image_edit.partial_image")
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::ImageEditPartialImageEvent} for more details.
+      #
+      #   Emitted when a partial image is available during image editing streaming.
+      #
+      #   @param b64_json [String] Base64-encoded partial image data, suitable for rendering as an image.
+      #
+      #   @param background [Symbol, OpenAI::Models::ImageEditPartialImageEvent::Background] The background setting for the requested edited image.
+      #
+      #   @param created_at [Integer] The Unix timestamp when the event was created.
+      #
+      #   @param output_format [Symbol, OpenAI::Models::ImageEditPartialImageEvent::OutputFormat] The output format for the requested edited image.
+      #
+      #   @param partial_image_index [Integer] 0-based index for the partial image (streaming).
+      #
+      #   @param quality [Symbol, OpenAI::Models::ImageEditPartialImageEvent::Quality] The quality setting for the requested edited image.
+      #
+      #   @param size [Symbol, OpenAI::Models::ImageEditPartialImageEvent::Size] The size of the requested edited image.
+      #
+      #   @param type [Symbol, :"image_edit.partial_image"] The type of the event. Always `image_edit.partial_image`.
+
+      # The background setting for the requested edited image.
+      #
+      # @see OpenAI::Models::ImageEditPartialImageEvent#background
+      module Background
+        extend OpenAI::Internal::Type::Enum
+
+        TRANSPARENT = :transparent
+        OPAQUE = :opaque
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The output format for the requested edited image.
+      #
+      # @see OpenAI::Models::ImageEditPartialImageEvent#output_format
+      module OutputFormat
+        extend OpenAI::Internal::Type::Enum
+
+        PNG = :png
+        WEBP = :webp
+        JPEG = :jpeg
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The quality setting for the requested edited image.
+      #
+      # @see OpenAI::Models::ImageEditPartialImageEvent#quality
+      module Quality
+        extend OpenAI::Internal::Type::Enum
+
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The size of the requested edited image.
+      #
+      # @see OpenAI::Models::ImageEditPartialImageEvent#size
+      module Size
+        extend OpenAI::Internal::Type::Enum
+
+        SIZE_1024X1024 = :"1024x1024"
+        SIZE_1024X1536 = :"1024x1536"
+        SIZE_1536X1024 = :"1536x1024"
+        AUTO = :auto
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/openai/models/image_edit_stream_event.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # Emitted when a partial image is available during image editing streaming.
+    module ImageEditStreamEvent
+      extend OpenAI::Internal::Type::Union
+
+      discriminator :type
+
+      # Emitted when a partial image is available during image editing streaming.
+      variant :"image_edit.partial_image", -> { OpenAI::ImageEditPartialImageEvent }
+
+      # Emitted when image editing has completed and the final image is available.
+      variant :"image_edit.completed", -> { OpenAI::ImageEditCompletedEvent }
+
+      # @!method self.variants
+      #   @return [Array(OpenAI::Models::ImageEditPartialImageEvent, OpenAI::Models::ImageEditCompletedEvent)]
+    end
+  end
+end