openai 0.81.0 → 0.83.0

data/lib/openai/http_client.rb

@@ -20,11 +20,18 @@ module OpenAI
     # @return [String, nil]
     attr_reader :request_id
 
+    # The exact response body when `include_raw_body: true` was requested.
+    # Bodies are never retained by default or for streaming responses.
+    #
+    # @return [String, nil]
+    attr_reader :body
+
     # @api private
     #
     # @param status [Integer]
     # @param headers [Hash{String=>String}]
-    def initialize(status:, headers:)
+    # @param body [String, nil]
+    def initialize(status:, headers:, body: nil)
       @status = Integer(status)
       @headers = headers
         .to_h do |name, value|
@@ -32,6 +39,7 @@ module OpenAI
         end
         .freeze
       @request_id = @headers["x-request-id"]
+      @body = body.nil? || body.frozen? ? body : body.dup.freeze
       freeze
     end
 
@@ -39,6 +47,37 @@ module OpenAI
     #
     # @return [String]
     def inspect = "#<#{self.class} status=#{@status} request_id=#{@request_id.inspect}>"
+
+    # Keep retained response bodies out of Psych object serialization.
+    #
+    # @api private
+    # @param coder [Psych::Coder]
+    # @return [void]
+    def encode_with(coder)
+      coder["status"] = @status
+      coder["headers"] = @headers
+    end
+
+    # @api private
+    # @param coder [Psych::Coder]
+    # @return [void]
+    def init_with(coder)
+      initialize(status: coder["status"], headers: coder["headers"])
+    end
+
+    # Keep retained response bodies out of Marshal object serialization.
+    #
+    # @api private
+    # @return [Array(Integer, Hash{String=>String})]
+    def marshal_dump = [@status, @headers]
+
+    # @api private
+    # @param values [Array(Integer, Hash{String=>String})]
+    # @return [void]
+    def marshal_load(values)
+      status, headers = values
+      initialize(status: status, headers: headers)
+    end
   end
 
   # Details about an API request retry that is about to run.

data/lib/openai/internal/logging.rb

@@ -26,19 +26,24 @@ module OpenAI
       URL_HEADER_KEY = /(?:\A|[-_])(?:location|url|uri)\z|\A(?:link|refresh)\z/i
 
       class Context
-        def initialize(logger:, log_level:, on_retry:, method:, url:)
+        def initialize(logger:, log_level:, on_retry:, method:, url:, on_response: nil)
           @logger = logger
           @log_level = log_level
           @on_retry = on_retry
+          @on_response = on_response
           @id = nil
           @method = method.to_s.upcase
           @url = url
+          @request_url = url
+          @first_request_url = nil
           @started_at = OpenAI::Internal::Util.monotonic_secs
           @attempt_started_at = @started_at
           @attempts = 0
         end
 
         def request_started(request, redirect_count:)
+          @request_url = request.url
+          @first_request_url ||= request.url
           @attempts += 1
           log(:debug) do
             "[openai] request started log_id=#{id} attempt=#{@attempts} " \
@@ -52,6 +57,7 @@ module OpenAI
         end
 
         def response_received(response)
+          @on_response&.call(response, @first_request_url || @url, @request_url)
           log(:debug) do
             "[openai] response received log_id=#{id} attempt=#{@attempts} " \
               "status=#{response.status} request_id=#{safe_field(response.headers["x-request-id"])} " \

data/lib/openai/internal/stream.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../helpers/streaming/response_event_decoder"
+
 module OpenAI
   module Internal
     # @generic Elem
@@ -18,6 +20,7 @@ module OpenAI
         # rubocop:disable Metrics/BlockLength
         @iterator ||= OpenAI::Internal::Util.chain_fused(@stream) do |y|
           consume = false
+          decoder = OpenAI::Helpers::Streaming::ResponseEventDecoder.new(model: @model)
 
           @stream.each do |msg|
             next if consume
