openai 0.40.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7d3fa33fc7b7cd7b59f12b53967c300bf8951a24657ae8a80d560804905c520
-  data.tar.gz: 16955aee998d2e8d310dd9348a35f888ad346d241120584fbf8b583084a190c2
+  metadata.gz: 827bd4115ede761270037faa16dc64fe6082a23af8c31f9e0c52cb7d384b7b47
+  data.tar.gz: f9f51366eb2e4e2218677f06af68c9e075aa17eced0fbb51696672df9dcb504e
 SHA512:
-  metadata.gz: e27284ea9d7ed3d61e63afe59b5f703c3fd48ad8d1d58023aa0eec87c963b0865764bee39f16815292a590eb2b6a760dd51b2550e4007313dce88706352b1e4f
-  data.tar.gz: f963d77af8f89595daade1e3c054ef57d79d46d1ea2b69900dd501b1ea2b12c42f39706029e728197e4eddb63ceb1860c83226077c7a52c90ab29e52e8fc48e9
+  metadata.gz: e74d83fab6b6609be2d2898f275076823f6634f2e447c122b3ef8ab70c8f6d65f743e3f99e0e113ab118b2a9e6b6c3e29b861ba614220e22afd5c204f8a8caa3
+  data.tar.gz: 0ba69a2dfdd8e87b6933b8349d8368ecdc3519129315b8f6cd7f906e16b85bad1a02ce78fe3ee4834399657e8f534283533c411103fe0ebf8d30d34111c4b303

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.41.0 (2025-12-16)
+
+Full Changelog: [v0.40.0...v0.41.0](https://github.com/openai/openai-ruby/compare/v0.40.0...v0.41.0)
+
+### Features
+
+* **api:** gpt-image-1.5 ([8a7fdb3](https://github.com/openai/openai-ruby/commit/8a7fdb3c5228f765a0e18f9bb1f8c9c24dcf037b))
+* **api:** manual updates for java ([3aeb38f](https://github.com/openai/openai-ruby/commit/3aeb38f958498574d2009da300d2d964206955e5))
+
+
+### Bug Fixes
+
+* **api:** manual updates for ruby build ([c142813](https://github.com/openai/openai-ruby/commit/c142813f8948131abe980ef919aade6ed10b7456))
+* calling `break` out of streams should be instantaneous ([7fc53db](https://github.com/openai/openai-ruby/commit/7fc53db685dfa10c64472a337e7093f20a2ea597))
+
 ## 0.40.0 (2025-12-13)
 
 Full Changelog: [v0.39.0...v0.40.0](https://github.com/openai/openai-ruby/compare/v0.39.0...v0.40.0)

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.40.0"
+gem "openai", "~> 0.41.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/openai/internal/transport/pooled_net_requester.rb

@@ -153,17 +153,19 @@ module OpenAI
                   end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
-                  conn.request(req) do |rsp|
-                    y << [req, rsp]
-                    break if finished
-
-                    rsp.read_body do |bytes|
-                      y << bytes.force_encoding(Encoding::BINARY)
-                      break if finished
-
-                      self.class.calibrate_socket_timeout(conn, deadline)
+                  ::Kernel.catch(:jump) do
+                    conn.request(req) do |rsp|
+                      y << [req, rsp]
+                      ::Kernel.throw(:jump) if finished
+
+                      rsp.read_body do |bytes|
+                        y << bytes.force_encoding(Encoding::BINARY)
+                        ::Kernel.throw(:jump) if finished
+
+                        self.class.calibrate_socket_timeout(conn, deadline)
+                      end
+                      eof = true
                     end
-                    eof = true
                   end
                 end
               ensure

data/lib/openai/models/graders/grader_input_item.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Graders
+      # A single content item: input text, output text, input image, or input audio.
+      module GraderInputItem
+        extend OpenAI::Internal::Type::Union
+
+        # A text input to the model.
+        variant String
+
+        # A text input to the model.
+        variant -> { OpenAI::Responses::ResponseInputText }
+
+        # A text output from the model.
+        variant -> { OpenAI::Graders::GraderInputItem::OutputText }
+
+        # An image input block used within EvalItem content arrays.
+        variant -> { OpenAI::Graders::GraderInputItem::InputImage }
+
+        # An audio input to the model.
+        variant -> { OpenAI::Responses::ResponseInputAudio }
+
+        class OutputText < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   The text output from the model.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The type of the output text. Always `output_text`.
+          #
+          #   @return [Symbol, :output_text]
+          required :type, const: :output_text
+
+          # @!method initialize(text:, type: :output_text)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Graders::GraderInputItem::OutputText} for more details.
+          #
+          #   A text output from the model.
+          #
+          #   @param text [String] The text output from the model.
+          #
+          #   @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
+        end
+
+        class InputImage < OpenAI::Internal::Type::BaseModel
+          # @!attribute image_url
+          #   The URL of the image input.
+          #
+          #   @return [String]
+          required :image_url, String
+
+          # @!attribute type
+          #   The type of the image input. Always `input_image`.
+          #
+          #   @return [Symbol, :input_image]
+          required :type, const: :input_image
+
+          # @!attribute detail
+          #   The detail level of the image to be sent to the model. One of `high`, `low`, or
+          #   `auto`. Defaults to `auto`.
+          #
+          #   @return [String, nil]
+          optional :detail, String
+
+          # @!method initialize(image_url:, detail: nil, type: :input_image)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Graders::GraderInputItem::InputImage} for more details.
+          #
+          #   An image input block used within EvalItem content arrays.
+          #
+          #   @param image_url [String] The URL of the image input.
+          #
+          #   @param detail [String] The detail level of the image to be sent to the model. One of `high`, `low`, or
+          #
+          #   @param type [Symbol, :input_image] The type of the image input. Always `input_image`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio)]
+      end
+    end
+  end
+end

data/lib/openai/models/graders/grader_inputs.rb

@@ -3,86 +3,6 @@
 module OpenAI
   module Models
     module Graders
-      # A single content item: input text, output text, input image, or input audio.
-      module GraderInputItem
-        extend OpenAI::Internal::Type::Union
-
-        # A text input to the model.
-        variant String
-
-        # A text input to the model.
-        variant -> { OpenAI::Responses::ResponseInputText }
-
-        # A text output from the model.
-        variant -> { OpenAI::Graders::GraderInputItem::OutputText }
-
-        # An image input block used within EvalItem content arrays.
-        variant -> { OpenAI::Graders::GraderInputItem::InputImage }
-
-        # An audio input to the model.
-        variant -> { OpenAI::Responses::ResponseInputAudio }
-
-        class OutputText < OpenAI::Internal::Type::BaseModel
-          # @!attribute text
-          #   The text output from the model.
-          #
-          #   @return [String]
-          required :text, String
-
-          # @!attribute type
-          #   The type of the output text. Always `output_text`.
-          #
-          #   @return [Symbol, :output_text]
-          required :type, const: :output_text
-
-          # @!method initialize(text:, type: :output_text)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Graders::GraderInputItem::OutputText} for more details.
-          #
-          #   A text output from the model.
-          #
-          #   @param text [String] The text output from the model.
-          #
-          #   @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
-        end
-
-        class InputImage < OpenAI::Internal::Type::BaseModel
-          # @!attribute image_url
-          #   The URL of the image input.
-          #
-          #   @return [String]
-          required :image_url, String
-
-          # @!attribute type
-          #   The type of the image input. Always `input_image`.
-          #
-          #   @return [Symbol, :input_image]
-          required :type, const: :input_image
-
-          # @!attribute detail
-          #   The detail level of the image to be sent to the model. One of `high`, `low`, or
-          #   `auto`. Defaults to `auto`.
-          #
-          #   @return [String, nil]
-          optional :detail, String
-
-          # @!method initialize(image_url:, detail: nil, type: :input_image)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Graders::GraderInputItem::InputImage} for more details.
-          #
-          #   An image input block used within EvalItem content arrays.
-          #
-          #   @param image_url [String] The URL of the image input.
-          #
-          #   @param detail [String] The detail level of the image to be sent to the model. One of `high`, `low`, or
-          #
-          #   @param type [Symbol, :input_image] The type of the image input. Always `input_image`.
-        end
-
-        # @!method self.variants
-        #   @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio)]
-      end
-
       # @type [OpenAI::Internal::Type::Converter]
       GraderInputs = OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Graders::GraderInputItem }]
     end

data/lib/openai/models/image.rb

@@ -4,9 +4,9 @@ module OpenAI
   module Models
     class Image < OpenAI::Internal::Type::BaseModel
       # @!attribute b64_json
-      #   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`.
+      #   The base64-encoded JSON of the generated image. 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`.
       #
       #   @return [String, nil]
       optional :b64_json, String
@@ -19,8 +19,8 @@ module OpenAI
 
       # @!attribute url
       #   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.
       #
       #   @return [String, nil]
       optional :url, String
@@ -31,7 +31,7 @@ module OpenAI
       #
       #   Represents the content or the URL of an image generated by the OpenAI API.
       #
-      #   @param b64_json [String] The base64-encoded JSON of the generated image. Default value for `gpt-image-1`,
+      #   @param b64_json [String] The base64-encoded JSON of the generated image. Returned by default for the GPT
       #
       #   @param revised_prompt [String] For `dall-e-3` only, the revised prompt that was used to generate the image.
       #

data/lib/openai/models/image_edit_completed_event.rb

@@ -46,7 +46,8 @@ module OpenAI
       required :type, const: :"image_edit.completed"
 
       # @!attribute 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.
       #
       #   @return [OpenAI::Models::ImageEditCompletedEvent::Usage]
       required :usage, -> { OpenAI::ImageEditCompletedEvent::Usage }
@@ -69,7 +70,7 @@ module OpenAI
       #
       #   @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 usage [OpenAI::Models::ImageEditCompletedEvent::Usage] For the GPT image models only, the token usage information for the image generat
       #
       #   @param type [Symbol, :"image_edit.completed"] The type of the event. Always `image_edit.completed`.
 
@@ -161,7 +162,8 @@ module OpenAI
         #   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.
+        #   For the GPT image models only, the token usage information for the image
+        #   generation.
         #
         #   @param input_tokens [Integer] The number of tokens (images and text) in the input prompt.
         #

data/lib/openai/models/image_edit_params.rb

@@ -12,7 +12,8 @@ module OpenAI
       # @!attribute image
       #   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`
@@ -23,16 +24,16 @@ module OpenAI
 
       # @!attribute prompt
       #   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`.
+      #   characters for `dall-e-2`, and 32000 characters for the GPT image models.
       #
       #   @return [String]
       required :prompt, String
 
       # @!attribute background
       #   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,9 +60,9 @@ module OpenAI
       optional :mask, OpenAI::Internal::Type::FileInput
 
       # @!attribute model
-      #   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.
+      #   The model to use for image generation. 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.
       #
       #   @return [String, Symbol, OpenAI::Models::ImageModel, nil]
       optional :model, union: -> { OpenAI::ImageEditParams::Model }, nil?: true
@@ -74,7 +75,7 @@ module OpenAI
 
       # @!attribute 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, and
+      #   supported for the GPT image models with the `webp` or `jpeg` output formats, and
       #   defaults to 100.
       #
       #   @return [Integer, nil]
@@ -82,7 +83,7 @@ module OpenAI
 
       # @!attribute output_format
       #   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`. The
+      #   supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`. The
       #   default value is `png`.
       #
       #   @return [Symbol, OpenAI::Models::ImageEditParams::OutputFormat, nil]
@@ -101,8 +102,8 @@ module OpenAI
 
       # @!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.
-      #   Defaults to `auto`.
+      #   only supported for the GPT image models. `dall-e-2` only supports `standard`
+      #   quality. Defaults to `auto`.
       #
       #   @return [Symbol, OpenAI::Models::ImageEditParams::Quality, nil]
       optional :quality, enum: -> { OpenAI::ImageEditParams::Quality }, nil?: true
@@ -110,16 +111,16 @@ module OpenAI
       # @!attribute response_format
       #   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.
+      #   generated. This parameter is only supported for `dall-e-2`, as the GPT image
+      #   models always return base64-encoded images.
       #
       #   @return [Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil]
       optional :response_format, enum: -> { OpenAI::ImageEditParams::ResponseFormat }, nil?: true
 
       # @!attribute size
       #   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`.
+      #   (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
+      #   models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
       #
       #   @return [Symbol, OpenAI::Models::ImageEditParams::Size, nil]
       optional :size, enum: -> { OpenAI::ImageEditParams::Size }, nil?: true
@@ -146,7 +147,7 @@ module OpenAI
       #
       #   @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
+      #   @param model [String, Symbol, OpenAI::Models::ImageModel, nil] The model to use for image generation. Only `dall-e-2` and the GPT image models
       #
       #   @param n [Integer, nil] The number of images to generate. Must be between 1 and 10.
       #
@@ -168,7 +169,8 @@ module OpenAI
 
       # 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`
@@ -188,9 +190,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`.
@@ -219,15 +221,15 @@ module OpenAI
         #   @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.
+      # The model to use for image generation. 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.
       module Model
         extend OpenAI::Internal::Type::Union
 
         variant String
 
-        # 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.
+        # The model to use for image generation. 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.
         variant enum: -> { OpenAI::ImageModel }
 
         # @!method self.variants
@@ -235,7 +237,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`. The
+      # supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`. The
       # default value is `png`.
       module OutputFormat
         extend OpenAI::Internal::Type::Enum
@@ -249,8 +251,8 @@ module OpenAI
       end
 
       # 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`.
+      # only supported for the GPT image models. `dall-e-2` only supports `standard`
+      # quality. Defaults to `auto`.
       module Quality
         extend OpenAI::Internal::Type::Enum
 
@@ -266,8 +268,8 @@ module OpenAI
 
       # 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.
+      # generated. This parameter is only supported for `dall-e-2`, as the GPT image
+      # models always return base64-encoded images.
       module ResponseFormat
         extend OpenAI::Internal::Type::Enum
 
@@ -279,8 +281,8 @@ 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`, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
+      # (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
+      # models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
       module Size
         extend OpenAI::Internal::Type::Enum
 

data/lib/openai/models/image_gen_completed_event.rb

@@ -46,7 +46,8 @@ module OpenAI
       required :type, const: :"image_generation.completed"
 
       # @!attribute 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.
       #
       #   @return [OpenAI::Models::ImageGenCompletedEvent::Usage]
       required :usage, -> { OpenAI::ImageGenCompletedEvent::Usage }
@@ -69,7 +70,7 @@ module OpenAI
       #
       #   @param size [Symbol, OpenAI::Models::ImageGenCompletedEvent::Size] The size of the generated image.
       #
-      #   @param usage [OpenAI::Models::ImageGenCompletedEvent::Usage] For `gpt-image-1` only, the token usage information for the image generation.
+      #   @param usage [OpenAI::Models::ImageGenCompletedEvent::Usage] For the GPT image models only, the token usage information for the image generat
       #
       #   @param type [Symbol, :"image_generation.completed"] The type of the event. Always `image_generation.completed`.
 
@@ -161,7 +162,8 @@ module OpenAI
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::ImageGenCompletedEvent::Usage} for more details.
         #
-        #   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.
         #
         #   @param input_tokens [Integer] The number of tokens (images and text) in the input prompt.
         #