openai 0.104.0 → 0.106.0

data/rbi/openai/models/live/sideband_server_event.rbi

@@ -5,8 +5,8 @@ module OpenAI
 
     module Live
 
-      # Server events received by an attached Live sideband WebSocket. Audio deltas are
-      # delivered over the primary connection.
+      # Server events received by an attached Live sideband WebSocket, including
+      # reflected input and output audio and transport notifications.
       module SidebandServerEvent
         extend OpenAI::Internal::Type::Union
 
@@ -31,10 +31,413 @@ module OpenAI
             OpenAI::Live::SessionUsageUpdatedEvent,
             OpenAI::Live::SessionClosedEvent,
             OpenAI::Live::ErrorEvent,
-            OpenAI::Live::InfoEvent
+            OpenAI::Live::InfoEvent,
+            OpenAI::Live::SidebandServerEvent::SessionInputAudioAppend,
+            OpenAI::Live::OutputAudioDeltaEvent,
+            OpenAI::Live::SidebandServerEvent::TransportDtmfReceived,
+            OpenAI::Live::SidebandServerEvent::TransportDtmfSend,
+            OpenAI::Live::SidebandServerEvent::TransportRinging,
+            OpenAI::Live::SidebandServerEvent::TransportAnswered,
+            OpenAI::Live::SidebandServerEvent::TransportFailed
           )
         end
 
