openai 0.56.0 → 0.58.0

data/lib/openai/client.rb

@@ -15,6 +15,8 @@ module OpenAI
     # Default max retry delay in seconds.
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
+    WORKLOAD_IDENTITY_API_KEY_PLACEHOLDER = "workload-identity-auth"
+
     # @return [String]
     attr_reader :api_key
 
@@ -27,6 +29,10 @@ module OpenAI
     # @return [String, nil]
     attr_reader :webhook_secret
 
+    # @return [OpenAI::Auth::WorkloadIdentityAuth, nil]
+    # @api private
+    attr_reader :workload_identity_auth
+
     # Given a prompt, the model will return one or more predicted completions, and can
     # also return the probabilities of alternative tokens at each position.
     # @return [OpenAI::Resources::Completions]
@@ -116,13 +122,48 @@ module OpenAI
       {"authorization" => "Bearer #{@api_key}"}
     end
 
+    # @api private
+    private def request_replayable?(request)
+      body = request[:body]
+      return true if body.nil? || body.is_a?(String)
+      return false if body.respond_to?(:read)
+      true
+    end
+
+    # @api private
+    private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
+      return super unless @workload_identity_auth
+
+      token = @workload_identity_auth.get_token
+      updated_headers = request[:headers].merge("authorization" => "Bearer #{token}")
+      updated_request = request.merge(headers: updated_headers)
+
+      begin
+        super(updated_request, redirect_count: redirect_count, retry_count: retry_count, send_retry_header: send_retry_header)
+      rescue OpenAI::Errors::AuthenticationError
+        raise unless retry_count.zero? && request_replayable?(request)
+        @workload_identity_auth.invalidate_token
+
+        fresh_token = @workload_identity_auth.get_token
+        refreshed_headers = request[:headers].merge("authorization" => "Bearer #{fresh_token}")
+        refreshed_request = request.merge(headers: refreshed_headers)
+
+        super(refreshed_request, redirect_count: redirect_count, retry_count: retry_count + 1, send_retry_header: send_retry_header)
+      end
+    end
+
     # Creates and returns a new client for interacting with the API.
     #
-    # @param api_key [String, nil] Defaults to `ENV["OPENAI_API_KEY"]`
+    # @param api_key [String, nil] Defaults to `ENV["OPENAI_API_KEY"]`.
+    #   Mutually exclusive with `workload_identity`.
+    #
+    # @param workload_identity [OpenAI::Auth::WorkloadIdentity, nil]
+    #   OAuth2 workload identity configuration for token exchange authentication.
+    #   Mutually exclusive with `api_key`.
     #
-    # @param organization [String, nil] Defaults to `ENV["OPENAI_ORG_ID"]`
+    # @param organization [String, nil] Defaults to `ENV["OPENAI_ORG_ID"]`.
     #
-    # @param project [String, nil] Defaults to `ENV["OPENAI_PROJECT_ID"]`
+    # @param project [String, nil] Defaults to `ENV["OPENAI_PROJECT_ID"]`.
     #
     # @param webhook_secret [String, nil] Defaults to `ENV["OPENAI_WEBHOOK_SECRET"]`
     #
@@ -138,6 +179,7 @@ module OpenAI
     # @param max_retry_delay [Float]
     def initialize(
       api_key: ENV["OPENAI_API_KEY"],
+      workload_identity: nil,
       organization: ENV["OPENAI_ORG_ID"],
       project: ENV["OPENAI_PROJECT_ID"],
       webhook_secret: ENV["OPENAI_WEBHOOK_SECRET"],
@@ -149,7 +191,20 @@ module OpenAI
     )
       base_url ||= "https://api.openai.com/v1"
 
-      if api_key.nil?
+      if workload_identity && api_key && api_key != WORKLOAD_IDENTITY_API_KEY_PLACEHOLDER
+        raise ArgumentError.new(
+          "The `api_key` and `workload_identity` arguments are mutually exclusive; " \
+          "only one can be passed at a time."
+        )
+      end
+
+      if workload_identity
+        @workload_identity_auth = OpenAI::Auth::WorkloadIdentityAuth.new(
+          workload_identity,
+          organization
+        )
+        api_key = WORKLOAD_IDENTITY_API_KEY_PLACEHOLDER
+      elsif api_key.nil?
         raise ArgumentError.new("api_key is required, and can be set via environ: \"OPENAI_API_KEY\"")
       end
 

