release: 0.35.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.34.1"
+  ".": "0.35.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 135
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-a4bb37d110a22c2888f53e21281434686a6fffa3e672a40f2503ad9bd2759063.yml
-openapi_spec_hash: 2d59eefb494dff4eea8c3d008c7e2070
-config_hash: 50ee3382a63c021a9f821a935950e926
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-3c5d1593d7c6f2b38a7d78d7906041465ee9d6e9022f0651e1da194654488108.yml
+openapi_spec_hash: 0a4d8ad2469823ce24a3fd94f23f1c2b
+config_hash: 032995825500a503a76da119f5354905

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.35.0 (2025-11-03)
+
+Full Changelog: [v0.34.1...v0.35.0](https://github.com/openai/openai-ruby/compare/v0.34.1...v0.35.0)
+
+### Features
+
+* **api:** Realtime API token_limits, Hybrid searching ranking options ([f7f04ea](https://github.com/openai/openai-ruby/commit/f7f04ea1816e005cfc7325f3c97b1f463aa6afe3))
+* **api:** remove InputAudio from ResponseInputContent ([e8f5e9f](https://github.com/openai/openai-ruby/commit/e8f5e9f1b51843bc015f787316fbf522a87cac52))
+* handle thread interrupts in the core HTTP client ([92e26d0](https://github.com/openai/openai-ruby/commit/92e26d0593ae6487a62d500c3e1e866252f3bdeb))
+
+
+### Bug Fixes
+
+* **api:** docs updates ([88a4a35](https://github.com/openai/openai-ruby/commit/88a4a355457b22ef9ac657ecb0e7a1a2e9bc8973))
+* text and tools use mutually exclusive issue ([#855](https://github.com/openai/openai-ruby/issues/855)) ([7d93874](https://github.com/openai/openai-ruby/commit/7d93874ff34f5efa2459211984533fe72dced9e1))
+
+
+### Chores
+
+* add license information to the gemspec file ([#222](https://github.com/openai/openai-ruby/issues/222)) ([90d3c4a](https://github.com/openai/openai-ruby/commit/90d3c4aaae8a6e2fa039e0d1ad220ea3d1051ed7))
+* **client:** send user-agent header ([3a850a9](https://github.com/openai/openai-ruby/commit/3a850a93808daf101fb086edc5511db9fa224684))
+* **internal:** codegen related update ([f6b9f90](https://github.com/openai/openai-ruby/commit/f6b9f904a95d703a0ce76185e63352e095cb35af))
+
 ## 0.34.1 (2025-10-20)
 
 Full Changelog: [v0.34.0...v0.34.1](https://github.com/openai/openai-ruby/compare/v0.34.0...v0.34.1)

Gemfile

@@ -11,8 +11,7 @@ group :development do
   gem "sorbet"
   gem "steep"
   gem "syntax_tree"
-  # TODO: using a fork for now, the prettier below has a bug
-  gem "syntax_tree-rbs", github: "stainless-api/syntax_tree-rbs", branch: "main"
+  gem "syntax_tree-rbs", github: "ruby-syntax-tree/syntax_tree-rbs", branch: "main"
   gem "tapioca"
 end
 

Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
-  remote: https://github.com/stainless-api/syntax_tree-rbs.git
-  revision: c30b50219918be7cfe3ef803a00b59d1e77fcada
+  remote: https://github.com/ruby-syntax-tree/syntax_tree-rbs.git
+  revision: f94bc3060682ffbd126e4d5086ffedc89073d626
   branch: main
   specs:
     syntax_tree-rbs (1.0.0)
@@ -11,20 +11,20 @@ GIT
 PATH
   remote: .
   specs:
-    openai (0.34.1)
+    openai (0.35.0)
       connection_pool
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.0.2.1)
+    activesupport (8.1.1)
       base64
-      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      json
       logger (>= 1.4.2)
       minitest (>= 5.1)
       securerandom (>= 0.3)
@@ -33,22 +33,22 @@ GEM
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.3)
-    async (2.27.3)
+    async (2.34.0)
       console (~> 1.29)
       fiber-annotation
       io-event (~> 1.11)
       metrics (~> 0.12)
-      traces (~> 0.15)
+      traces (~> 0.18)
     base64 (0.3.0)
-    benchmark (0.4.1)
-    bigdecimal (3.2.2)
+    benchmark (0.5.0)
+    bigdecimal (3.3.1)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.3)
-    console (1.33.0)
+    connection_pool (2.5.4)
+    console (1.34.2)
       fiber-annotation
       fiber-local (~> 1.1)
       json
-    crack (1.0.0)
+    crack (1.0.1)
       bigdecimal
       rexml
     csv (3.3.5)
@@ -64,20 +64,20 @@ GEM
     fiber-local (1.1.0)
       fiber-storage
     fiber-storage (1.0.1)
-    fileutils (1.7.3)
-    hashdiff (1.2.0)
+    fileutils (1.8.0)
+    hashdiff (1.2.1)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     io-event (1.11.2)
-    json (2.13.2)
+    json (2.15.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
-    metrics (0.13.0)
-    minitest (5.25.5)
+    metrics (0.15.0)
+    minitest (5.26.0)
     minitest-focus (1.4.0)
       minitest (>= 4, < 6)
     minitest-hooks (1.5.2)
@@ -89,51 +89,51 @@ GEM
     mutex_m (0.3.0)
     netrc (0.11.0)
     parallel (1.27.0)
-    parser (3.3.9.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
     prettier_print (1.2.1)
-    prism (1.4.0)
+    prism (1.6.0)
     public_suffix (6.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.0)
+    rake (13.3.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rbi (0.3.6)
+    rbi (0.3.7)
       prism (~> 1.0)
       rbs (>= 3.4.4)
-    rbs (3.9.4)
+    rbs (3.9.5)
       logger
     redcarpet (3.6.1)
-    regexp_parser (2.11.2)
-    rexml (3.4.1)
-    rubocop (1.79.2)
+    regexp_parser (2.11.3)
+    rexml (3.4.4)
+    rubocop (1.81.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.46.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.46.0)
+    rubocop-ast (1.47.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
-    sorbet (0.5.12424)
-      sorbet-static (= 0.5.12424)
-    sorbet-runtime (0.5.12424)
-    sorbet-static (0.5.12424-aarch64-linux)
-    sorbet-static (0.5.12424-universal-darwin)
-    sorbet-static (0.5.12424-x86_64-linux)
-    sorbet-static-and-runtime (0.5.12424)
-      sorbet (= 0.5.12424)
-      sorbet-runtime (= 0.5.12424)
+    sorbet (0.6.12690)
+      sorbet-static (= 0.6.12690)
+    sorbet-runtime (0.6.12690)
+    sorbet-static (0.6.12690-aarch64-linux)
+    sorbet-static (0.6.12690-universal-darwin)
+    sorbet-static (0.6.12690-x86_64-linux)
+    sorbet-static-and-runtime (0.6.12690)
+      sorbet (= 0.6.12690)
+      sorbet-runtime (= 0.6.12690)
     spoom (1.6.3)
       erubi (>= 1.10.0)
       prism (>= 0.28.0)
@@ -174,14 +174,14 @@ GEM
     terminal-table (4.0.0)
       unicode-display_width (>= 1.1.1, < 4)
     thor (1.4.0)
-    traces (0.17.0)
+    traces (0.18.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (3.1.5)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    uri (1.0.3)
-    webmock (3.25.1)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.1.0)
+    webmock (3.26.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

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

lib/openai/internal/transport/base_client.rb

@@ -201,7 +201,8 @@ def initialize(
             self.class::PLATFORM_HEADERS,
             {
               "accept" => "application/json",
-              "content-type" => "application/json"
+              "content-type" => "application/json",
+              "user-agent" => user_agent
             },
             headers
           )
@@ -219,6 +220,11 @@ def initialize(
         # @return [Hash{String=>String}]
         private def auth_headers = {}
 
+        # @api private
+        #
+        # @return [String]
+        private def user_agent = "#{self.class.name}/Ruby #{OpenAI::VERSION}"
+
         # @api private
         #
         # @return [String]

lib/openai/internal/transport/pooled_net_requester.rb

@@ -128,40 +128,48 @@ def execute(request)
           url, deadline = request.fetch_values(:url, :deadline)
 
           req = nil
-          eof = false
           finished = false
-          closing = nil
 
           # rubocop:disable Metrics/BlockLength
           enum = Enumerator.new do |y|
             next if finished
 
             with_pool(url, deadline: deadline) do |conn|
-              req, closing = self.class.build_request(request) do
-                self.class.calibrate_socket_timeout(conn, deadline)
-              end
-
-              self.class.calibrate_socket_timeout(conn, deadline)
-              unless conn.started?
-                conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
-                conn.start
-              end
+              eof = false
+              closing = nil
+              ::Thread.handle_interrupt(Object => :never) do
+                ::Thread.handle_interrupt(Object => :immediate) do
+                  req, closing = self.class.build_request(request) do
+                    self.class.calibrate_socket_timeout(conn, deadline)
+                  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)
+                  unless conn.started?
+                    conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+                    conn.start
+                  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)
+                    end
+                    eof = true
+                  end
+                end
+              ensure
+                begin
+                  conn.finish if !eof && conn&.started?
+                ensure
+                  closing&.call
                 end
-                eof = true
               end
-            ensure
-              conn.finish if !eof && conn&.started?
             end
           rescue Timeout::Error
             raise OpenAI::Errors::APITimeoutError.new(url: url, request: req)
@@ -174,8 +182,6 @@ def execute(request)
           body = OpenAI::Internal::Util.fused_enum(enum, external: true) do
             finished = true
             loop { enum.next }
-          ensure
-            closing&.call
           end
           [Integer(response.code), response, body]
         end

lib/openai/models/custom_tool_input_format.rb

@@ -8,8 +8,10 @@ module CustomToolInputFormat
 
       discriminator :type
 
+      # Unconstrained free-form text.
       variant :text, -> { OpenAI::CustomToolInputFormat::Text }
 
+      # A grammar defined by the user.
       variant :grammar, -> { OpenAI::CustomToolInputFormat::Grammar }
 
       class Text < OpenAI::Internal::Type::BaseModel
@@ -20,6 +22,8 @@ class Text < OpenAI::Internal::Type::BaseModel
         required :type, const: :text
 
         # @!method initialize(type: :text)
+        #   Unconstrained free-form text.
+        #
         #   @param type [Symbol, :text] Unconstrained text format. Always `text`.
       end
 
@@ -43,6 +47,8 @@ class Grammar < OpenAI::Internal::Type::BaseModel
         required :type, const: :grammar
 
         # @!method initialize(definition:, syntax:, type: :grammar)
+        #   A grammar defined by the user.
+        #
         #   @param definition [String] The grammar definition.
         #
         #   @param syntax [Symbol, OpenAI::Models::CustomToolInputFormat::Grammar::Syntax] The syntax of the grammar definition. One of `lark` or `regex`.

lib/openai/models/image_edit_params.rb

@@ -142,7 +142,7 @@ class ImageEditParams < OpenAI::Internal::Type::BaseModel
       #
       #   @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]
+      #   @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil] Control how much effort the model will exert to match the style and features, es
       #
       #   @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart] An additional image whose fully transparent areas (e.g. where alpha is zero) ind
       #