openai 0.114.0 → 0.115.0

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::ExternalKeys#delete
+        class ExternalKeyDeleteParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute external_key_id
+          #
+          #   @return [String]
+          required :external_key_id, String
+
+          # @!method initialize(external_key_id:, request_options: {})
+          #   @param external_key_id [String]
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::ExternalKeys#list
+        class ExternalKeyListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute after
+          #
+          #   @return [String, nil]
+          optional :after, String, nil?: true
+
+          # @!attribute limit
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!attribute order
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyListParams::Order, nil]
+          optional :order, enum: -> { OpenAI::Admin::Organization::ExternalKeyListParams::Order }
+
+          # @!attribute purpose
+          #   Filter by key purpose. When omitted, returns keys of all purposes.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyListParams::Purpose, nil]
+          optional :purpose, enum: -> { OpenAI::Admin::Organization::ExternalKeyListParams::Purpose }
+
+          # @!method initialize(after: nil, limit: nil, order: nil, purpose: nil, request_options: {})
+          #   @param after [String, nil]
+          #
+          #   @param limit [Integer]
+          #
+          #   @param order [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyListParams::Order]
+          #
+          #   @param purpose [Symbol, OpenAI::Models::Admin::Organization::ExternalKeyListParams::Purpose]
+          #     Filter by key purpose. When omitted, returns keys of all purposes.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          module Order
+            extend OpenAI::Internal::Type::Enum
+
+            ASC = :asc
+            DESC = :desc
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Filter by key purpose. When omitted, returns keys of all purposes.
+          module Purpose
+            extend OpenAI::Internal::Type::Enum
+
+            EKM = :ekm
+            PSP_DECRYPTION = :psp_decryption
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::ExternalKeys#retrieve
+        class ExternalKeyRetrieveParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute external_key_id
+          #
+          #   @return [String]
+          required :external_key_id, String
+
+          # @!method initialize(external_key_id:, request_options: {})
+          #   @param external_key_id [String]
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::ExternalKeys#validate
+        class ExternalKeyValidateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute external_key_id
+          #
+          #   @return [String]
+          required :external_key_id, String
+
+          # @!method initialize(external_key_id:, request_options: {})
+          #   @param external_key_id [String]
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::ExternalKeys#validate
+        class ExternalKeyValidateResponse < OpenAI::Internal::Type::BaseModel
+          # @!attribute status
+          #
+          #   @return [String]
+          required :status, String
+
+          # @!method initialize(status:)
+          #   @param status [String]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/audio/speech_model.rb

@@ -6,9 +6,21 @@ module OpenAI
       module SpeechModel
         extend OpenAI::Internal::Type::Enum
 
+        # @deprecated Announced shutdown date: 2027-01-06. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         TTS_1 = :"tts-1"
+        # @deprecated Announced shutdown date: 2027-01-06. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         TTS_1_HD = :"tts-1-hd"
+        # @deprecated Announced shutdown date: 2027-01-06. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         GPT_4O_MINI_TTS = :"gpt-4o-mini-tts"
+        # @deprecated Announced shutdown date: 2027-01-06. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         GPT_4O_MINI_TTS_2025_12_15 = :"gpt-4o-mini-tts-2025-12-15"
 
         # @!method self.values

data/lib/openai/models/audio_model.rb

@@ -5,11 +5,26 @@ module OpenAI
     module AudioModel
       extend OpenAI::Internal::Type::Enum
 
+      # @deprecated Announced shutdown date: 2027-02-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       WHISPER_1 = :"whisper-1"
       GPT_TRANSCRIBE = :"gpt-transcribe"
+      # @deprecated Announced shutdown date: 2027-02-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_TRANSCRIBE = :"gpt-4o-transcribe"
+      # @deprecated Announced shutdown date: 2027-02-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_MINI_TRANSCRIBE = :"gpt-4o-mini-transcribe"
+      # @deprecated Announced shutdown date: 2027-02-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_MINI_TRANSCRIBE_2025_12_15 = :"gpt-4o-mini-transcribe-2025-12-15"
+      # @deprecated Announced shutdown date: 2027-02-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_TRANSCRIBE_DIARIZE = :"gpt-4o-transcribe-diarize"
 
       # @!method self.values

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

@@ -84,7 +84,19 @@ module OpenAI
         #   @return [Integer]
         required :updated_at, Integer
 