data/lib/openai/errors.rb

@@ -263,5 +263,44 @@ module OpenAI
     class InternalServerError < OpenAI::Errors::APIStatusError
       HTTP_STATUS = (500..)
     end
+
+    class OAuthError < OpenAI::Errors::APIStatusError
+      # @return [OpenAI::Models::OAuthErrorCode::Variants, nil]
+      attr_reader :error_code
+
+      def initialize(status:, body:, headers:)
+        @error_code = OpenAI::Internal::Type::Converter.coerce(OpenAI::Models::OAuthErrorCode, body&.dig(:error))
+
+        message =
+          if body&.dig(:error_description)
+            body[:error_description]
+          elsif @error_code
+            @error_code
+          else
+            "OAuth2 authentication error"
+          end
+
+        super(
+          url: URI("https://auth.openai.com/oauth/token"),
+          status: status,
+          headers: headers,
+          body: body,
+          request: nil,
+          response: nil,
+          message: message
+        )
+      end
+    end
+
+    class SubjectTokenProviderError < OpenAI::Errors::Error
+      attr_reader :provider
+      attr_accessor :cause
+
+      def initialize(message:, provider:, cause: nil)
+        super(message)
+        @provider = provider
+        @cause = cause
+      end
+    end
   end
 end

data/lib/openai/internal/util.rb