@@ -53,7 +56,7 @@ module OpenAI
                 # Some providers emit transport heartbeats as JSON events. They are not
                 # part of the API's typed streaming event surface.
                 next if unwrapped in {type: "keepalive"}
-                y << OpenAI::Internal::Type::Converter.coerce(@model, unwrapped)
+                y << decoder.decode(unwrapped)
               end
             else
             end

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

@@ -658,9 +658,9 @@ module OpenAI
               raise TypeError, "`http_client#execute` must return an OpenAI::HTTPClient::Response"
             end
 
+            http_response = log_context.response_received(http_response)
             status = http_response.status
             headers = http_response.headers
-            http_response = log_context.response_received(http_response)
             stream = http_response.body
           rescue OpenAI::Errors::APIConnectionError => e
             status = e
@@ -785,6 +785,8 @@ module OpenAI
         #
         #   @option options [Float, nil] :timeout
         #
+        #   @option options [Boolean, nil] :include_raw_body
+        #
         # @raise [OpenAI::Errors::APIError]
         # @return [Object]
         def request(req)
@@ -798,10 +800,14 @@ module OpenAI
         #
         # @param req [Hash{Symbol=>Object}]
         # @return [Array(URI::Generic, OpenAI::HTTPClient::Response, OpenAI::Internal::Logging::Context)]
-        private def perform_request(req)
+        private def perform_request(req, &response_observer)
           self.class.validate!(req)
           opts = req[:options].to_h
           OpenAI::RequestOptions.validate!(opts)
+          if req[:stream] && opts[:include_raw_body] == true
+            raise ArgumentError, "`include_raw_body` is not supported for streaming responses"
+          end
+
           request = build_request(req.except(:options), opts)
           url = request.fetch(:url)
           log_context = OpenAI::Internal::Logging::Context.new(
@@ -809,7 +815,12 @@ module OpenAI
             log_level: @log_level,
             on_retry: @on_retry,
             method: request.fetch(:method),
-            url: url
+            url: url,
+            on_response: if response_observer
+              lambda do |received_response, trusted_url, received_url|
+                response_observer.call(received_response, trusted_url, received_url)
+              end
+            end
           )
 
           # Don't send the current retry count in the headers if the caller modified the header defaults.
@@ -820,6 +831,7 @@ module OpenAI
             retry_count: 0,
             send_retry_header: send_retry_header
           ) { log_context }
+
           [url, response, log_context]
         rescue StandardError => e
           log_context&.request_failed(e)
@@ -862,8 +874,27 @@ module OpenAI
 
           unwrap = req[:unwrap]
           response_metadata = response.metadata
+          include_raw_body = req[:options].to_h[:include_raw_body] == true &&
+            (req[:page] ||
+              (model.is_a?(Class) && model <= OpenAI::Internal::Type::BaseModel) ||
+              model.is_a?(OpenAI::Internal::Type::Union))
+          raw_body = nil
+          decoded = if include_raw_body
+            OpenAI::Internal::Util.decode_content(response.headers, stream: response.body) do |body|
+              raw_body = body
+            end
+          else
+            OpenAI::Internal::Util.decode_content(response.headers, stream: response.body)
+          end
+
+          if include_raw_body && !decoded.is_a?(StringIO)
+            response_metadata = OpenAI::ResponseMetadata.new(
+              status: response.status,
+              headers: response.headers,
+              body: raw_body&.freeze
+            )
+          end
 