-        # @!method initialize(id:, created_at:, instructions:, metadata:, model:, multi_agent:, name:, reasoning:, service_tier:, text:, tools:, updated_at:, object: :agent)
+        # @!attribute compaction
+        #   The effective context compaction settings.
+        #
+        #   @return [OpenAI::Models::Beta::Agent::Compaction, nil]
+        optional :compaction, -> { OpenAI::Beta::Agent::Compaction }
+
+        # @!attribute experimental
+        #   The effective experimental settings for the agent.
+        #
+        #   @return [OpenAI::Models::Beta::Agent::Experimental, nil]
+        optional :experimental, -> { OpenAI::Beta::Agent::Experimental }
+
+        # @!method initialize(id:, created_at:, instructions:, metadata:, model:, multi_agent:, name:, reasoning:, service_tier:, text:, tools:, updated_at:, compaction: nil, experimental: nil, object: :agent)
         #   A reusable agent scoped to the caller's project.
         #
         #   @param id [String]
@@ -124,6 +136,12 @@ module OpenAI
         #   @param updated_at [Integer]
         #     The Unix timestamp, in seconds, when the agent was last updated.
         #
+        #   @param compaction [OpenAI::Models::Beta::Agent::Compaction]
+        #     The effective context compaction settings.
+        #
+        #   @param experimental [OpenAI::Models::Beta::Agent::Experimental]
+        #     The effective experimental settings for the agent.
+        #
         #   @param object [Symbol, :agent]
         #     The object type. Always `agent`.
 
@@ -143,6 +161,36 @@ module OpenAI
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see OpenAI::Models::Beta::Agent#compaction
+        class Compaction < OpenAI::Internal::Type::BaseModel
+          # @!attribute async
+          #   Whether context is compacted in the background. Defaults to true.
+          #
+          #   @return [Boolean]
+          required :async, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(async:)
+          #   The effective context compaction settings.
+          #
+          #   @param async [Boolean]
+          #     Whether context is compacted in the background. Defaults to true.
+        end
+
+        # @see OpenAI::Models::Beta::Agent#experimental
+        class Experimental < OpenAI::Internal::Type::BaseModel
+          # @!attribute time_awareness
+          #   Whether the model receives periodic current-time reminders.
+          #
+          #   @return [Boolean]
+          required :time_awareness, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(time_awareness:)
+          #   The effective experimental settings for the agent.
+          #
+          #   @param time_awareness [Boolean]
+          #     Whether the model receives periodic current-time reminders.
+        end
       end
     end
   end

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

@@ -14,6 +14,18 @@ module OpenAI
         #   @return [String]
         required :model, String
 
+        # @!attribute compaction
+        #   Context compaction settings. Omission or null enables background compaction.
+        #
+        #   @return [OpenAI::Models::Beta::AgentCreateParams::Compaction, nil]
+        optional :compaction, -> { OpenAI::Beta::AgentCreateParams::Compaction }, nil?: true
+
+        # @!attribute experimental
+        #   Experimental agent settings. All experimental features default to disabled.
+        #
+        #   @return [OpenAI::Models::Beta::AgentCreateParams::Experimental, nil]
+        optional :experimental, -> { OpenAI::Beta::AgentCreateParams::Experimental }
+
         # @!attribute instructions
         #   Additional instructions appended to the agent's default base instructions. Omit
         #   or set to null to add no custom instructions.
@@ -71,10 +83,16 @@ module OpenAI
           nil?: true
         )
 
-        # @!method initialize(model:, instructions: nil, metadata: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
+        # @!method initialize(model:, compaction: nil, experimental: nil, instructions: nil, metadata: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
         #   @param model [String]
         #     The model to use for the agent. The requested model name is preserved.
         #
+        #   @param compaction [OpenAI::Models::Beta::AgentCreateParams::Compaction, nil]
+        #     Context compaction settings. Omission or null enables background compaction.
+        #
+        #   @param experimental [OpenAI::Models::Beta::AgentCreateParams::Experimental]
+        #     Experimental agent settings. All experimental features default to disabled.
+        #
         #   @param instructions [String, nil]
         #     Additional instructions appended to the agent's default base instructions. Omit
         #     or set to null to add no custom instructions.
@@ -106,6 +124,38 @@ module OpenAI
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
+        class Compaction < OpenAI::Internal::Type::BaseModel
+          # @!attribute async
+          #   Whether to compact context in the background. Omission or null defaults to true.
+          #   Set to false to use blocking compaction. Background compaction may increase
+          #   token usage.
+          #
+          #   @return [Boolean, nil]
+          optional :async, OpenAI::Internal::Type::Boolean, nil?: true
+
+          # @!method initialize(async: nil)
+          #   Context compaction settings. Omission or null enables background compaction.
+          #
+          #   @param async [Boolean, nil]
+          #     Whether to compact context in the background. Omission or null defaults to true.
+          #     Set to false to use blocking compaction. Background compaction may increase
+          #     token usage.
+        end
+
+        class Experimental < OpenAI::Internal::Type::BaseModel
+          # @!attribute time_awareness
+          #   Whether to give the model periodic current-time reminders. Defaults to false.
+          #
+          #   @return [Boolean, nil]
+          optional :time_awareness, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(time_awareness: nil)
+          #   Experimental agent settings. All experimental features default to disabled.
+          #
+          #   @param time_awareness [Boolean]
+          #     Whether to give the model periodic current-time reminders. Defaults to false.
+        end
+
         # The service tier used for model requests. Defaults to `auto`.
         module ServiceTier
           extend OpenAI::Internal::Type::Enum

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

