openai 0.83.0 → 0.84.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b53caabbe2b1546ef4ec0eb7f677b8de5cb6d193a65e6a7e37b937459e84b1
-  data.tar.gz: af8a795be6bc7ee391b58b35a48e7a6eb49562c67a98d548437fad6f85871a48
+  metadata.gz: 03f5297b1df9de7c2e182a5f76a72a5a15f2e9a34468b554eb92eb7e8022182b
+  data.tar.gz: 414ac43f94cee9591533b94c02d1d904cdd6a6ba0beb8694e88745b1b30dfad6
 SHA512:
-  metadata.gz: 0a4a975d009308c39829498c31a41cd7ff1e4d6d34302251a2ad1a96858892a6ca52dfb7bb2791dfae729cc000c9c191ced27ae413f96b4a15b1f93f3d729c80
-  data.tar.gz: af0e5f84ca22955f73cecafe5a06bd9180c414c410cd1d8a88f36ae4566bfcdf43cdbba3300f24648e5cfbea993bd9093f0edc57304b183af6328a0826ad026e
+  metadata.gz: a2dda8c58eb47a26113b553b1428d23502d0c6740808954b740c0a5cf5dac361a798f6a14f963cff9d1230256cd800295017dc07489f7c6798f50a59c4066b1c
+  data.tar.gz: 72d931bd9cc9fa963b2f9d0d6f6e66078eb778456097d041850013b814ec20c3b5c9661a4b68c9fa2ea56a829aaaccc657e544a8cb68863f6c9ae4dd653aeb01

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## [0.84.0](https://github.com/openai/openai-ruby/compare/v0.83.0...v0.84.0) (2026-09-02)
+
+
+### Features
+
+* **api:** update usage APIs and documentation ([#566](https://github.com/openai/openai-ruby/issues/566)) ([caac1f0](https://github.com/openai/openai-ruby/commit/caac1f0d0932dff46e25f5879f5a1410425275e9))
+
+
+### Bug Fixes
+
+* accept custom request hash in RBS ([#554](https://github.com/openai/openai-ruby/issues/554)) ([8d32aa1](https://github.com/openai/openai-ruby/commit/8d32aa1764ecff22d2cb3114fa1a4b6f7faa309b))
+* avoid dispatching nil checks during coercion ([#552](https://github.com/openai/openai-ruby/issues/552)) ([c8d6d32](https://github.com/openai/openai-ruby/commit/c8d6d32e178563e38585d3ad928136e3c6f10ac1))
+* avoid duplicate late-choice stream logprobs ([#564](https://github.com/openai/openai-ruby/issues/564)) ([2359a02](https://github.com/openai/openai-ruby/commit/2359a02dd22fbf599250aaa97e755863562abf53))
+* delimit JSONL request records ([#553](https://github.com/openai/openai-ruby/issues/553)) ([dea0408](https://github.com/openai/openai-ruby/commit/dea04081076da3fde34f4a9b15f445dd92556b0f))
+* enforce workload identity request deadlines ([#547](https://github.com/openai/openai-ruby/issues/547)) ([da421b5](https://github.com/openai/openai-ruby/commit/da421b507c24c35f62ff8679dd5c468ce8a0dab9))
+* handle custom chat completion tool calls ([#556](https://github.com/openai/openai-ruby/issues/556)) ([dd49e31](https://github.com/openai/openai-ruby/commit/dd49e31134cf8dd1442f1b3fb428bab4dbc663d1))
+* load YAML for BaseModel serialization ([#555](https://github.com/openai/openai-ruby/issues/555)) ([5420931](https://github.com/openai/openai-ruby/commit/54209313bca8a7159ad8ee4768678ac61b871d69))
+* make error cause contract read-only ([#557](https://github.com/openai/openai-ruby/issues/557)) ([f3169ca](https://github.com/openai/openai-ruby/commit/f3169caae9a6115c3725c8d4da33e9ffb65085c5))
+* preserve formatter path boundaries ([#559](https://github.com/openai/openai-ruby/issues/559)) ([f8b128c](https://github.com/openai/openai-ruby/commit/f8b128cf0db3198a297caec7e7ca8dfa991f16e8))
+* respect StringIO cursor in multipart uploads ([#558](https://github.com/openai/openai-ruby/issues/558)) ([e8ea7c7](https://github.com/openai/openai-ruby/commit/e8ea7c73e7a233abaf7c919ce10117729918df5e))
+* resume Responses streams from server-side cursors ([#548](https://github.com/openai/openai-ruby/issues/548)) ([3b88261](https://github.com/openai/openai-ruby/commit/3b88261e7cd9a8736028c1867c0c23d21aba54b5))
+* support flattened responses typed function tools ([#550](https://github.com/openai/openai-ruby/issues/550)) ([ab16d33](https://github.com/openai/openai-ruby/commit/ab16d33e18c862608125cf12fac07e72702b8752))
+* support structured chat output with typed function tools ([#546](https://github.com/openai/openai-ruby/issues/546)) ([087d1e2](https://github.com/openai/openai-ruby/commit/087d1e2041099342ed59be211259b81dce14392c))
+
+
+### Chores
+
+* **deps-dev:** bump the development-dependencies group with 3 updates ([#560](https://github.com/openai/openai-ruby/issues/560)) ([f728e07](https://github.com/openai/openai-ruby/commit/f728e072a0d65e2d66b2e647d36843b76fd92606))
+
 ## [0.83.0](https://github.com/openai/openai-ruby/compare/v0.82.0...v0.83.0) (2026-08-27)
 
 

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

data/lib/openai/auth/workload_identity_auth.rb

@@ -15,6 +15,12 @@ module OpenAI
       DEFAULT_REFRESH_BUFFER_SECONDS = 1200
       MAX_REJECTED_TOKEN_REFRESH_ATTEMPTS = 3
       private_constant :MAX_REJECTED_TOKEN_REFRESH_ATTEMPTS
+      # Provider implementations wrap StandardError, but scheduler deadlines
+      # must cross that boundary before normalization to Timeout::Error.
+      # rubocop:disable Lint/InheritException
+      PROVIDER_DEADLINE_ERROR = Class.new(Exception)
+      # rubocop:enable Lint/InheritException
+      private_constant :PROVIDER_DEADLINE_ERROR
 
       def initialize(
         config,
@@ -274,10 +280,19 @@ module OpenAI
       private def fetch_token_from_exchange(deadline:)
         return @token_exchange.fetch(deadline: deadline) unless @token_exchange.nil?
 
-        subject_token = @config.provider.get_token
+        message = "request timed out during workload identity authentication"
+        subject_token, token_type = begin
+          timeout = remaining_timeout(deadline)
+          Timeout.timeout(timeout, PROVIDER_DEADLINE_ERROR, message) do
+            [@config.provider.get_token, @config.provider.token_type]
+          end
+
+        rescue PROVIDER_DEADLINE_ERROR
+          raise Timeout::Error, message
+        end
+
         check_deadline!(deadline)
 
-        token_type = @config.provider.token_type
         subject_token_type = SUBJECT_TOKEN_TYPES.fetch(token_type) do
           raise(
             ArgumentError,

data/lib/openai/client.rb

@@ -18,6 +18,8 @@ module OpenAI
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
     WORKLOAD_IDENTITY_API_KEY_PLACEHOLDER = "workload-identity-auth"
+    WORKLOAD_IDENTITY_DEADLINE_ERROR = Class.new(Timeout::Error)
+    private_constant :WORKLOAD_IDENTITY_DEADLINE_ERROR
 
     # @return [String, nil]
     attr_reader :api_key
@@ -248,9 +250,9 @@ module OpenAI
 
     # @api private
     private def validate_retry_delay!(request, delay:)
-      deadline = request[:x509_request_context]&.fetch(:deadline)
+      deadline = request[:x509_request_context]&.fetch(:deadline) || request[:workload_identity_deadline]
       if deadline && delay >= deadline - OpenAI::Internal::Util.monotonic_secs
-        raise Timeout::Error, "request timed out during workload identity authentication"
+        raise WORKLOAD_IDENTITY_DEADLINE_ERROR, "request timed out during workload identity authentication"
       end
 
       super
@@ -281,7 +283,8 @@ module OpenAI
           request[:workload_identity_deadline] ||
           request[:timeout]&.then { OpenAI::Internal::Util.monotonic_secs + _1 }
       else
-        request[:timeout]&.then { OpenAI::Internal::Util.monotonic_secs + _1 }
+        request[:workload_identity_deadline] ||
+          request[:timeout]&.then { OpenAI::Internal::Util.monotonic_secs + _1 }
       end
 
       request = request.merge(workload_identity_deadline: deadline)
@@ -359,8 +362,16 @@ module OpenAI
         end
       end
 
-    rescue Timeout::Error
-      raise unless x509_request
+    rescue Timeout::Error => error
+      unless x509_request
+        raise unless error.is_a?(WORKLOAD_IDENTITY_DEADLINE_ERROR)
+
+        url = request.fetch(:url).dup
+        url.query = nil
+        url.fragment = nil
+        cause = Timeout::Error.new(error.message)
+        raise OpenAI::Errors::APITimeoutError.new(url: url, message: error.message), cause: cause
+      end
 
       url = request.fetch(:url).dup
       url.query = nil
@@ -443,7 +454,10 @@ module OpenAI
     rescue Timeout::Error => e
       raise if x509_transport?(@requester)
 
-      raise OpenAI::Errors::APITimeoutError.new(url: request.fetch(:url), message: e.message)
+      url = request.fetch(:url).dup
+      url.query = nil
+      url.fragment = nil
+      raise OpenAI::Errors::APITimeoutError.new(url: url, message: e.message)
     end
 
     # @api private

data/lib/openai/errors.rb

@@ -3,7 +3,7 @@
 module OpenAI
   module Errors
     class Error < StandardError
-      # @!attribute cause
+      # @!attribute [r] cause
       #
       #   @return [StandardError, nil]
     end

data/lib/openai/helpers/streaming/chat_completion_stream.rb

@@ -156,6 +156,7 @@ module OpenAI
             insert_choice_snapshot!(completion_snapshot.choices, choice_snapshot)
           else
             update_existing_choice_snapshot(choice, choice_snapshot)
+            accumulate_logprobs!(choice.logprobs, choice_snapshot)
           end
 
           tool_calls_by_index = index_choice_snapshot!(choice_snapshot)
@@ -166,8 +167,6 @@ module OpenAI
           end
 
           parse_tool_calls!(choice.delta.tool_calls, tool_calls_by_index)
-
-          accumulate_logprobs!(choice.logprobs, choice_snapshot)
         end
 
         def create_new_choice_snapshot(choice)

data/lib/openai/helpers/streaming/response_events.rb

@@ -4,7 +4,7 @@ module OpenAI
   module Helpers
     module Streaming
       class ResponseTextDeltaEvent < OpenAI::Models::Responses::ResponseTextDeltaEvent
-        required :snapshot, String
+        optional :snapshot, String, nil?: true
       end
 
       class ResponseTextDoneEvent < OpenAI::Models::Responses::ResponseTextDoneEvent
@@ -12,7 +12,7 @@ module OpenAI
       end
 
       class ResponseFunctionCallArgumentsDeltaEvent < OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent
-        required :snapshot, String
+        optional :snapshot, String, nil?: true
       end
 
       class ResponseCompletedEvent < OpenAI::Models::Responses::ResponseCompletedEvent

data/lib/openai/helpers/streaming/response_stream.rb

@@ -13,7 +13,8 @@ module OpenAI
           @last_response = raw_stream.last_response
           @iterator = iterator
           @state = ResponseStreamState.new(
-            text_format: text_format
+            text_format: text_format,
+            starting_after: starting_after
           )
         end
 
@@ -26,7 +27,7 @@ module OpenAI
           OpenAI::Internal::Util.chain_fused(@iterator) do |yielder|
             @iterator.each do |event|
               case event
-              when OpenAI::Streaming::ResponseTextDeltaEvent
+              when OpenAI::Models::Responses::ResponseTextDeltaEvent
                 yielder << event.delta
               end
             end
@@ -80,10 +81,11 @@ module OpenAI
       class ResponseStreamState
         attr_reader :completed_response
 
-        def initialize(text_format:)
+        def initialize(text_format:, starting_after: nil)
           @current_snapshot = nil
           @completed_response = nil
           @text_format = text_format
+          @resumed = !starting_after.nil?
         end
 
         def handle_event(event)
@@ -98,31 +100,43 @@ module OpenAI
 
           case event
           when OpenAI::Models::Responses::ResponseTextDeltaEvent
-            output = @current_snapshot.output[event.output_index]
-            assert_type(output, :message)
+            if @current_snapshot
+              output = @current_snapshot.output[event.output_index]
+              assert_type(output, :message)
 
-            content = output.content[event.content_index]
-            assert_type(content, :output_text)
-
-            events_to_yield <<
-              OpenAI::Streaming::ResponseTextDeltaEvent.new(
-                content_index: event.content_index,
-                delta: event.delta,
-                item_id: event.item_id,
-                output_index: event.output_index,
-                sequence_number: event.sequence_number,
-                type: event.type,
-                snapshot: content.text
-              )
+              content = output.content[event.content_index]
+              assert_type(content, :output_text)
+              events_to_yield <<
+                OpenAI::Streaming::ResponseTextDeltaEvent.new(
+                  content_index: event.content_index,
+                  delta: event.delta,
+                  item_id: event.item_id,
+                  output_index: event.output_index,
+                  sequence_number: event.sequence_number,
+                  type: event.type,
+                  snapshot: content.text
+                )
+            else
+              # A server-directed resumed stream may begin after response.created.
+              # Without the omitted prefix, a snapshot would be incomplete and
+              # materializing every partial prefix would make streaming quadratic.
+              events_to_yield <<
+                OpenAI::Streaming::ResponseTextDeltaEvent.new(event.to_h.merge(snapshot: nil))
+            end
 
           when OpenAI::Models::Responses::ResponseTextDoneEvent
-            output = @current_snapshot.output[event.output_index]
-            assert_type(output, :message)
+            text = if @current_snapshot
+              output = @current_snapshot.output[event.output_index]
+              assert_type(output, :message)
 
-            content = output.content[event.content_index]
-            assert_type(content, :output_text)
+              content = output.content[event.content_index]
+              assert_type(content, :output_text)
+              content.text
+            else
+              event.text
+            end
 
-            parsed = parse_structured_text(content.text)
+            parsed = parse_structured_text(text)
 
             events_to_yield <<
               OpenAI::Streaming::ResponseTextDoneEvent.new(
@@ -136,18 +150,26 @@ module OpenAI
               )
 
           when OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent
-            output = @current_snapshot.output[event.output_index]
-            assert_type(output, :function_call)
-
-            events_to_yield <<
-              OpenAI::Streaming::ResponseFunctionCallArgumentsDeltaEvent.new(
-                delta: event.delta,
-                item_id: event.item_id,
-                output_index: event.output_index,
-                sequence_number: event.sequence_number,
-                type: event.type,
-                snapshot: output.arguments
-              )
+            if @current_snapshot
+              output = @current_snapshot.output[event.output_index]
+              assert_type(output, :function_call)
+              events_to_yield <<
+                OpenAI::Streaming::ResponseFunctionCallArgumentsDeltaEvent.new(
+                  delta: event.delta,
+                  item_id: event.item_id,
+                  output_index: event.output_index,
+                  sequence_number: event.sequence_number,
+                  type: event.type,
+                  snapshot: output.arguments
+                )
+            else
+              # See the text-delta branch above: a partial server resume has no
+              # complete argument prefix from which to build a truthful snapshot.
+              events_to_yield <<
+                OpenAI::Streaming::ResponseFunctionCallArgumentsDeltaEvent.new(
+                  event.to_h.merge(snapshot: nil)
+                )
+            end
 
           when OpenAI::Models::Responses::ResponseCompletedEvent
             events_to_yield <<
@@ -167,16 +189,25 @@ module OpenAI
 
         def accumulate_event(event:, current_snapshot:)
           if current_snapshot.nil?
-            unless event.is_a?(OpenAI::Models::Responses::ResponseCreatedEvent)
+            if event.is_a?(OpenAI::Models::Responses::ResponseCreatedEvent)
+              # Use the converter to create a new, isolated copy of the response object.
+              # This ensures proper type validation and prevents shared object references.
+              return OpenAI::Internal::Type::Converter.coerce(
+                OpenAI::Models::Responses::Response,
+                event.response
+              )
+            end
+
+            unless @resumed
               raise "Expected first event to be response.created"
             end
 
-            # Use the converter to create a new, isolated copy of the response object.
-            # This ensures proper type validation and prevents shared object references.
-            return OpenAI::Internal::Type::Converter.coerce(
-              OpenAI::Models::Responses::Response,
-              event.response
-            )
+            if event.is_a?(OpenAI::Models::Responses::ResponseCompletedEvent)
+              @completed_response = event.response
+              return event.response
+            end
+
+            return nil
           end
 
           case event

data/lib/openai/helpers/structured_output/chat_completion_parser.rb

@@ -28,6 +28,8 @@ module OpenAI
 
             raw[:choices]&.each do |choice|
               choice.dig(:message, :tool_calls)&.each do |tool_call|
+                next if tool_call[:type] == "custom"
+
                 func = tool_call.fetch(:function)
                 next if (model = tool_models[func.fetch(:name)]).nil?
 
@@ -81,6 +83,10 @@ module OpenAI
                 }
             }
             parsed.dig(:response_format, :json_schema).store(:schema, model.to_json_schema)
+          else
+          end
+
+          case parsed
           in {tools: Array => tools}
             mapped = tools.map do |tool|
               case tool

data/lib/openai/helpers/structured_output/response_parser.rb

@@ -109,7 +109,7 @@ module OpenAI
                   parameters: tool.to_json_schema
                 }
               in {type: :function, parameters: OpenAI::StructuredOutput::JsonSchemaConverter => params}
-                func = tool.fetch(:function)
+                func = tool.fetch(:function, tool)
                 name = func[:name] ||= params.name.split("::").last
                 tool_models.store(name, params)
                 func.update(parameters: params.to_json_schema)

data/lib/openai/internal/type/base_model.rb

@@ -119,7 +119,7 @@ module OpenAI
                 Kernel.then do
                   value = @data.fetch(name_sym) { const == OpenAI::Internal::OMIT ? nil : const }
                   state = OpenAI::Internal::Type::Converter.new_coerce_state(translate_names: false)
-                  if (nilable || !required) && value.nil?
+                  if (nilable || !required) && nil.equal?(value)
                     nil
                   else
                     OpenAI::Internal::Type::Converter.coerce(
@@ -321,7 +321,7 @@ module OpenAI
               keys.delete(src_name)
 
               state[:error] = nil
-              converted = if item.nil? && (nilable || !required)
+              converted = if nil.equal?(item) && (nilable || !required)
                 exactness[nilable ? :yes : :maybe] += 1
                 nil
               else

data/lib/openai/internal/type/converter.rb

@@ -199,7 +199,7 @@ module OpenAI
 
               case target
               in -> { _1 <= NilClass }
-                exactness[value.nil? ? :yes : :maybe] += 1
+                exactness[nil.equal?(value) ? :yes : :maybe] += 1
                 return nil
               in -> { _1 <= Integer }
                 case value

data/lib/openai/internal/util.rb

@@ -510,7 +510,7 @@ module OpenAI
             IO.copy_stream(val, y)
           in StringIO
             y << format(content_line, content_type || "application/octet-stream")
-            y << val.string
+            y << (val.string.byteslice(val.pos..) || "")
           in -> { primitive?(_1) }
             y << format(content_line, content_type || "text/plain")
             y << val.to_s
@@ -630,7 +630,7 @@ module OpenAI
           in [OpenAI::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
             [headers, JSON.generate(body)]
           in [OpenAI::Internal::Util::JSONL_CONTENT, Enumerable] unless OpenAI::Internal::Type::FileInput === body
-            [headers, body.lazy.map { JSON.generate(_1) }]
+            [headers, body.lazy.map { "#{JSON.generate(_1)}\n" }]
           in [%r{^multipart/form-data}, Hash | OpenAI::Internal::Type::FileInput]
             boundary, strio = encode_multipart_streaming(body)
             headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}

data/lib/openai/models/admin/organization/usage_costs_params.rb

@@ -51,6 +51,13 @@ module OpenAI
           #   @return [Integer, nil]
           optional :limit, Integer
 
+          # @!attribute line_items
+          #   Return only costs for these exact line item names. Each value must match the
+          #   complete `line_item` value, for example `gpt-5.6-sol, input_tokens`.
+          #
+          #   @return [Array<String>, nil]
+          optional :line_items, OpenAI::Internal::Type::ArrayOf[String]
+
           # @!attribute page
           #   A cursor for use in pagination. Corresponding to the `next_page` field from the
           #   previous response.
@@ -64,7 +71,7 @@ module OpenAI
           #   @return [Array<String>, nil]
           optional :project_ids, OpenAI::Internal::Type::ArrayOf[String]
 
-          # @!method initialize(start_time:, api_key_ids: nil, bucket_width: nil, end_time: nil, group_by: nil, limit: nil, page: nil, project_ids: nil, request_options: {})
+          # @!method initialize(start_time:, api_key_ids: nil, bucket_width: nil, end_time: nil, group_by: nil, limit: nil, line_items: nil, page: nil, project_ids: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Admin::Organization::UsageCostsParams} for more details.
           #
@@ -80,6 +87,8 @@ module OpenAI
           #
           #   @param limit [Integer] A limit on the number of buckets to be returned. Limit can range between 1 and 1
           #
+          #   @param line_items [Array<String>] Return only costs for these exact line item names. Each value must match the com
+          #
           #   @param page [String] A cursor for use in pagination. Corresponding to the `next_page` field from the
           #
           #   @param project_ids [Array<String>] Return only costs for these projects.

data/lib/openai/models/batch.rb

@@ -116,9 +116,9 @@ module OpenAI
       optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
 
       # @!attribute model
-      #   Model ID used to process the batch, like `gpt-5-2025-08-07`. OpenAI offers a
-      #   wide range of models with different capabilities, performance characteristics,
-      #   and price points. Refer to the
+      #   Model ID used to process the batch, like `gpt-5.6-sol`. OpenAI offers a wide
+      #   range of models with different capabilities, performance characteristics, and
+      #   price points. Refer to the
       #   [model guide](https://platform.openai.com/docs/models) to browse and compare
       #   available models.
       #
@@ -183,7 +183,7 @@ module OpenAI
       #
       #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
       #
-      #   @param model [String] Model ID used to process the batch, like `gpt-5-2025-08-07`. OpenAI
+      #   @param model [String] Model ID used to process the batch, like `gpt-5.6-sol`. OpenAI
       #
       #   @param output_file_id [String] The ID of the file containing the outputs of successfully executed requests.
       #

data/lib/openai/models/beta/beta_response.rb

@@ -53,9 +53,9 @@ module OpenAI
         required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
 
         # @!attribute model
-        #   Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
-        #   wide range of models with different capabilities, performance characteristics,
-        #   and price points. Refer to the
+        #   Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
+        #   range of models with different capabilities, performance characteristics, and
+        #   price points. Refer to the
         #   [model guide](https://platform.openai.com/docs/models) to browse and compare
         #   available models.
         #
@@ -242,8 +242,6 @@ module OpenAI
         )
 
         # @!attribute reasoning
-        #   **gpt-5 and o-series models only**
-        #
         #   Configuration options for
         #   [reasoning models](https://platform.openai.com/docs/guides/reasoning).
         #
@@ -362,7 +360,7 @@ module OpenAI
         #
         #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
         #
-        #   @param model [Symbol, String, OpenAI::Models::Beta::BetaResponse::Model] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
+        #   @param model [Symbol, String, OpenAI::Models::Beta::BetaResponse::Model] Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI
         #
         #   @param output [Array<OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem>] An array of content items generated by the model.
         #
@@ -398,7 +396,7 @@ module OpenAI
         #
         #   @param prompt_cache_retention [Symbol, OpenAI::Models::Beta::BetaResponse::PromptCacheRetention, nil] Deprecated. Use `prompt_cache_options.ttl` instead.
         #
-        #   @param reasoning [OpenAI::Models::Beta::BetaResponse::Reasoning, nil] **gpt-5 and o-series models only**
+        #   @param reasoning [OpenAI::Models::Beta::BetaResponse::Reasoning, nil] Configuration options for
         #
         #   @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
         #
@@ -438,6 +436,7 @@ module OpenAI
             extend OpenAI::Internal::Type::Enum
 
             MAX_OUTPUT_TOKENS = :max_output_tokens
+            MAX_MESSAGES = :max_messages
             CONTENT_FILTER = :content_filter
 
             # @!method self.values
@@ -472,9 +471,9 @@ module OpenAI
           ]
         end
 
-        # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
-        # wide range of models with different capabilities, performance characteristics,
-        # and price points. Refer to the
+        # Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI offers a wide
+        # range of models with different capabilities, performance characteristics, and
+        # price points. Refer to the
         # [model guide](https://platform.openai.com/docs/models) to browse and compare
         # available models.
         #
@@ -1290,8 +1289,6 @@ module OpenAI
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Beta::BetaResponse::Reasoning} for more details.
           #
-          #   **gpt-5 and o-series models only**
-          #
           #   Configuration options for
           #   [reasoning models](https://platform.openai.com/docs/guides/reasoning).
           #

data/lib/openai/models/beta/beta_response_usage.rb

@@ -34,16 +34,7 @@ module OpenAI
         #   @return [Integer]
         required :total_tokens, Integer
 
-        # @!attribute compute_units
-        #   Compute units for the request. Currently null when available.
-        #
-        #   @return [Integer, nil]
-        optional :compute_units, Integer, nil?: true
-
-        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:, compute_units: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaResponseUsage} for more details.
-        #
+        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:)
         #   Represents token usage details including input tokens, output tokens, a
         #   breakdown of output tokens, and the total tokens used.
         #
@@ -56,8 +47,6 @@ module OpenAI
         #   @param output_tokens_details [OpenAI::Models::Beta::BetaResponseUsage::OutputTokensDetails] A detailed breakdown of the output tokens.
         #
         #   @param total_tokens [Integer] The total number of tokens used.
-        #
-        #   @param compute_units [Integer, nil] Compute units for the request. Currently null when available.
 
         # @see OpenAI::Models::Beta::BetaResponseUsage#input_tokens_details
         class InputTokensDetails < OpenAI::Internal::Type::BaseModel