-          decoded = OpenAI::Internal::Util.decode_content(response.headers, stream: response.body)
           case req
           in {stream: Class => st}
             st.new(

data/lib/openai/internal/util.rb

@@ -673,13 +673,16 @@ module OpenAI
         # @param headers [Hash{String=>String}]
         # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
+        # @yieldparam [String] The buffered response body before decoding.
         #
         # @raise [JSON::ParserError]
         # @return [Object]
-        def decode_content(headers, stream:, suppress_error: false)
+        def decode_content(headers, stream:, suppress_error: false, &body_observer)
           case (content_type = headers["content-type"])
           in OpenAI::Internal::Util::JSON_CONTENT
-            return nil if (json = stream.to_a.join).empty?
+            json = stream.to_a.join
+            body_observer&.call(json)
+            return nil if json.empty?
 
             begin
               JSON.parse(json, symbolize_names: true)
@@ -703,6 +706,7 @@ module OpenAI
             decode_sse(lines)
           else
             text = stream.to_a.join
+            body_observer&.call(text)
             force_charset!(content_type, text: text)
             StringIO.new(text)
           end

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

@@ -236,6 +236,8 @@ module OpenAI
             TENANT_ADMIN_API_KEY_UPDATED = :"tenant.admin_api_key.updated"
             TENANT_ADMIN_API_KEY_DELETED = :"tenant.admin_api_key.deleted"
             TENANT_PROJECT_API_KEY_CREATED = :"tenant.project_api_key.created"
+            TENANT_TRUSTED_ACCESS_BUSINESS_VERIFICATION_STARTED = :"tenant.trusted_access.business_verification.started"
+            TENANT_TRUSTED_ACCESS_APPLICATION_SUBMITTED = :"tenant.trusted_access.application.submitted"
             TENANT_CHATGPT_ACCESS_TOKEN_REVOKED = :"tenant.chatgpt_access_token.revoked"
             TENANT_MIGRATION_COMPLETED = :"tenant.migration.completed"
             TENANT_SSO_MIGRATED = :"tenant.sso.migrated"

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

@@ -788,6 +788,8 @@ module OpenAI
             TENANT_ADMIN_API_KEY_UPDATED = :"tenant.admin_api_key.updated"
             TENANT_ADMIN_API_KEY_DELETED = :"tenant.admin_api_key.deleted"
             TENANT_PROJECT_API_KEY_CREATED = :"tenant.project_api_key.created"
+            TENANT_TRUSTED_ACCESS_BUSINESS_VERIFICATION_STARTED = :"tenant.trusted_access.business_verification.started"
+            TENANT_TRUSTED_ACCESS_APPLICATION_SUBMITTED = :"tenant.trusted_access.application.submitted"
             TENANT_CHATGPT_ACCESS_TOKEN_REVOKED = :"tenant.chatgpt_access_token.revoked"
             TENANT_MIGRATION_COMPLETED = :"tenant.migration.completed"
             TENANT_SSO_MIGRATED = :"tenant.sso.migrated"

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

@@ -10,12 +10,6 @@ module OpenAI
         #   @return [String]
         required :id, String
 
-        # @!attribute call_id
-        #   The unique ID of the function tool call generated by the model.
-        #
-        #   @return [String]
-        required :call_id, String
-
         # @!attribute output
         #   The output from the function call generated by your code. Can be a string or an
         #   list of output content.
@@ -42,6 +36,12 @@ module OpenAI
         #   @return [OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::Agent, nil]
         optional :agent, -> { OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Agent }, nil?: true
 
+        # @!attribute call_id
+        #   The unique ID of the function tool call generated by the model.
+        #
+        #   @return [String, nil]
+        optional :call_id, String
+
         # @!attribute caller_
         #   The execution context that produced this tool call.
         #
@@ -71,20 +71,20 @@ module OpenAI
         #   @return [String, nil]
         optional :namespace, String
 
-        # @!method initialize(id:, call_id:, output:, status:, agent: nil, caller_: nil, created_by: nil, name: nil, namespace: nil, type: :function_call_output)
+        # @!method initialize(id:, output:, status:, agent: nil, call_id: nil, caller_: nil, created_by: nil, name: nil, namespace: nil, type: :function_call_output)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem} for more details.
         #
         #   @param id [String] The unique ID of the function call tool output.
         #
-        #   @param call_id [String] The unique ID of the function tool call generated by the model.
-        #
         #   @param output [String, Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>] The output from the function call generated by your code.
         #
         #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::Status] The status of the item. One of `in_progress`, `completed`, or
         #
         #   @param agent [OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::Agent, nil] The agent that produced this item.
         #
+        #   @param call_id [String] The unique ID of the function tool call generated by the model.
+        #
         #   @param caller_ [OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::Caller::Direct, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::Caller::Program, nil] The execution context that produced this tool call.
         #
         #   @param created_by [String] The identifier of the actor that created the item.

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

@@ -371,12 +371,6 @@ module OpenAI
         end
 
         class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
-          # @!attribute call_id
-          #   The unique ID of the function tool call generated by the model.
-          #
-          #   @return [String]
-          required :call_id, String
-
           # @!attribute output
           #   Text, image, or file output of the function tool call.
           #
@@ -402,6 +396,12 @@ module OpenAI
           #   @return [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Agent, nil]
           optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Agent }, nil?: true
 