+        class SessionInputAudioAppend < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Live::SidebandServerEvent::SessionInputAudioAppend,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # Base64-encoded raw mono PCM16LE at 24 kHz received from the primary transport,
+          # reflected to the sideband before model-input muting. This server event uses the
+          # same audio key as the client command, but is not an acknowledgment of it.
+          sig { returns(String) }
+          attr_accessor :audio
+
+          # The event type, always `session.input_audio.append`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Input audio received from the primary transport and reflected to a Live sideband
+          # connection before model-input muting.
+          sig do
+            params(
+
+              audio: String,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # Base64-encoded raw mono PCM16LE at 24 kHz received from the primary transport,
+            # reflected to the sideband before model-input muting. This server event uses the
+            # same audio key as the client command, but is not an acknowledgment of it.
+            audio:,
+
+            # The event type, always `session.input_audio.append`.
+
+            type: :"session.input_audio.append"
+          )
+          end
+
+          sig do
+            override.returns(
+              {audio: String, type: Symbol}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+        class TransportDtmfReceived < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Live::SidebandServerEvent::TransportDtmfReceived,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          sig { returns(String) }
+          attr_accessor :event
+
+          sig { returns(String) }
+          attr_accessor :event_id
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # A SIP DTMF keypress received from the caller. Delivered only to sideband
+          # observers.
+          sig do
+            params(
+
+              event: String,
+
+              event_id: String,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            event:,
+
+            event_id:,
+
+            type: :"transport.dtmf.received"
+          )
+          end
+
+          sig do
+            override.returns(
+              {event: String, event_id: String, type: Symbol}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+        class TransportDtmfSend < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Live::SidebandServerEvent::TransportDtmfSend,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          sig { returns(String) }
+          attr_accessor :event
+
+          sig { returns(String) }
+          attr_accessor :event_id
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # The event_id of the client command, when supplied.
+          sig { returns(T.nilable(String)) }
+          attr_reader :client_event_id
+
+          sig { params(client_event_id: String).void }
+          attr_writer :client_event_id
+
+          # A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
+          # sideband observers; this is not a client command.
+          sig do
+            params(
+
+              event: String,
+
+              event_id: String,
+
+              client_event_id: String,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            event:,
+
+            event_id:,
+
+            # The event_id of the client command, when supplied.
+            client_event_id: nil,
+
+            type: :"transport.dtmf.send"
+          )
+          end
+
+          sig do
+            override.returns(
+              {event: String, event_id: String, type: Symbol, client_event_id: T.nilable(String)}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+        class TransportRinging < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Live::SidebandServerEvent::TransportRinging,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          sig { returns(String) }
+          attr_accessor :event_id
+
+          # The canonical Live session ID.
+          sig { returns(String) }
+          attr_accessor :session_id
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # The outbound SIP provider leg is ringing or providing early media. Delivered
+          # only to sideband observers.
+          sig do
+            params(
+
+              event_id: String,
+
+              session_id: String,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            event_id:,
+
+            # The canonical Live session ID.
+            session_id:,
+
+            type: :"transport.ringing"
+          )
+          end
+
+          sig do
+            override.returns(
+              {event_id: String, session_id: String, type: Symbol}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+        class TransportAnswered < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Live::SidebandServerEvent::TransportAnswered,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          sig { returns(String) }
+          attr_accessor :event_id
+
+          # The canonical Live session ID.
+          sig { returns(String) }
+          attr_accessor :session_id
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # The outbound SIP provider leg answered and media is established. Delivered only
+          # to sideband observers.
+          sig do
+            params(
+
+              event_id: String,
+
+              session_id: String,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            event_id:,
+
+            # The canonical Live session ID.
+            session_id:,
+
+            type: :"transport.answered"
+          )
+          end
+
+          sig do
+            override.returns(
+              {event_id: String, session_id: String, type: Symbol}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+        class TransportFailed < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Live::SidebandServerEvent::TransportFailed,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          sig { returns(OpenAI::Live::SidebandServerEvent::TransportFailed::Error) }
+          attr_reader :error
+
+          sig { params(error: OpenAI::Live::SidebandServerEvent::TransportFailed::Error::OrHash).void }
+          attr_writer :error
+
+          sig { returns(String) }
+          attr_accessor :event_id
+
+          # The canonical Live session ID.
+          sig { returns(String) }
+          attr_accessor :session_id
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # An asynchronous outbound SIP setup failure. Delivered only to sideband
+          # observers.
+          sig do
+            params(
+
+              error: OpenAI::Live::SidebandServerEvent::TransportFailed::Error::OrHash,
+
+              event_id: String,
+
+              session_id: String,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            error:,
+
+            event_id:,
+
+            # The canonical Live session ID.
+            session_id:,
+
+            type: :"transport.failed"
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                error: OpenAI::Live::SidebandServerEvent::TransportFailed::Error,
+                event_id: String,
+                session_id: String,
+                type: Symbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Error < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Live::SidebandServerEvent::TransportFailed::Error,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The call setup failure code.
+            sig { returns(String) }
+            attr_accessor :code
+
+            sig { returns(String) }
+            attr_accessor :message
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # The parameter related to the error, if any. Empty when no parameter applies.
+            sig { returns(T.nilable(String)) }
+            attr_reader :param
+
+            sig { params(param: String).void }
+            attr_writer :param
+
+            sig do
+              params(
+
+                code: String,
+
+                message: String,
+
+                param: String,
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The call setup failure code.
+              code:,
+
+              message:,
+
+              # The parameter related to the error, if any. Empty when no parameter applies.
+              param: nil,
+
+              type: :call_error
+            )
+            end
+
+            sig do
+              override.returns(
+                {code: String, message: String, type: Symbol, param: T.nilable(String)}
+              )
+            end
+            def to_hash
+            end
+
+          end
+        end
+
         sig { override.returns(T::Array[OpenAI::Live::SidebandServerEvent::Variants]) }
         def self.variants
         end

data/rbi/openai/models.rbi

@@ -80,6 +80,8 @@ module OpenAI
 
   DecisionInputText = OpenAI::Models::DecisionInputText
 
+  DecisionPromptCacheBreakpoint = OpenAI::Models::DecisionPromptCacheBreakpoint
+
   DeletedSkill = OpenAI::Models::DeletedSkill
 
   Embedding = OpenAI::Models::Embedding

data/rbi/openai/resources/beta/responses.rbi

@@ -8,6 +8,23 @@ module OpenAI
       # Create and manage model responses.
       class Responses
 
+        include OpenAI::WebSocket::Resource
+
+        # @api private
+        sig { params(query: T::Hash[T.untyped, T.untyped]).returns(T::Hash[Symbol, T.untyped]) }
+        def __websocket_request(query: {})
+        end
+
+        # @api private
+        sig { returns(T.untyped) }
+        def __websocket_client_event
+        end
+
+        # @api private
+        sig { returns(T.untyped) }
+        def __websocket_server_event
+        end
+
         # Create and manage model responses.
         sig { returns(OpenAI::Resources::Beta::Responses::InputItems) }
         attr_reader :input_items

data/rbi/openai/resources/decisions.rbi

@@ -18,6 +18,8 @@ module OpenAI
               OpenAI::DecisionCreateParams::Question::Score::OrHash
             )
           ],
+          prompt_cache_key: T.nilable(String),
+          prompt_cache_options: T.nilable(OpenAI::DecisionCreateParams::PromptCacheOptions::OrHash),
           safety_identifier: T.nilable(String),
           request_options: OpenAI::RequestOptions::OrHash
         )
@@ -34,6 +36,18 @@ module OpenAI
         # Ask 1–200 questions about the input. Each question can be a predicate, choice,
         # or score. Answers come back in the same order.
         questions:,
+        # Partition prompt cache reuse by caller-provided key.
+        prompt_cache_key: nil,
+        # Options for prompt caching. Supported for `gpt-5.6` and later models. By
+        # default, OpenAI automatically chooses one implicit cache breakpoint. You can add
+        # explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
+        # request can write up to four breakpoints. For cache matching, OpenAI considers
+        # up to the latest 80 breakpoints in the conversation, without a content-block
+        # lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The
+        # `ttl` defaults to `30m`, which is currently the only supported value. See the
+        # [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching)
+        # for current details.
+        prompt_cache_options: nil,
         # Opaque caller-provided end-user identifier, scoped by the verified org. Match
         # Responses' limit; this is never the authenticated user identity.
         safety_identifier: nil,

data/rbi/openai/resources/images.rbi

@@ -67,6 +67,7 @@ module OpenAI
           partial_images: T.nilable(Integer),
           quality: T.nilable(OpenAI::ImageEditParams::Quality::OrSymbol),
           response_format: T.nilable(OpenAI::ImageEditParams::ResponseFormat::OrSymbol),
+          safety_identifier: T.nilable(String),
           size: T.nilable(T.any(String, OpenAI::ImageEditParams::Size::OrSymbol)),
           user: String,
           stream: T.noreturn,
@@ -146,6 +147,13 @@ module OpenAI
         # Legacy response format parameter for retired image models. Unsupported for GPT
         # image models, which always return base64-encoded images.
         response_format: nil,
+        # A stable identifier for an end user in your organization, used for safety
+        # monitoring and abuse detection. Hash a username or email address to avoid
+        # sending identifying information. A non-empty value takes precedence over the
+        # deprecated `user` parameter. If omitted, null, or empty, the API uses `user`
+        # when available.
+        # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
+        safety_identifier: nil,
         # The size of the generated images. Defaults to `auto`. For `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
@@ -158,8 +166,9 @@ module OpenAI
         # `1024x1536` are supported by the GPT image models; `auto` is supported for
         # models that allow automatic sizing.
         size: nil,
-        # A unique identifier representing your end-user, which can help OpenAI to monitor
-        # and detect abuse.
+        # Deprecated: use `safety_identifier` instead. This parameter remains accepted for
+        # backward compatibility and is used when `safety_identifier` is omitted, null, or
+        # empty.
         # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
         user: nil,
         # There is no need to provide `stream:`. Instead, use `#edit_stream_raw` or
@@ -187,6 +196,7 @@ module OpenAI
           partial_images: T.nilable(Integer),
           quality: T.nilable(OpenAI::ImageEditParams::Quality::OrSymbol),
           response_format: T.nilable(OpenAI::ImageEditParams::ResponseFormat::OrSymbol),
+          safety_identifier: T.nilable(String),
           size: T.nilable(T.any(String, OpenAI::ImageEditParams::Size::OrSymbol)),
           user: String,
           stream: T.noreturn,
@@ -266,6 +276,13 @@ module OpenAI
         # Legacy response format parameter for retired image models. Unsupported for GPT
         # image models, which always return base64-encoded images.
         response_format: nil,
+        # A stable identifier for an end user in your organization, used for safety
+        # monitoring and abuse detection. Hash a username or email address to avoid
+        # sending identifying information. A non-empty value takes precedence over the
+        # deprecated `user` parameter. If omitted, null, or empty, the API uses `user`
+        # when available.
+        # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
+        safety_identifier: nil,
         # The size of the generated images. Defaults to `auto`. For `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
@@ -278,8 +295,9 @@ module OpenAI
         # `1024x1536` are supported by the GPT image models; `auto` is supported for
         # models that allow automatic sizing.
         size: nil,
-        # A unique identifier representing your end-user, which can help OpenAI to monitor
-        # and detect abuse.
+        # Deprecated: use `safety_identifier` instead. This parameter remains accepted for
+        # backward compatibility and is used when `safety_identifier` is omitted, null, or
+        # empty.
         # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
         user: nil,
         # There is no need to provide `stream:`. Instead, use `#edit_stream_raw` or
@@ -305,6 +323,7 @@ module OpenAI
           partial_images: T.nilable(Integer),
           quality: T.nilable(OpenAI::ImageGenerateParams::Quality::OrSymbol),
           response_format: T.nilable(OpenAI::ImageGenerateParams::ResponseFormat::OrSymbol),
+          safety_identifier: T.nilable(String),
           size: T.nilable(T.any(String, OpenAI::ImageGenerateParams::Size::OrSymbol)),
           style: T.nilable(OpenAI::ImageGenerateParams::Style::OrSymbol),
           user: String,
@@ -364,6 +383,13 @@ module OpenAI
         # Legacy response format parameter for retired image models. Unsupported for GPT
         # image models, which always return base64-encoded images.
         response_format: nil,
+        # A stable identifier for an end user in your organization, used for safety
+        # monitoring and abuse detection. Hash a username or email address to avoid
+        # sending identifying information. A non-empty value takes precedence over the
+        # deprecated `user` parameter. If omitted, null, or empty, the API uses `user`
+        # when available.
+        # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
+        safety_identifier: nil,
         # The size of the generated images. For `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`, arbitrary
@@ -378,8 +404,9 @@ module OpenAI
         # Legacy style parameter for retired image models. Unsupported for GPT image
         # models; describe the desired style in the prompt instead.
         style: nil,
-        # A unique identifier representing your end-user, which can help OpenAI to monitor
-        # and detect abuse.
+        # Deprecated: use `safety_identifier` instead. This parameter remains accepted for
+        # backward compatibility and is used when `safety_identifier` is omitted, null, or
+        # empty.
         # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
         user: nil,
         # There is no need to provide `stream:`. Instead, use `#generate_stream_raw` or
@@ -405,6 +432,7 @@ module OpenAI
           partial_images: T.nilable(Integer),
           quality: T.nilable(OpenAI::ImageGenerateParams::Quality::OrSymbol),
           response_format: T.nilable(OpenAI::ImageGenerateParams::ResponseFormat::OrSymbol),
+          safety_identifier: T.nilable(String),
           size: T.nilable(T.any(String, OpenAI::ImageGenerateParams::Size::OrSymbol)),
           style: T.nilable(OpenAI::ImageGenerateParams::Style::OrSymbol),
           user: String,
@@ -464,6 +492,13 @@ module OpenAI
         # Legacy response format parameter for retired image models. Unsupported for GPT
         # image models, which always return base64-encoded images.
         response_format: nil,
+        # A stable identifier for an end user in your organization, used for safety
+        # monitoring and abuse detection. Hash a username or email address to avoid
+        # sending identifying information. A non-empty value takes precedence over the
+        # deprecated `user` parameter. If omitted, null, or empty, the API uses `user`
+        # when available.
+        # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
+        safety_identifier: nil,
         # The size of the generated images. For `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`, arbitrary
@@ -478,8 +513,9 @@ module OpenAI
         # Legacy style parameter for retired image models. Unsupported for GPT image
         # models; describe the desired style in the prompt instead.
         style: nil,
-        # A unique identifier representing your end-user, which can help OpenAI to monitor
-        # and detect abuse.
+        # Deprecated: use `safety_identifier` instead. This parameter remains accepted for
+        # backward compatibility and is used when `safety_identifier` is omitted, null, or
+        # empty.
         # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
         user: nil,
         # There is no need to provide `stream:`. Instead, use `#generate_stream_raw` or

data/sig/openai/models/admin/organization/external_storage_configuration.rbs

@@ -60,13 +60,14 @@ module OpenAI
             def self?.variants: -> ::Array[OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::provider]
           end
 
-          type status = :pending | :validated | :unhealthy
+          type status = :pending | :validated | :degraded | :unhealthy
 
           module Status
             extend OpenAI::Internal::Type::Enum
 
             PENDING: :pending
             VALIDATED: :validated
+            DEGRADED: :degraded
             UNHEALTHY: :unhealthy
 
             def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::status]

data/sig/openai/models/beta/agent_create_params.rbs

@@ -100,7 +100,8 @@ module OpenAI
           ?request_options: OpenAI::RequestOptions
         }
 
-        type service_tier = :auto | :default | :flex | :priority | :fast
+        type service_tier =
+          :auto | :default | :flex | :priority | :fast | :ultrafast
 
         module ServiceTier
           extend OpenAI::Internal::Type::Enum
@@ -120,6 +121,9 @@ module OpenAI
           # Uses the fast service tier.
           FAST: :fast
 
+          # Uses the ultrafast service tier.
+          ULTRAFAST: :ultrafast
+
           def self?.values: -> ::Array[OpenAI::Models::Beta::AgentCreateParams::service_tier]
         end
       end

data/sig/openai/models/beta/agent_update_params.rbs

@@ -108,7 +108,8 @@ module OpenAI
           ?request_options: OpenAI::RequestOptions
         }
 
-        type service_tier = :auto | :default | :flex | :priority | :fast
+        type service_tier =
+          :auto | :default | :flex | :priority | :fast | :ultrafast
 
         module ServiceTier
           extend OpenAI::Internal::Type::Enum
@@ -128,6 +129,9 @@ module OpenAI
           # Uses the fast service tier.
           FAST: :fast
 
+          # Uses the ultrafast service tier.
+          ULTRAFAST: :ultrafast
+
           def self?.values: -> ::Array[OpenAI::Models::Beta::AgentUpdateParams::service_tier]
         end
       end