openai 0.113.0 → 0.115.0

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

@@ -16,11 +16,17 @@ module OpenAI
         # Creates a reusable agent without storing credentials. See
         # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
         #
-        # @overload create(model:, instructions: nil, metadata: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
+        # @overload create(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.
@@ -95,11 +101,20 @@ module OpenAI
         # Updates a reusable agent. See
         # [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
         #
-        # @overload update(agent_id, instructions: nil, metadata: nil, model: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
+        # @overload update(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]
         #   The ID of the reusable agent.
         #
+        # @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.

data/lib/openai/resources/images.rb

@@ -72,17 +72,17 @@ module OpenAI
       # metadata. Use `OpenAI::FilePart` when you need to override the filename or
       # content type.
       #
-      # @overload edit(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
+      # @overload edit(image:, prompt:, background: nil, input_fidelity: nil, markup: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>]
       #   The image(s) to edit. Must be a supported image file or an array of images.
       #
-      #   For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
-      #   `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
-      #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
-      #   `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`), each image should
-      #   be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to 16
-      #   images.
+      #   For the GPT image models (`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
+      #   `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+      #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
+      #   `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
+      #   `jpg` file less than 50MB. You can provide up to 16 images.
+      #   `chatgpt-image-latest` follows the same input constraints as GPT image models.
       #
       #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
       #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
@@ -106,8 +106,17 @@ module OpenAI
       # @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
       #   Control how much effort the model will exert to match the style and features,
       #   especially facial features, of input images. Supports `high` and `low` on
-      #   `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-      #   `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+      #   `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+      #   this parameter. Defaults to `low` on supported models.
+      #
+      # @param markup [Pathname, StringIO, IO, String, OpenAI::FilePart]
+      #   A transparent PNG overlaid on the first image to guide the edit. Must match that
+      #   image's dimensions after orientation and contain transparent pixels. Supports
+      #   GPT Image 2.5 and 2.6. Cannot be combined with mask.
+      #
+      #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      #   content type.
       #
       # @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart]
       #   An additional image whose fully transparent areas (e.g. where alpha is zero)
@@ -220,17 +229,17 @@ module OpenAI
       # metadata. Use `OpenAI::FilePart` when you need to override the filename or
       # content type.
       #
-      # @overload edit_stream_raw(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
+      # @overload edit_stream_raw(image:, prompt:, background: nil, input_fidelity: nil, markup: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, safety_identifier: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>]
       #   The image(s) to edit. Must be a supported image file or an array of images.
       #
-      #   For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
-      #   `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
-      #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
-      #   `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`), each image should
-      #   be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to 16
-      #   images.
+      #   For the GPT image models (`gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
+      #   `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+      #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
+      #   `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
+      #   `jpg` file less than 50MB. You can provide up to 16 images.
+      #   `chatgpt-image-latest` follows the same input constraints as GPT image models.
       #
       #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
       #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
@@ -254,8 +263,17 @@ module OpenAI
       # @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
       #   Control how much effort the model will exert to match the style and features,
       #   especially facial features, of input images. Supports `high` and `low` on
-      #   `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-      #   `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+      #   `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+      #   this parameter. Defaults to `low` on supported models.
+      #
+      # @param markup [Pathname, StringIO, IO, String, OpenAI::FilePart]
+      #   A transparent PNG overlaid on the first image to guide the edit. Must match that
+      #   image's dimensions after orientation and contain transparent pixels. Supports
+      #   GPT Image 2.5 and 2.6. Cannot be combined with mask.
+      #
+      #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      #   content type.
       #
       # @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart]
       #   An additional image whose fully transparent areas (e.g. where alpha is zero)

data/lib/openai/version.rb

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

data/lib/openai.rb

@@ -253,6 +253,13 @@ require_relative "openai/models/admin/organization/certificate_update_params"
 require_relative "openai/models/admin/organization/cost_quantity_unit"
 require_relative "openai/models/admin/organization/data_retention_retrieve_params"
 require_relative "openai/models/admin/organization/data_retention_update_params"
+require_relative "openai/models/admin/organization/external_key"
+require_relative "openai/models/admin/organization/external_key_create_params"
+require_relative "openai/models/admin/organization/external_key_delete_params"
+require_relative "openai/models/admin/organization/external_key_list_params"
+require_relative "openai/models/admin/organization/external_key_retrieve_params"
+require_relative "openai/models/admin/organization/external_key_validate_params"
+require_relative "openai/models/admin/organization/external_key_validate_response"
 require_relative "openai/models/admin/organization/external_storage_configuration"
 require_relative "openai/models/admin/organization/external_storage_create_params"
 require_relative "openai/models/admin/organization/external_storage_deleted"
@@ -1553,6 +1560,7 @@ require_relative "openai/resources/admin/organization/admin_api_keys"
 require_relative "openai/resources/admin/organization/audit_logs"
 require_relative "openai/resources/admin/organization/certificates"
 require_relative "openai/resources/admin/organization/data_retention"