@@ -157,7 +157,7 @@ module OpenAI
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{OpenAI::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{OpenAI::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -237,6 +237,11 @@ module OpenAI
         end
       end
 
+      # @type [Regexp]
+      #
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = /[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/
+
       class << self
         # @api private
         #
@@ -247,6 +252,15 @@ module OpenAI
           "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
+        # @api private
+        #
+        # @param path [String, Integer]
+        #
+        # @return [String]
+        def encode_path(path)
+          path.to_s.gsub(OpenAI::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +273,7 @@ module OpenAI
           in []
             ""
           in [String => p, *interpolations]
-            encoded = interpolations.map { ERB::Util.url_encode(_1) }
+            encoded = interpolations.map { encode_path(_1) }
             format(p, *encoded)
           end
         end
@@ -571,16 +585,15 @@ module OpenAI
           y << "Content-Disposition: form-data"
 
           unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
+            y << "; name=\"#{key}\""
           end
 
           case val
           in OpenAI::FilePart unless val.filename.nil?
-            filename = ERB::Util.url_encode(val.filename)
+            filename = encode_path(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(::File.basename(val.to_path))
+            filename = encode_path(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -597,6 +610,7 @@ module OpenAI
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -606,7 +620,7 @@ module OpenAI
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || OpenAI::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -622,6 +636,7 @@ module OpenAI
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private

data/lib/openai/models/conversations/conversation_item.rb

@@ -49,6 +49,9 @@ module OpenAI
         # [managing context](https://platform.openai.com/docs/guides/conversation-state).
         variant :reasoning, -> { OpenAI::Responses::ResponseReasoningItem }
 
+        # A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
+        variant :compaction, -> { OpenAI::Responses::ResponseCompactionItem }
+
         # A tool call to run code.
         variant :code_interpreter_call, -> { OpenAI::Responses::ResponseCodeInterpreterToolCall }
 
@@ -608,7 +611,7 @@ module OpenAI
         end
 
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput)]
+        #   @return [Array(OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput)]
       end
     end
 

data/lib/openai/models/conversations/conversation_item_list.rb

@@ -8,7 +8,7 @@ module OpenAI
         # @!attribute data
         #   A list of conversation items.
         #
-        #   @return [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
+        #   @return [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
         required :data, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Conversations::ConversationItem] }
 
         # @!attribute first_id
@@ -38,7 +38,7 @@ module OpenAI
         # @!method initialize(data:, first_id:, has_more:, last_id:, object: :list)
         #   A list of Conversation items.
         #
-        #   @param data [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>] A list of conversation items.
+        #   @param data [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>] A list of conversation items.
         #
         #   @param first_id [String] The ID of the first item in the list.
         #

data/lib/openai/models/conversations/message.rb

@@ -36,7 +36,16 @@ module OpenAI
         #   @return [Symbol, :message]
         required :type, const: :message
 
-        # @!method initialize(id:, content:, role:, status:, type: :message)
+        # @!attribute phase
+        #   Labels an `assistant` message as intermediate commentary (`commentary`) or the
+        #   final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+        #   sending follow-up requests, preserve and resend phase on all assistant messages
+        #   — dropping it can degrade performance. Not used for user messages.
+        #
+        #   @return [Symbol, OpenAI::Models::Conversations::Message::Phase, nil]
+        optional :phase, enum: -> { OpenAI::Conversations::Message::Phase }, nil?: true
+
+        # @!method initialize(id:, content:, role:, status:, phase: nil, type: :message)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Conversations::Message} for more details.
         #
@@ -50,6 +59,8 @@ module OpenAI
         #
         #   @param status [Symbol, OpenAI::Models::Conversations::Message::Status] The status of item. One of `in_progress`, `completed`, or `incomplete`. Populate
         #
+        #   @param phase [Symbol, OpenAI::Models::Conversations::Message::Phase, nil] Labels an `assistant` message as intermediate commentary (`commentary`) or the f
+        #
         #   @param type [Symbol, :message] The type of the message. Always set to `message`.
 
         # A content part that makes up an input or output item.
@@ -144,6 +155,22 @@ module OpenAI
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # Labels an `assistant` message as intermediate commentary (`commentary`) or the
+        # final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+        # sending follow-up requests, preserve and resend phase on all assistant messages
+        # — dropping it can degrade performance. Not used for user messages.
+        #
+        # @see OpenAI::Models::Conversations::Message#phase
+        module Phase
+          extend OpenAI::Internal::Type::Enum
+
+          COMMENTARY = :commentary
+          FINAL_ANSWER = :final_answer
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/openai/models/oauth_error_code.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module OAuthErrorCode
+      extend OpenAI::Internal::Type::Union
+
+      variant const: -> { OpenAI::Models::OAuthErrorCode::INVALID_GRANT }
+
+      variant const: -> { OpenAI::Models::OAuthErrorCode::INVALID_SUBJECT_TOKEN }
+
+      variant String
+
+      # @!method self.variants
+      #   @return [Array(Symbol, String)]
+
+      define_sorbet_constant!(:Variants) do
+        T.type_alias { T.any(OpenAI::OAuthErrorCode::TaggedSymbol, String) }
+      end
+
+      # @!group
+
+      INVALID_GRANT = :invalid_grant
+      INVALID_SUBJECT_TOKEN = :invalid_subject_token
+
+      # @!endgroup
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_session_create_request.rb

@@ -88,8 +88,9 @@ module OpenAI
 
         # @!attribute tracing
         #   Realtime API can write session traces to the
-        #   [Traces Dashboard](/logs?api=traces). Set to null to disable tracing. Once
-        #   tracing is enabled for a session, the configuration cannot be modified.
+        #   [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to
+        #   disable tracing. Once tracing is enabled for a session, the configuration cannot
+        #   be modified.
         #
         #   `auto` will create a trace for the session with default values for the workflow
         #   name, group id, and metadata.
@@ -144,7 +145,7 @@ module OpenAI
         #
         #   @param tools [Array<OpenAI::Models::Realtime::RealtimeFunctionTool, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp>] Tools available to the model.
         #
-        #   @param tracing [Symbol, :auto, OpenAI::Models::Realtime::RealtimeTracingConfig::TracingConfiguration, nil] Realtime API can write session traces to the [Traces Dashboard](/logs?api=traces
+        #   @param tracing [Symbol, :auto, OpenAI::Models::Realtime::RealtimeTracingConfig::TracingConfiguration, nil] Realtime API can write session traces to the [Traces Dashboard](https://platform
         #
         #   @param truncation [Symbol, OpenAI::Models::Realtime::RealtimeTruncation::RealtimeTruncationStrategy, OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio] When the number of tokens in a conversation exceeds the model's input token limi
         #

data/lib/openai/models/realtime/realtime_session_create_response.rb

@@ -96,8 +96,9 @@ module OpenAI
 
         # @!attribute tracing
         #   Realtime API can write session traces to the
-        #   [Traces Dashboard](/logs?api=traces). Set to null to disable tracing. Once
-        #   tracing is enabled for a session, the configuration cannot be modified.
+        #   [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to
+        #   disable tracing. Once tracing is enabled for a session, the configuration cannot
+        #   be modified.
         #
         #   `auto` will create a trace for the session with default values for the workflow
         #   name, group id, and metadata.
@@ -155,7 +156,7 @@ module OpenAI
         #
         #   @param tools [Array<OpenAI::Models::Realtime::RealtimeFunctionTool, OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Tool::McpTool>] Tools available to the model.
         #
-        #   @param tracing [Symbol, :auto, OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Tracing::TracingConfiguration, nil] Realtime API can write session traces to the [Traces Dashboard](/logs?api=traces
+        #   @param tracing [Symbol, :auto, OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Tracing::TracingConfiguration, nil] Realtime API can write session traces to the [Traces Dashboard](https://platform
         #
         #   @param truncation [Symbol, OpenAI::Models::Realtime::RealtimeTruncation::RealtimeTruncationStrategy, OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio] When the number of tokens in a conversation exceeds the model's input token limi
         #
@@ -1024,8 +1025,9 @@ module OpenAI
         end
 
         # Realtime API can write session traces to the
-        # [Traces Dashboard](/logs?api=traces). Set to null to disable tracing. Once
-        # tracing is enabled for a session, the configuration cannot be modified.
+        # [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to
+        # disable tracing. Once tracing is enabled for a session, the configuration cannot
+        # be modified.
         #
         # `auto` will create a trace for the session with default values for the workflow
         # name, group id, and metadata.

data/lib/openai/models/realtime/realtime_tracing_config.rb

@@ -4,8 +4,9 @@ module OpenAI
   module Models
     module Realtime
       # Realtime API can write session traces to the
-      # [Traces Dashboard](/logs?api=traces). Set to null to disable tracing. Once
-      # tracing is enabled for a session, the configuration cannot be modified.
+      # [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to
+      # disable tracing. Once tracing is enabled for a session, the configuration cannot
+      # be modified.
       #
       # `auto` will create a trace for the session with default values for the workflow
       # name, group id, and metadata.

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

@@ -27,7 +27,7 @@ module OpenAI
         #   The compacted list of output items. This is a list of all user messages,
         #   followed by a single compaction item.
         #
-        #   @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall>]
+        #   @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>]
         required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputItem] }
 
         # @!attribute usage