@@ -80,6 +80,13 @@ module OpenAI
         #   @return [Array<String>]
         required :vault_ids, OpenAI::Internal::Type::ArrayOf[String]
 
+        # @!attribute review
+        #   Review applied to eligible actions in this session. Omitted when review is none
+        #   and automatic review is not enabled. Omission means none.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentSession::Review, nil]
+        optional :review, enum: -> { OpenAI::Beta::AgentSession::Review }
+
         # @!attribute spend_control
         #   Configured spending limit and best-effort consumption, in USD cents. Unlimited
         #   sessions omit this object.
@@ -87,7 +94,7 @@ module OpenAI
         #   @return [OpenAI::Models::Beta::AgentSession::SpendControl, nil]
         optional :spend_control, -> { OpenAI::Beta::AgentSession::SpendControl }
 
-        # @!method initialize(id:, agent:, created_at:, environment:, error:, last_active_at:, metadata:, required_actions:, status:, usage:, vault_ids:, spend_control: nil, object: :"agent.session")
+        # @!method initialize(id:, agent:, created_at:, environment:, error:, last_active_at:, metadata:, required_actions:, status:, usage:, vault_ids:, review: nil, spend_control: nil, object: :"agent.session")
         #   A Managed Agents session.
         #
         #   @param id [String]
@@ -124,6 +131,10 @@ module OpenAI
         #   @param vault_ids [Array<String>]
         #     The IDs of vaults made available to the session.
         #
+        #   @param review [Symbol, OpenAI::Models::Beta::AgentSession::Review]
+        #     Review applied to eligible actions in this session. Omitted when review is none
+        #     and automatic review is not enabled. Omission means none.
+        #
         #   @param spend_control [OpenAI::Models::Beta::AgentSession::SpendControl]
         #     Configured spending limit and best-effort consumption, in USD cents. Unlimited
         #     sessions omit this object.
@@ -188,7 +199,19 @@ module OpenAI
           #   @return [Array<OpenAI::Models::Beta::AgentTool::Function, OpenAI::Models::Beta::AgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentTool::Mcp, OpenAI::Models::Beta::AgentTool::WebSearch, OpenAI::Models::Beta::AgentTool::ComputerUse, OpenAI::Models::Beta::AgentTool::Automations>]
           required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentTool] }
 
-          # @!method initialize(id:, instructions:, model:, multi_agent:, name:, reasoning:, service_tier:, text:, tools:)
+          # @!attribute compaction
+          #   The effective context compaction settings.
+          #
+          #   @return [OpenAI::Models::Beta::AgentSession::Agent::Compaction, nil]
+          optional :compaction, -> { OpenAI::Beta::AgentSession::Agent::Compaction }
+
+          # @!attribute experimental
+          #   The effective experimental settings for the agent.
+          #
+          #   @return [OpenAI::Models::Beta::AgentSession::Agent::Experimental, nil]
+          optional :experimental, -> { OpenAI::Beta::AgentSession::Agent::Experimental }
+
+          # @!method initialize(id:, instructions:, model:, multi_agent:, name:, reasoning:, service_tier:, text:, tools:, compaction: nil, experimental: nil)
           #   The agent running in the session.
           #
           #   @param id [String]
@@ -218,6 +241,12 @@ module OpenAI
           #
           #   @param tools [Array<OpenAI::Models::Beta::AgentTool::Function, OpenAI::Models::Beta::AgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentTool::Mcp, OpenAI::Models::Beta::AgentTool::WebSearch, OpenAI::Models::Beta::AgentTool::ComputerUse, OpenAI::Models::Beta::AgentTool::Automations>]
           #     Tools available to the agent.
+          #
+          #   @param compaction [OpenAI::Models::Beta::AgentSession::Agent::Compaction]
+          #     The effective context compaction settings.
+          #
+          #   @param experimental [OpenAI::Models::Beta::AgentSession::Agent::Experimental]
+          #     The effective experimental settings for the agent.
 
           # The effective service-tier policy for model requests. Defaults to `auto`.
           #