+require_relative "openai/resources/admin/organization/external_keys"
 require_relative "openai/resources/admin/organization/external_storage"
 require_relative "openai/resources/admin/organization/groups"
 require_relative "openai/resources/admin/organization/groups/roles"

data/rbi/openai/helpers/live/websocket.rbi

@@ -116,18 +116,7 @@ module OpenAI
       class SidebandConnection
         include Enumerable
         ClientEvent = T.type_alias do
-          T.any(
-            OpenAI::Live::SessionUpdateEvent,
-            OpenAI::Live::InputAudioMuteEvent,
-            OpenAI::Live::InputAudioUnmuteEvent,
-            OpenAI::Live::InstructionsAppendEvent,
-            OpenAI::Live::ThinkingAppendEvent,
-            OpenAI::Live::CommentaryAppendEvent,
-            OpenAI::Live::ResponseItemCreateEvent,
-            OpenAI::Live::ResponseCreateEvent,
-            OpenAI::Live::SessionCloseEvent,
-            T::Hash[T.any(String, Symbol), T.anything]
-          )
+          T.any(OpenAI::Live::SidebandClientEvent::Variants, T::Hash[T.any(String, Symbol), T.anything])
         end
 
         Elem = type_member { {fixed: Connection::ServerEvent} }

data/rbi/openai/helpers/realtime/connection.rbi

@@ -100,6 +100,11 @@ module OpenAI
         def abort
         end
 
+        # @api private
+        sig { void }
+        def enable_no_status_recovery
+        end
+
         sig { returns(T::Boolean) }
         def closed?
         end

data/rbi/openai/helpers/realtime/transports/async_websocket.rbi

@@ -41,6 +41,11 @@ module OpenAI
             def abort
             end
 
+            # @api private
+            sig { void }
+            def enable_no_status_recovery
+            end
+
             # @api private
             sig { returns(T::Boolean) }
             def aborted?

data/rbi/openai/helpers/responses_websocket/connection.rbi

@@ -55,8 +55,13 @@ module OpenAI
         end
 
         # @api private
-        sig { params(event: ClientEvent).returns(OpenAI::Internal::AnyHash) }
-        def encode_client_event(event)
+        sig { params(event: ClientEvent).void }
+        def send_response_create(event)
+        end
+
+        # @api private
+        sig { params(event: ClientEvent, response_create: T::Boolean).returns(OpenAI::Internal::AnyHash) }
+        def encode_client_event(event, response_create: false)
         end
 
         # @api private

data/rbi/openai/helpers/structured_output.rbi

@@ -11,6 +11,16 @@ module OpenAI
     #
     # Supported types: {NilClass} {String} {Symbol} {Integer} {Float} {OpenAI::Boolean}, {OpenAI::EnumOf}, {OpenAI::UnionOf}, {OpenAI::ArrayOf}, {OpenAI::BaseModel}
     module StructuredOutput
+      # @api private
+      module RequestWithFormatUpdate
+        sig { returns(T.nilable(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::Input)) }
+        attr_accessor :text_model
+      end
+
+      # @api private
+      sig { params(request: OpenAI::Internal::AnyHash).returns(OpenAI::Internal::AnyHash) }
+      def self.prepare_configuration_updates!(request)
+      end
     end
   end
 end

data/rbi/openai/internal/type/array_of.rbi

@@ -71,7 +71,7 @@ module OpenAI
 
         # @api private
         sig { returns(Elem) }
-        protected def item_type
+        def item_type
         end
 
         # @api private

data/rbi/openai/internal/type/hash_of.rbi

@@ -71,7 +71,7 @@ module OpenAI
 
         # @api private
         sig { returns(Elem) }
-        protected def item_type
+        def item_type
         end
 
         # @api private

data/rbi/openai/internal/type/union.rbi

@@ -102,6 +102,11 @@ module OpenAI
         def coerce(value, state:)
         end
 
+        # @api private
+        sig { params(value: T.anything).returns(T.nilable(T.anything)) }
+        def variant_for_dump(value)
+        end
+
         # @api private
         sig do
           override

data/rbi/openai/models/admin/organization/external_key.rbi