+          # @!attribute call_id
+          #   The unique ID of the function tool call generated by the model.
+          #
+          #   @return [String, nil]
+          optional :call_id, String, nil?: true
+
           # @!attribute caller_
           #   The execution context that produced this tool call.
           #
@@ -438,21 +438,21 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(call_id:, output:, id: nil, agent: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
+          # @!method initialize(output:, id: nil, agent: nil, call_id: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput} for more
           #   details.
           #
           #   The output of a function tool call.
           #
-          #   @param call_id [String] The unique ID of the function tool call generated by the model.
-          #
           #   @param output [String, Array<OpenAI::Models::Beta::BetaResponseInputTextContent, OpenAI::Models::Beta::BetaResponseInputImageContent, OpenAI::Models::Beta::BetaResponseInputFileContent>] Text, image, or file output of the function tool call.
           #
           #   @param id [String, nil] The unique ID of the function tool call output. Populated when this item is retu
           #
           #   @param agent [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Agent, nil] The agent that produced this item.
           #
+          #   @param call_id [String, nil] The unique ID of the function tool call generated by the model.
+          #
           #   @param caller_ [OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::Caller::Program, nil] The execution context that produced this tool call.
           #
           #   @param name [String, nil] The name of the tool that produced the output.

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

@@ -34,7 +34,16 @@ module OpenAI
         #   @return [Integer]
         required :total_tokens, Integer
 
-        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:)
+        # @!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.
+        #
         #   Represents token usage details including input tokens, output tokens, a
         #   breakdown of output tokens, and the total tokens used.
         #
@@ -47,6 +56,8 @@ 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

data/lib/openai/models/completion_usage.rb

@@ -27,13 +27,22 @@ module OpenAI
       #   @return [OpenAI::Models::CompletionUsage::CompletionTokensDetails, nil]
       optional :completion_tokens_details, -> { OpenAI::CompletionUsage::CompletionTokensDetails }
 
+      # @!attribute compute_units
+      #   Compute units for the request. Currently null when available.
+      #
+      #   @return [Integer, nil]
+      optional :compute_units, Integer, nil?: true
+
       # @!attribute prompt_tokens_details
       #   Breakdown of tokens used in the prompt.
       #
       #   @return [OpenAI::Models::CompletionUsage::PromptTokensDetails, nil]
       optional :prompt_tokens_details, -> { OpenAI::CompletionUsage::PromptTokensDetails }
 
-      # @!method initialize(completion_tokens:, prompt_tokens:, total_tokens:, completion_tokens_details: nil, prompt_tokens_details: nil)
+      # @!method initialize(completion_tokens:, prompt_tokens:, total_tokens:, completion_tokens_details: nil, compute_units: nil, prompt_tokens_details: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::CompletionUsage} for more details.
+      #
       #   Usage statistics for the completion request.
       #
       #   @param completion_tokens [Integer] Number of tokens in the generated completion.