@@ -45,7 +45,7 @@ module OpenAI
         #
         #   @param created_at [Integer] Unix timestamp (in seconds) when the compacted conversation was created.
         #
-        #   @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall>] The compacted list of output items. This is a list of all user messages, followe
+        #   @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>] The compacted list of output items. This is a list of all user messages, followe
         #
         #   @param usage [OpenAI::Models::Responses::ResponseUsage] Token accounting for the compaction pass, including cached, reasoning, and total
         #

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

@@ -62,7 +62,13 @@ module OpenAI
           #   @return [Integer]
           required :y_, Integer, api_name: :y
 
-          # @!method initialize(button:, x:, y_:, type: :click)
+          # @!attribute keys
+          #   The keys being held while clicking.
+          #
+          #   @return [Array<String>, nil]
+          optional :keys, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!method initialize(button:, x:, y_:, keys: nil, type: :click)
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Responses::ComputerAction::Click} for more details.
           #
@@ -74,6 +80,8 @@ module OpenAI
           #
           #   @param y_ [Integer] The y-coordinate where the click occurred.
           #
+          #   @param keys [Array<String>, nil] The keys being held while clicking.
+          #
           #   @param type [Symbol, :click] Specifies the event type. For a click action, this property is always `click`.
 
           # Indicates which mouse button was pressed during the click. One of `left`,
@@ -95,6 +103,12 @@ module OpenAI
         end
 
         class DoubleClick < OpenAI::Internal::Type::BaseModel