@@ -235,6 +264,36 @@ module OpenAI
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # @see OpenAI::Models::Beta::AgentSession::Agent#compaction
+          class Compaction < OpenAI::Internal::Type::BaseModel
+            # @!attribute async
+            #   Whether context is compacted in the background. Defaults to true.
+            #
+            #   @return [Boolean]
+            required :async, OpenAI::Internal::Type::Boolean
+
+            # @!method initialize(async:)
+            #   The effective context compaction settings.
+            #
+            #   @param async [Boolean]
+            #     Whether context is compacted in the background. Defaults to true.
+          end
+
+          # @see OpenAI::Models::Beta::AgentSession::Agent#experimental
+          class Experimental < OpenAI::Internal::Type::BaseModel
+            # @!attribute time_awareness
+            #   Whether the model receives periodic current-time reminders.
+            #
+            #   @return [Boolean]
+            required :time_awareness, OpenAI::Internal::Type::Boolean
+
+            # @!method initialize(time_awareness:)
+            #   The effective experimental settings for the agent.
+            #
+            #   @param time_awareness [Boolean]
+            #     Whether the model receives periodic current-time reminders.
+          end
         end
 
         # An action that must be completed before a session can continue.
@@ -594,6 +653,20 @@ module OpenAI
           #   @return [Array<Symbol>]
         end
 
+        # Review applied to eligible actions in this session. Omitted when review is none
+        # and automatic review is not enabled. Omission means none.
+        #
+        # @see OpenAI::Models::Beta::AgentSession#review
+        module Review
+          extend OpenAI::Internal::Type::Enum
+
+          NONE = :none
+          AUTO_REVIEW = :auto_review
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see OpenAI::Models::Beta::AgentSession#spend_control
         class SpendControl < OpenAI::Internal::Type::BaseModel
           # @!attribute consumed

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

@@ -13,6 +13,21 @@ module OpenAI
         #   @return [String]
         required :agent_id, String
 
+        # @!attribute compaction
+        #   Context compaction settings. Omit to keep the current settings. A supplied
+        #   object replaces the settings; null or an empty object enables background
+        #   compaction.
+        #
+        #   @return [OpenAI::Models::Beta::AgentUpdateParams::Compaction, nil]
+        optional :compaction, -> { OpenAI::Beta::AgentUpdateParams::Compaction }, nil?: true
+
+        # @!attribute experimental
+        #   Experimental settings to merge by key. Omitted settings keep their current
+        #   values.
+        #
+        #   @return [OpenAI::Models::Beta::AgentUpdateParams::Experimental, nil]
+        optional :experimental, -> { OpenAI::Beta::AgentUpdateParams::Experimental }
+
         # @!attribute instructions
         #   Additional instructions appended to the agent's default base instructions. Omit
         #   to leave unchanged.
@@ -76,9 +91,18 @@ module OpenAI
           nil?: true
         )
 
-        # @!method initialize(agent_id:, instructions: nil, metadata: nil, model: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
+        # @!method initialize(agent_id:, compaction: nil, experimental: nil, instructions: nil, metadata: nil, model: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
         #   @param agent_id [String]
         #
+        #   @param compaction [OpenAI::Models::Beta::AgentUpdateParams::Compaction, nil]
+        #     Context compaction settings. Omit to keep the current settings. A supplied
+        #     object replaces the settings; null or an empty object enables background
+        #     compaction.
+        #
+        #   @param experimental [OpenAI::Models::Beta::AgentUpdateParams::Experimental]
+        #     Experimental settings to merge by key. Omitted settings keep their current
+        #     values.
+        #
         #   @param instructions [String, nil]
         #     Additional instructions appended to the agent's default base instructions. Omit
         #     to leave unchanged.
@@ -113,6 +137,43 @@ module OpenAI
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
+        class Compaction < OpenAI::Internal::Type::BaseModel
+          # @!attribute async
+          #   Whether to compact context in the background. Omission or null defaults to true.
+          #   Set to false to use blocking compaction. Background compaction may increase
+          #   token usage.
+          #
+          #   @return [Boolean, nil]
+          optional :async, OpenAI::Internal::Type::Boolean, nil?: true
+
+          # @!method initialize(async: nil)
+          #   Context compaction settings. Omit to keep the current settings. A supplied
+          #   object replaces the settings; null or an empty object enables background
+          #   compaction.
+          #
+          #   @param async [Boolean, nil]
+          #     Whether to compact context in the background. Omission or null defaults to true.
+          #     Set to false to use blocking compaction. Background compaction may increase
+          #     token usage.
+        end
+
+        class Experimental < OpenAI::Internal::Type::BaseModel
+          # @!attribute time_awareness
+          #   Whether to give the model periodic current-time reminders. Omit to keep the
+          #   current setting.
+          #
+          #   @return [Boolean, nil]
+          optional :time_awareness, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(time_awareness: nil)
+          #   Experimental settings to merge by key. Omitted settings keep their current
+          #   values.
+          #
+          #   @param time_awareness [Boolean]
+          #     Whether to give the model periodic current-time reminders. Omit to keep the
+          #     current setting.
+        end
+
         # The service tier used for model requests.
         module ServiceTier
           extend OpenAI::Internal::Type::Enum