@@ -44,6 +53,8 @@ module OpenAI
       #
       #   @param completion_tokens_details [OpenAI::Models::CompletionUsage::CompletionTokensDetails] Breakdown of tokens used in a completion.
       #
+      #   @param compute_units [Integer, nil] Compute units for the request. Currently null when available.
+      #
       #   @param prompt_tokens_details [OpenAI::Models::CompletionUsage::PromptTokensDetails] Breakdown of tokens used in the prompt.
 
       # @see OpenAI::Models::CompletionUsage#completion_tokens_details

data/lib/openai/models/responses/response_function_tool_call_output_item.rb

@@ -10,12 +10,6 @@ module OpenAI
         #   @return [String]
         required :id, String
 
-        # @!attribute call_id
-        #   The unique ID of the function tool call generated by the model.
-        #
-        #   @return [String]
-        required :call_id, String
-
         # @!attribute output
         #   The output from the function call generated by your code. Can be a string or an
         #   list of output content.
@@ -36,6 +30,12 @@ module OpenAI
         #   @return [Symbol, :function_call_output]
         required :type, const: :function_call_output
 
+        # @!attribute call_id
+        #   The unique ID of the function tool call generated by the model.
+        #
+        #   @return [String, nil]
+        optional :call_id, String
+
         # @!attribute caller_
         #   The execution context that produced this tool call.
         #
@@ -65,19 +65,19 @@ module OpenAI
         #   @return [String, nil]
         optional :namespace, String
 
-        # @!method initialize(id:, call_id:, output:, status:, caller_: nil, created_by: nil, name: nil, namespace: nil, type: :function_call_output)
+        # @!method initialize(id:, output:, status:, call_id: nil, caller_: nil, created_by: nil, name: nil, namespace: nil, type: :function_call_output)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem} for more
         #   details.
         #
         #   @param id [String] The unique ID of the function call tool output.
         #
-        #   @param call_id [String] The unique ID of the function tool call generated by the model.
-        #
         #   @param output [String, Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>] The output from the function call generated by your code.
         #
         #   @param status [Symbol, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Status] The status of the item. One of `in_progress`, `completed`, or
         #
+        #   @param call_id [String] The unique ID of the function tool call generated by the model.
+        #
         #   @param caller_ [OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Caller::Direct, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Caller::Program, nil] The execution context that produced this tool call.
         #
         #   @param created_by [String] The identifier of the actor that created the item.

data/lib/openai/models/responses/response_input_item.rb

@@ -318,12 +318,6 @@ module OpenAI
         end
 
         class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
-          # @!attribute call_id
-          #   The unique ID of the function tool call generated by the model.
-          #
-          #   @return [String]
-          required :call_id, String
-
           # @!attribute output
           #   Text, image, or file output of the function tool call.
           #
@@ -343,6 +337,12 @@ module OpenAI
           #   @return [String, nil]
           optional :id, String, nil?: true
 
+          # @!attribute call_id
+          #   The unique ID of the function tool call generated by the model.
+          #
+          #   @return [String, nil]
+          optional :call_id, String, nil?: true
+
           # @!attribute caller_
           #   The execution context that produced this tool call.
           #
@@ -377,19 +377,19 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(call_id:, output:, id: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
+          # @!method initialize(output:, id: nil, call_id: nil, caller_: nil, name: nil, namespace: nil, status: nil, type: :function_call_output)
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput} for more
           #   details.
           #
           #   The output of a function tool call.
           #
-          #   @param call_id [String] The unique ID of the function tool call generated by the model.
-          #
           #   @param output [String, Array<OpenAI::Models::Responses::ResponseInputTextContent, OpenAI::Models::Responses::ResponseInputImageContent, OpenAI::Models::Responses::ResponseInputFileContent>] Text, image, or file output of the function tool call.
           #
           #   @param id [String, nil] The unique ID of the function tool call output. Populated when this item is retu
           #
