openai 0.62.0 → 0.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b8ba7d86e2a095f264f3249f65a5b7023ed92f5d72b254537d2131343d008d1
-  data.tar.gz: b2473fbb12916be311368b3ce12ec183118c94fecba86145f0765ddb261d34be
+  metadata.gz: 203d9e376cc905b1f7e8ab54ea027ef0fa34f8805af1f5f5b3fd059ca2fd14ce
+  data.tar.gz: d8e36ae499dafbd17b0dedbfa936d56477d9fe1321f9f7be250131fb32a11166
 SHA512:
-  metadata.gz: 4c6c2cdd0fb69bcf6df1bedab9f82904812aedcca80e43dc378eb36c213b1975b439040c26432ab29ddac79c938c361000f7de2508255632eea04dc220593bfa
-  data.tar.gz: 99dba44fb87261cefba089bfea34b90d09848e85e4be6e682f277c1a8f9a6cbfb9d7a51b9f99b918e0fe5ebc80f3321180af4ebde21268d920ed9e09cf103321
+  metadata.gz: 99c9d82e00bd89dab3cad83c519d4d297ca7beff234305489701ae7a0378f2aa3c2966d8cb4badba04bc24ef64006816f472f837a5f2ddaacd5d397b17852013
+  data.tar.gz: 9b4f401e37a6fe5dd082226782cbef164b0fffae137f98f5c789157bcda5e78d8d82dcc1639ea495d3ce2225eb2251d44bb19a4b6a6aa2e3030175bcc8c373bb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.63.0 (2026-05-13)
+
+Full Changelog: [v0.62.0...v0.63.0](https://github.com/openai/openai-ruby/compare/v0.62.0...v0.63.0)
+
+### Features
+
+* **api:** add service_tier parameter to responses compact method ([b0ed0cb](https://github.com/openai/openai-ruby/commit/b0ed0cbce8afbf6a2d099dbfed4c4d734ac10d0d))
+
 ## 0.62.0 (2026-05-07)
 
 Full Changelog: [v0.61.0...v0.62.0](https://github.com/openai/openai-ruby/compare/v0.61.0...v0.62.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openai", "~> 0.62.0"
+gem "openai", "~> 0.63.0"
 ```
 
 <!-- x-release-please-end -->
@@ -111,6 +111,7 @@ Note that you can also pass a raw `IO` descriptor, but this disables retries, as
 
 For secure, automated environments like cloud-managed Kubernetes, Azure, and GCP, you can use workload identity authentication with short-lived tokens from cloud identity providers instead of long-lived API keys.
 
+`client_id` remains available as an optional parameter for token exchange setups that require an explicit OAuth client ID.
 
 ### Kubernetes Service Account
 
@@ -121,7 +122,6 @@ require "openai"
 provider = OpenAI::Auth::SubjectTokenProviders::K8sServiceAccountTokenProvider.new
 
 workload_identity = OpenAI::Auth::WorkloadIdentity.new(
-  client_id: ENV["OAUTH_CLIENT_ID"], # This is the default and can be omitted
   identity_provider_id: ENV["IDENTITY_PROVIDER_ID"], # This is the default and can be omitted
   service_account_id: ENV["SERVICE_ACCOUNT_ID"], # This is the default and can be omitted
   provider: provider
@@ -143,7 +143,6 @@ response = client.chat.completions.create(
 provider = OpenAI::Auth::SubjectTokenProviders::AzureManagedIdentityTokenProvider.new
 
 workload_identity = OpenAI::Auth::WorkloadIdentity.new(
-  client_id: ENV["OAUTH_CLIENT_ID"], # This is the default and can be omitted
   identity_provider_id: ENV["IDENTITY_PROVIDER_ID"], # This is the default and can be omitted
   service_account_id: ENV["SERVICE_ACCOUNT_ID"], # This is the default and can be omitted
   provider: provider
@@ -160,7 +159,6 @@ client = OpenAI::Client.new(
 provider = OpenAI::Auth::SubjectTokenProviders::GCPIDTokenProvider.new
 
 workload_identity = OpenAI::Auth::WorkloadIdentity.new(
-  client_id: ENV["OAUTH_CLIENT_ID"], # This is the default and can be omitted
   identity_provider_id: ENV["IDENTITY_PROVIDER_ID"], # This is the default and can be omitted
   service_account_id: ENV["SERVICE_ACCOUNT_ID"], # This is the default and can be omitted
   provider: provider
@@ -191,7 +189,6 @@ end
 provider = CustomProvider.new
 
 workload_identity = OpenAI::Auth::WorkloadIdentity.new(
-  client_id: ENV["OAUTH_CLIENT_ID"], # This is the default and can be omitted
   identity_provider_id: ENV["IDENTITY_PROVIDER_ID"], # This is the default and can be omitted
   service_account_id: ENV["SERVICE_ACCOUNT_ID"], # This is the default and can be omitted
   provider: provider

data/lib/openai/auth/workload_identity.rb

@@ -6,13 +6,13 @@ module OpenAI
       attr_reader :client_id, :identity_provider_id, :service_account_id, :provider, :refresh_buffer_seconds
 
       def initialize(
-        client_id:,
         identity_provider_id:,
         service_account_id:,
         provider:,
+        client_id: nil,
         refresh_buffer_seconds: 1200
       )
-        @client_id = client_id.to_s
+        @client_id = client_id&.to_s
         @identity_provider_id = identity_provider_id.to_s
         @service_account_id = service_account_id.to_s
         @provider = provider

data/lib/openai/auth/workload_identity_auth.rb

@@ -92,14 +92,15 @@ module OpenAI
 
         request = Net::HTTP::Post.new(@token_exchange_url)
         request["Content-Type"] = "application/json"
-        request.body = JSON.generate(
+        body = {
           grant_type: TOKEN_EXCHANGE_GRANT_TYPE,
-          client_id: @config.client_id,
           subject_token: subject_token,
           subject_token_type: subject_token_type,
           identity_provider_id: @config.identity_provider_id,
           service_account_id: @config.service_account_id
-        )
+        }
+        body[:client_id] = @config.client_id unless @config.client_id.nil?
+        request.body = JSON.generate(body)
 
         response = Net::HTTP.start(
           @token_exchange_url.hostname,

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

@@ -56,7 +56,13 @@ module OpenAI
                  enum: -> { OpenAI::Responses::ResponseCompactParams::PromptCacheRetention },
                  nil?: true
 
-        # @!method initialize(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_retention: nil, request_options: {})
+        # @!attribute service_tier
+        #   The service tier to use for this request.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::ResponseCompactParams::ServiceTier, nil]
+        optional :service_tier, enum: -> { OpenAI::Responses::ResponseCompactParams::ServiceTier }, nil?: true
+
+        # @!method initialize(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_retention: nil, service_tier: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseCompactParams} for more details.
         #
@@ -72,6 +78,8 @@ module OpenAI
         #
         #   @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponseCompactParams::PromptCacheRetention, nil] How long to retain a prompt cache entry created by this request.
         #
+        #   @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCompactParams::ServiceTier, nil] The service tier to use for this request.
+        #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
         # Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a
@@ -401,6 +409,19 @@ module OpenAI
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # The service tier to use for this request.
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO = :auto
+          DEFAULT = :default
+          FLEX = :flex
+          PRIORITY = :priority
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/openai/resources/responses.rb

@@ -483,7 +483,7 @@ module OpenAI
       # For ZDR-compatible compaction details, see
       # [Compaction (advanced)](https://platform.openai.com/docs/guides/conversation-state#compaction-advanced).
       #
-      # @overload compact(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_retention: nil, request_options: {})
+      # @overload compact(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_retention: nil, service_tier: nil, request_options: {})
       #
       # @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wi
       #
@@ -497,6 +497,8 @@ module OpenAI
       #
       # @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponseCompactParams::PromptCacheRetention, nil] How long to retain a prompt cache entry created by this request.
       #
+      # @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCompactParams::ServiceTier, nil] The service tier to use for this request.
+      #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OpenAI::Models::Responses::CompactedResponse]

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.62.0"
+  VERSION = "0.63.0"
 end

data/rbi/openai/auth.rbi

@@ -18,7 +18,7 @@ module OpenAI
     end
 
     class WorkloadIdentity
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_reader :client_id
 
       sig { returns(String) }
@@ -35,18 +35,18 @@ module OpenAI
 
       sig do
         params(
-          client_id: T.any(String, Symbol),
           identity_provider_id: T.any(String, Symbol),
           service_account_id: T.any(String, Symbol),
           provider: SubjectTokenProvider,
+          client_id: T.nilable(T.any(String, Symbol)),
           refresh_buffer_seconds: Integer
         ).void
       end
       def initialize(
-        client_id:,
         identity_provider_id:,
         service_account_id:,
         provider:,
+        client_id: nil,
         refresh_buffer_seconds: 1200
       )
       end

data/rbi/openai/models/responses/response_compact_params.rbi

@@ -68,6 +68,16 @@ module OpenAI
         end
         attr_accessor :prompt_cache_retention
 
+        # The service tier to use for this request.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Responses::ResponseCompactParams::ServiceTier::OrSymbol
+            )
+          )
+        end
+        attr_accessor :service_tier
+
         sig do
           params(
             model:
@@ -88,6 +98,10 @@ module OpenAI
               T.nilable(
                 OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::OrSymbol
               ),
+            service_tier:
+              T.nilable(
+                OpenAI::Responses::ResponseCompactParams::ServiceTier::OrSymbol
+              ),
             request_options: OpenAI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -114,6 +128,8 @@ module OpenAI
           prompt_cache_key: nil,
           # How long to retain a prompt cache entry created by this request.
           prompt_cache_retention: nil,
+          # The service tier to use for this request.
+          service_tier: nil,
           request_options: {}
         )
         end
@@ -139,6 +155,10 @@ module OpenAI
                 T.nilable(
                   OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::OrSymbol
                 ),
+              service_tier:
+                T.nilable(
+                  OpenAI::Responses::ResponseCompactParams::ServiceTier::OrSymbol
+                ),
               request_options: OpenAI::RequestOptions
             }
           )
@@ -705,6 +725,51 @@ module OpenAI
           def self.values
           end
         end
+
+        # The service tier to use for this request.
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::ResponseCompactParams::ServiceTier
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AUTO =
+            T.let(
+              :auto,
+              OpenAI::Responses::ResponseCompactParams::ServiceTier::TaggedSymbol
+            )
+          DEFAULT =
+            T.let(
+              :default,
+              OpenAI::Responses::ResponseCompactParams::ServiceTier::TaggedSymbol
+            )
+          FLEX =
+            T.let(
+              :flex,
+              OpenAI::Responses::ResponseCompactParams::ServiceTier::TaggedSymbol
+            )
+          PRIORITY =
+            T.let(
+              :priority,
+              OpenAI::Responses::ResponseCompactParams::ServiceTier::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseCompactParams::ServiceTier::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/openai/resources/responses.rbi

@@ -994,6 +994,10 @@ module OpenAI
             T.nilable(
               OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::OrSymbol
             ),
+          service_tier:
+            T.nilable(
+              OpenAI::Responses::ResponseCompactParams::ServiceTier::OrSymbol
+            ),
           request_options: OpenAI::RequestOptions::OrHash
         ).returns(OpenAI::Responses::CompactedResponse)
       end
@@ -1020,6 +1024,8 @@ module OpenAI
         prompt_cache_key: nil,
         # How long to retain a prompt cache entry created by this request.
         prompt_cache_retention: nil,
+        # The service tier to use for this request.
+        service_tier: nil,
         request_options: {}
       )
       end

data/sig/openai/models/responses/response_compact_params.rbs

@@ -8,7 +8,8 @@ module OpenAI
           instructions: String?,
           previous_response_id: String?,
           prompt_cache_key: String?,
-          prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?
+          prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?,
+          service_tier: OpenAI::Models::Responses::ResponseCompactParams::service_tier?
         }
         & OpenAI::Internal::Type::request_parameters
 
@@ -28,6 +29,8 @@ module OpenAI
 
         attr_accessor prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?
 
+        attr_accessor service_tier: OpenAI::Models::Responses::ResponseCompactParams::service_tier?
+
         def initialize: (
           model: OpenAI::Models::Responses::ResponseCompactParams::model?,
           ?input: OpenAI::Models::Responses::ResponseCompactParams::input?,
@@ -35,6 +38,7 @@ module OpenAI
           ?previous_response_id: String?,
           ?prompt_cache_key: String?,
           ?prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?,
+          ?service_tier: OpenAI::Models::Responses::ResponseCompactParams::service_tier?,
           ?request_options: OpenAI::request_opts
         ) -> void
 
@@ -45,6 +49,7 @@ module OpenAI
           previous_response_id: String?,
           prompt_cache_key: String?,
           prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?,
+          service_tier: OpenAI::Models::Responses::ResponseCompactParams::service_tier?,
           request_options: OpenAI::RequestOptions
         }
 
@@ -263,6 +268,19 @@ module OpenAI
 
           def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention]
         end
+
+        type service_tier = :auto | :default | :flex | :priority
+
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO: :auto
+          DEFAULT: :default
+          FLEX: :flex
+          PRIORITY: :priority
+
+          def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCompactParams::service_tier]
+        end
       end
     end
   end

data/sig/openai/resources/responses.rbs

@@ -130,6 +130,7 @@ module OpenAI
         ?previous_response_id: String?,
         ?prompt_cache_key: String?,
         ?prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?,
+        ?service_tier: OpenAI::Models::Responses::ResponseCompactParams::service_tier?,
         ?request_options: OpenAI::request_opts
       ) -> OpenAI::Responses::CompactedResponse
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.62.0
+  version: 0.63.0
 platform: ruby
 authors:
 - OpenAI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-07 00:00:00.000000000 Z
+date: 2026-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64