+          # @!attribute keys
+          #   The keys being held while double-clicking.
+          #
+          #   @return [Array<String>, nil]
+          required :keys, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
           # @!attribute type
           #   Specifies the event type. For a double click action, this property is always set
           #   to `double_click`.
@@ -114,12 +128,14 @@ module OpenAI
           #   @return [Integer]
           required :y_, Integer, api_name: :y
 
-          # @!method initialize(x:, y_:, type: :double_click)
+          # @!method initialize(keys:, x:, y_:, type: :double_click)
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Responses::ComputerAction::DoubleClick} for more details.
           #
           #   A double click action.
           #
+          #   @param keys [Array<String>, nil] The keys being held while double-clicking.
+          #
           #   @param x [Integer] The x-coordinate where the double click occurred.
           #
           #   @param y_ [Integer] The y-coordinate where the double click occurred.
@@ -149,7 +165,13 @@ module OpenAI
           #   @return [Symbol, :drag]
           required :type, const: :drag
 
-          # @!method initialize(path:, type: :drag)
+          # @!attribute keys
+          #   The keys being held while dragging the mouse.
+          #
+          #   @return [Array<String>, nil]
+          optional :keys, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!method initialize(path:, keys: nil, type: :drag)
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Responses::ComputerAction::Drag} for more details.
           #
@@ -157,6 +179,8 @@ module OpenAI
           #
           #   @param path [Array<OpenAI::Models::Responses::ComputerAction::Drag::Path>] An array of coordinates representing the path of the drag action. Coordinates wi
           #
+          #   @param keys [Array<String>, nil] The keys being held while dragging the mouse.
+          #
           #   @param type [Symbol, :drag] Specifies the event type. For a drag action, this property is always set to `dra
 
           class Path < OpenAI::Internal::Type::BaseModel
@@ -227,7 +251,13 @@ module OpenAI
           #   @return [Integer]
           required :y_, Integer, api_name: :y
 
-          # @!method initialize(x:, y_:, type: :move)
+          # @!attribute keys
+          #   The keys being held while moving the mouse.
+          #
+          #   @return [Array<String>, nil]
+          optional :keys, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!method initialize(x:, y_:, keys: nil, type: :move)
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Responses::ComputerAction::Move} for more details.
           #
@@ -237,6 +267,8 @@ module OpenAI
           #
           #   @param y_ [Integer] The y-coordinate to move to.
           #
+          #   @param keys [Array<String>, nil] The keys being held while moving the mouse.
+          #
           #   @param type [Symbol, :move] Specifies the event type. For a move action, this property is always set to `mov
         end
 
@@ -289,7 +321,13 @@ module OpenAI
           #   @return [Integer]
           required :y_, Integer, api_name: :y
 
-          # @!method initialize(scroll_x:, scroll_y:, x:, y_:, type: :scroll)
+          # @!attribute keys
+          #   The keys being held while scrolling.
+          #
+          #   @return [Array<String>, nil]
+          optional :keys, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!method initialize(scroll_x:, scroll_y:, x:, y_:, keys: nil, type: :scroll)
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Responses::ComputerAction::Scroll} for more details.
           #
@@ -303,6 +341,8 @@ module OpenAI
           #
           #   @param y_ [Integer] The y-coordinate where the scroll occurred.
           #
+          #   @param keys [Array<String>, nil] The keys being held while scrolling.
+          #
           #   @param type [Symbol, :scroll] Specifies the event type. For a scroll action, this property is always set to `s
         end
 

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

@@ -77,7 +77,7 @@ module OpenAI
         #     an `assistant` message with the content generated by the model, you might
         #     consider using the `output_text` property where supported in SDKs.
         #
-        #   @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall>]
+        #   @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>]
         required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputItem] }
 
         # @!attribute parallel_tool_calls
@@ -344,7 +344,7 @@ module OpenAI
         #
         #   @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
         #
-        #   @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall>] An array of content items generated by the model.
+        #   @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>] An array of content items generated by the model.
         #
         #   @param parallel_tool_calls [Boolean] Whether to allow the model to run tool calls in parallel.
         #