+          #   @param call_id [String, nil] The unique ID of the function tool call generated by the model.
+          #
           #   @param caller_ [OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::Caller::Direct, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::Caller::Program, nil] The execution context that produced this tool call.
           #
           #   @param name [String, nil] The name of the tool that produced the output.

data/lib/openai/models/responses/response_usage.rb

@@ -34,7 +34,16 @@ module OpenAI
         #   @return [Integer]
         required :total_tokens, Integer
 
-        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:)
+        # @!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::Responses::ResponseUsage} for more details.
+        #
         #   Represents token usage details including input tokens, output tokens, a
         #   breakdown of output tokens, and the total tokens used.
         #
@@ -47,6 +56,8 @@ module OpenAI
         #   @param output_tokens_details [OpenAI::Models::Responses::ResponseUsage::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::Responses::ResponseUsage#input_tokens_details
         class InputTokensDetails < OpenAI::Internal::Type::BaseModel

data/lib/openai/request_options.rb

@@ -65,6 +65,14 @@ module OpenAI
     #   @return [Float, nil]
     optional :timeout, Float
 
+    # @!attribute include_raw_body
+    #   Retain the exact successful HTTP response body on the returned model or
+    #   page through `last_response.body`. Body retention is disabled by default
+    #   and cannot be enabled for streaming responses.
+    #
+    #   @return [Boolean, nil]
+    optional :include_raw_body, OpenAI::Internal::Type::Boolean
+
     # @!method initialize(values = {})
     #   Returns a new instance of RequestOptions.
     #

data/lib/openai/resources/beta/responses.rb

@@ -202,7 +202,7 @@ module OpenAI
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent>]
+        # @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
         #
         # @see OpenAI::Models::Beta::ResponseCreateParams
         def stream_raw(params = {})
@@ -298,7 +298,7 @@ module OpenAI
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent>]
+        # @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::BetaResponseAudioDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioDoneEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDeltaEvent, OpenAI::Models::Beta::BetaResponseAudioTranscriptDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Beta::BetaResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Beta::BetaResponseCompletedEvent, OpenAI::Models::Beta::BetaResponseContentPartAddedEvent, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent, OpenAI::Models::Beta::BetaResponseCreatedEvent, OpenAI::Models::Beta::BetaResponseErrorEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandAddedEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallCommandDoneEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDeltaEvent, OpenAI::Models::Beta::BetaResponseShellCallOutputContentDoneEvent, OpenAI::Models::Beta::BetaResponseInProgressEvent, OpenAI::Models::Beta::BetaResponseFailedEvent, OpenAI::Models::Beta::BetaResponseIncompleteEvent, OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent, OpenAI::Models::Beta::BetaResponseOutputItemDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDeltaEvent, OpenAI::Models::Beta::BetaResponseReasoningTextDoneEvent, OpenAI::Models::Beta::BetaResponseRefusalDeltaEvent, OpenAI::Models::Beta::BetaResponseRefusalDoneEvent, OpenAI::Models::Beta::BetaResponseTextDeltaEvent, OpenAI::Models::Beta::BetaResponseTextDoneEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent, OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallCompletedEvent, OpenAI::Models::Beta::BetaResponseImageGenCallGeneratingEvent, OpenAI::Models::Beta::BetaResponseImageGenCallInProgressEvent, OpenAI::Models::Beta::BetaResponseImageGenCallPartialImageEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Beta::BetaResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Beta::BetaResponseMcpCallCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpCallFailedEvent, OpenAI::Models::Beta::BetaResponseMcpCallInProgressEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsCompletedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsFailedEvent, OpenAI::Models::Beta::BetaResponseMcpListToolsInProgressEvent, OpenAI::Models::Beta::BetaResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Beta::BetaResponseQueuedEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent, OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent, OpenAI::Streaming::UnknownStreamEvent>]
         #
         # @see OpenAI::Models::Beta::ResponseRetrieveParams
         def retrieve_streaming(response_id, params = {})