@@ -0,0 +1,301 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Admin
+
+      module Organization
+
+        class ExternalKey < OpenAI::Internal::Type::BaseModel
+
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Admin::Organization::ExternalKey,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(T::Array[String]) }
+          attr_accessor :api_project_ids
+
+          sig { returns(Integer) }
+          attr_accessor :created_at
+
+          sig { returns(String) }
+          attr_accessor :name
+
+          sig { returns(String) }
+          attr_accessor :object
+
+          sig { returns(String) }
+          attr_accessor :type
+
+          sig { returns(String) }
+          attr_accessor :workspace_id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :audience
+
+          sig { params(audience: String).void }
+          attr_writer :audience
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :external_id
+
+          sig { params(external_id: String).void }
+          attr_writer :external_id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :key_name
+
+          sig { params(key_name: String).void }
+          attr_writer :key_name
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :key_version
+
+          sig { params(key_version: String).void }
+          attr_writer :key_version
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :kms_arn
+
+          sig { params(kms_arn: String).void }
+          attr_writer :kms_arn
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :kms_key_location
+
+          sig { params(kms_key_location: String).void }
+          attr_writer :kms_key_location
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :kms_key_name
+
+          sig { params(kms_key_name: String).void }
+          attr_writer :kms_key_name
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :kms_key_ring_name
+
+          sig { params(kms_key_ring_name: String).void }
+          attr_writer :kms_key_ring_name
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :kms_key_version
+
+          sig { params(kms_key_version: String).void }
+          attr_writer :kms_key_version
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :kms_project_id
+
+          sig { params(kms_project_id: String).void }
+          attr_writer :kms_project_id
+
+          sig { returns(T.nilable(OpenAI::Admin::Organization::ExternalKey::Purpose::TaggedSymbol)) }
+          attr_reader :purpose
+
+          sig { params(purpose: OpenAI::Admin::Organization::ExternalKey::Purpose::OrSymbol).void }
+          attr_writer :purpose
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :role_arn
+
+          sig { params(role_arn: String).void }
+          attr_writer :role_arn
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :tenant_id
+
+          sig { params(tenant_id: String).void }
+          attr_writer :tenant_id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :vault_uri
+
+          sig { params(vault_uri: String).void }
+          attr_writer :vault_uri
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :workload_identity_pool_id
+
+          sig { params(workload_identity_pool_id: String).void }
+          attr_writer :workload_identity_pool_id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :workload_identity_project_number
+
+          sig { params(workload_identity_project_number: String).void }
+          attr_writer :workload_identity_project_number
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :workload_identity_provider_id
+
+          sig { params(workload_identity_provider_id: String).void }
+          attr_writer :workload_identity_provider_id
+
+          sig do
+            params(
+
+              id: String,
+
+              api_project_ids: T::Array[String],
+
+              created_at: Integer,
+
+              name: String,
+
+              object: String,
+
+              type: String,
+
+              workspace_id: String,
+
+              audience: String,
+
+              external_id: String,
+
+              key_name: String,
+
+              key_version: String,
+
+              kms_arn: String,
+
+              kms_key_location: String,
+
+              kms_key_name: String,
+
+              kms_key_ring_name: String,
+
+              kms_key_version: String,
+
+              kms_project_id: String,
+
+              purpose: OpenAI::Admin::Organization::ExternalKey::Purpose::OrSymbol,
+
+              role_arn: String,
+
+              tenant_id: String,
+
+              vault_uri: String,
+
+              workload_identity_pool_id: String,
+
+              workload_identity_project_number: String,
+
+              workload_identity_provider_id: String
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            id:,
+
+            api_project_ids:,
+
+            created_at:,
+
+            name:,
+
+            object:,
+
+            type:,
+
+            workspace_id:,
+
+            audience: nil,
+
+            external_id: nil,
+
+            key_name: nil,
+
+            key_version: nil,
+
+            kms_arn: nil,
+
+            kms_key_location: nil,
+
+            kms_key_name: nil,
+
+            kms_key_ring_name: nil,
+
+            kms_key_version: nil,
+
+            kms_project_id: nil,
+
+            purpose: nil,
+
+            role_arn: nil,
+
+            tenant_id: nil,
+
+            vault_uri: nil,
+
+            workload_identity_pool_id: nil,
+
+            workload_identity_project_number: nil,
+
+            workload_identity_provider_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                api_project_ids: T::Array[String],
+                created_at: Integer,
+                name: String,
+                object: String,
+                type: String,
+                workspace_id: String,
+                audience: String,
+                external_id: String,
+                key_name: String,
+                key_version: String,
+                kms_arn: String,
+                kms_key_location: String,
+                kms_key_name: String,
+                kms_key_ring_name: String,
+                kms_key_version: String,
+                kms_project_id: String,
+                purpose: OpenAI::Admin::Organization::ExternalKey::Purpose::TaggedSymbol,
+                role_arn: String,
+                tenant_id: String,
+                vault_uri: String,
+                workload_identity_pool_id: String,
+                workload_identity_project_number: String,
+                workload_identity_provider_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Purpose
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Admin::Organization::ExternalKey::Purpose) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            EKM = T.let(:ekm, OpenAI::Admin::Organization::ExternalKey::Purpose::TaggedSymbol)
+            PSP_DECRYPTION = T.let(:psp_decryption, OpenAI::Admin::Organization::ExternalKey::Purpose::TaggedSymbol)
+
+            sig { override.returns(T::Array[OpenAI::Admin::Organization::ExternalKey::Purpose::TaggedSymbol]) }
+            def self.values
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end