openai 0.95.0 → 0.96.0

data/responses-websocket.md

@@ -60,6 +60,61 @@ event types arrive as `OpenAI::Responses::UnknownServerEvent`. Preserve or handl
 them explicitly where your application needs them. Do not assume every event
 has a response, text delta, or lane ID.
 
+## Receive limits
+
+The default Responses transport accepts `max_message_bytes`,
+`max_wire_message_bytes`, and `max_message_frames` in `transport_options`.
+Each is an optional positive integer; omitted or `nil` keeps its unlimited default. Choose values
+for your application's legitimate largest message, including images and tool
+results. These are caller budgets, not API limits.
+
+```ruby
+client.responses.connect(
+  transport_options: {max_message_bytes: 64 * 1024 * 1024, max_message_frames: 4_096}
+) do |connection|
+  connection.response.create(model: "gpt-5.2", input: "Hello")
+  while (event = connection.receive)
+    puts event.type
+  end
+end
+```
+
+The decoded byte budget (`max_message_bytes`) covers the payload of each complete
+message after decompression, including all its fragments. The optional wire budget
+(`max_wire_message_bytes`) covers data payload bytes before decompression across those
+fragments, excluding frame headers and control frames. A wire budget alone does
+not impose a decoded byte limit. Oversized frame headers are rejected
+before the advertised payload is read (with up to 125 bytes allowed for a legal
+interleaved control frame). The frame budget counts text, binary and continuation
+frames, including empty continuations; ping/pong and close frames don't count.
+Set both when you need to bound both payload and frame-buffer memory.
+Counters reset at the end of each message.
+
+To use WebSocket compression with independently bounded wire and decoded sizes:
+
+```ruby
+limits = {
+  max_wire_message_bytes: 8 * 1024 * 1024,
+  max_message_bytes: 64 * 1024 * 1024,
+  max_message_frames: 4_096
+}
+client.responses.connect(transport_options: limits) do |connection|
+  connection.response.create(model: "gpt-5.2", input: "Hello")
+  while (event = connection.receive)
+    puts event.type
+  end
+end
+```
+
+The server can still decline compression, in which case both byte budgets apply
+to the uncompressed message. Existing byte-only configurations continue to
+decline compression, as before; no-limit and frame-only configurations retain
+their normal compression negotiation.
+Exceeding any chosen limit aborts the socket, releases its pool slot, and
+raises `OpenAI::Errors::ResponsesConnectionError`; no requests are replayed.
+Managed sessions accept the same `transport_options`. An injected transport
+still receives its options unchanged and owns their meaning.
+
 ## Managed sessions
 
 `OpenAI::Responses::Session.open` adds routed lanes and final-response collection

data/sig/openai/helpers/live/transcript_grouper.rbs

@@ -0,0 +1,42 @@
+module OpenAI
+  module Models
+    module Live
+      class TranscriptGrouper
+        type speaker = :user | :assistant
+        type close_reason =
+          :speaker_change
+          | :inactivity
+          | :timestamp_reset
+          | :session_closed
+          | :manual
+
+        class Segment < Data
+          attr_reader id: String
+          attr_reader previous_id: String?
+          attr_reader speaker: TranscriptGrouper::speaker
+          attr_reader text: String
+          attr_reader start_ms: Integer
+          attr_reader end_ms: Integer
+        end
+
+        class ClosedSegment < Data
+          attr_reader segment: Segment
+          attr_reader reason: TranscriptGrouper::close_reason
+        end
+
+        def initialize: (
+          ?on_segment_updated: (^(Segment) -> void)?,
+          ?on_segment_closed: (^(ClosedSegment) -> void)?,
+          ?min_turn_separation_ms: Integer | Float,
+          ?assistant_silence_ms: Integer | Float,
+          ?backchannel_max_duration_ms: Integer | Float,
+          ?backchannel_isolation_ms: Integer | Float,
+          ?additional_acknowledgments: Array[String]
+        ) -> void
+
+        def push: (top event) -> void
+        def close: -> void
+      end
+    end
+  end
+end

data/sig/openai/helpers/live/websocket.rbs

@@ -0,0 +1,152 @@
+module OpenAI
+  class Client
+    # @api private
+    def with_live_websocket_connection_request: (
+      ?path: String | ::Array[String],
+      ?query: ::Hash[String, String],
+      ?websocket_base_url: String?,
+      ?options: OpenAI::request_opts?
+    ) {
+      (
+        OpenAI::Internal::Transport::BaseClient::request_input request,
+        ^-> void mark_handshake_completed
+      ) -> top
+    } -> top
+  end
+
+  module Errors
+    class LiveConnectionError < OpenAI::Errors::WebSocketConnectionError
+    end
+    class LiveProtocolError < OpenAI::Errors::WebSocketProtocolError
+      def initialize: -> void
+    end
+  end
+
+  module Models
+    module Live
+      type connection_server_event =
+        OpenAI::Models::Live::server_event | OpenAI::Live::UnknownServerEvent
+      type connection_client_event =
+        OpenAI::Models::Live::client_event | ::Hash[Symbol | String, untyped]
+      type fork_connection_server_event =
+        OpenAI::Models::Live::fork_server_event
+        | OpenAI::Live::UnknownServerEvent
+      type fork_connection_client_event =
+        OpenAI::Models::Live::fork_client_event
+        | ::Hash[Symbol | String, untyped]
+      type sideband_connection_client_event =
+        OpenAI::Models::Live::SessionUpdateEvent
+        | OpenAI::Models::Live::InputAudioMuteEvent
+        | OpenAI::Models::Live::InputAudioUnmuteEvent
+        | OpenAI::Models::Live::InstructionsAppendEvent
+        | OpenAI::Models::Live::ThinkingAppendEvent
+        | OpenAI::Models::Live::CommentaryAppendEvent
+        | OpenAI::Models::Live::ResponseItemCreateEvent
+        | OpenAI::Models::Live::ResponseCreateEvent
+        | OpenAI::Models::Live::SessionCloseEvent
+        | ::Hash[Symbol | String, untyped]
+
+      class UnknownServerEvent
+        attr_reader type: Symbol
+        attr_reader data: ::Hash[Symbol | String, untyped]
+        def initialize: (data: ::Hash[Symbol | String, untyped]) -> void
+        def to_h: -> ::Hash[(Symbol | String), untyped]
+        def inspect: -> String
+        alias to_s inspect
+      end
+      class Connection
+        include Enumerable[OpenAI::Models::Live::connection_server_event]
+        attr_reader url: URI::Generic
+        def initialize: (socket: top, url: URI::Generic) -> void
+        def each:
+          -> Enumerator[OpenAI::Models::Live::connection_server_event, self]
+          | {
+            (OpenAI::Models::Live::connection_server_event event) -> void
+          } -> self
+        def receive: -> OpenAI::Models::Live::connection_server_event?
+        def receive_raw: -> String?
+        def send_event: (
+          OpenAI::Models::Live::connection_client_event event
+        ) -> nil
+        def send_raw: (String data) -> nil
+        def close: (?code: Integer, ?reason: String) -> nil
+        def abort: -> nil
+        def closed?: -> bool
+      end
+      class SidebandConnection
+        include Enumerable[OpenAI::Models::Live::connection_server_event]
+        attr_reader url: URI::Generic
+        def initialize: (socket: top, url: URI::Generic) -> void
+        def each:
+          -> Enumerator[OpenAI::Models::Live::connection_server_event, self]
+          | {
+            (OpenAI::Models::Live::connection_server_event event) -> void
+          } -> self
+        def receive: -> OpenAI::Models::Live::connection_server_event?
+        def receive_raw: -> String?
+        def send_event: (
+          OpenAI::Models::Live::sideband_connection_client_event event
+        ) -> nil
+        def send_raw: (String data) -> nil
+        def close: (?code: Integer, ?reason: String) -> nil
+        def abort: -> nil
+        def closed?: -> bool
+      end
+      class ForkConnection
+        include Enumerable[OpenAI::Models::Live::fork_connection_server_event]
+        attr_reader url: URI::Generic
+        def initialize: (socket: top, url: URI::Generic) -> void
+        def each:
+          -> Enumerator[OpenAI::Models::Live::fork_connection_server_event, self]
+          | {
+            (OpenAI::Models::Live::fork_connection_server_event event) -> void
+          } -> self
+        def receive: -> OpenAI::Models::Live::fork_connection_server_event?
+        def receive_raw: -> String?
+        def send_event: (
+          OpenAI::Models::Live::fork_connection_client_event event
+        ) -> nil
+        def send_raw: (String data) -> nil
+        def close: (?code: Integer, ?reason: String) -> nil
+        def abort: -> nil
+        def closed?: -> bool
+      end
+    end
+  end
+
+  module Resources
+    class Live
+      def connect: [T] (
+        ?websocket_base_url: String?,
+        ?request_options: OpenAI::request_opts?,
+        ?transport: top,
+        ?transport_options: ::Hash[Symbol, top]
+      ) {
+        (OpenAI::Live::Connection connection) -> T
+      } -> T
+      class Sideband
+        def connect: [T] (
+          String session_id,
+          ?graceful_close: bool?,
+          ?websocket_base_url: String?,
+          ?request_options: OpenAI::request_opts?,
+          ?transport: top,
+          ?transport_options: ::Hash[Symbol, top]
+        ) {
+          (OpenAI::Live::SidebandConnection connection) -> T
+        } -> T
+      end
+      class Forks
+        def connect: [T] (
+          String session_id,
+          ?websocket_base_url: String?,
+          ?request_options: OpenAI::request_opts?,
+          ?transport: top,
+          ?transport_options: ::Hash[Symbol, top]
+        ) {
+          (OpenAI::Live::ForkConnection connection) -> T
+        } -> T
+      end
+    end
+  end
+end

data/sig/openai/helpers/realtime/translation.rbs

@@ -0,0 +1,81 @@
+module OpenAI
+  class Client
+    # @api private
+    def with_translation_connection_request: (
+      model: String,
+      ?websocket_base_url: String?,
+      ?options: OpenAI::request_opts?
+    ) {
+      (
+        OpenAI::Internal::Transport::BaseClient::request_input request,
+        ^-> void mark_handshake_completed
+      ) -> top
+    } -> top
+  end
+
+  module Errors
+    class TranslationConnectionError < OpenAI::Errors::WebSocketConnectionError
+    end
+    class TranslationProtocolError < OpenAI::Errors::WebSocketProtocolError
+      def initialize: -> void
+    end
+  end
+
+  module Models
+    module Realtime
+      type translation_connection_server_event =
+        OpenAI::Models::Realtime::realtime_translation_server_event
+        | OpenAI::Realtime::UnknownTranslationServerEvent
+      type translation_connection_client_event =
+        OpenAI::Models::Realtime::realtime_translation_client_event
+        | ::Hash[Symbol | String, untyped]
+
+      class UnknownTranslationServerEvent < OpenAI::Realtime::UnknownServerEvent
+        def inspect: -> String
+        alias to_s inspect
+      end
+      class TranslationConnection
+        include Enumerable[OpenAI::Models::Realtime::translation_connection_server_event]
+        attr_reader url: URI::Generic
+        def initialize: (socket: top, url: URI::Generic) -> void
+        def each:
+          -> Enumerator[OpenAI::Models::Realtime::translation_connection_server_event, self]
+          | {
+            (
+              OpenAI::Models::Realtime::translation_connection_server_event event
+            ) -> void
+          } -> self
+        def receive: -> OpenAI::Models::Realtime::translation_connection_server_event?
+        def receive_raw: -> String?
+        def send_event: (
+          OpenAI::Models::Realtime::translation_connection_client_event event
+        ) -> nil
+        def finish: (
+          timeout: Numeric
+        ) {
+          (
+            OpenAI::Models::Realtime::translation_connection_server_event event
+          ) -> void
+        } -> OpenAI::Realtime::RealtimeTranslationSessionClosedEvent
+        def send_raw: (String data) -> nil
+        def close: (?code: Integer, ?reason: String) -> nil
+        def abort: -> nil
+        def closed?: -> bool
+      end
+    end
+  end
+
+  module Resources
+    class Realtime
+      def connect_translation: [T] (
+        model: String,
+        ?websocket_base_url: String?,
+        ?request_options: OpenAI::request_opts?,
+        ?transport: top,
+        ?transport_options: ::Hash[Symbol, top]
+      ) {
+        (OpenAI::Realtime::TranslationConnection connection) -> T
+      } -> T
+    end
+  end
+end

data/sig/openai/helpers/responses_websocket/incremental.rbs

@@ -0,0 +1,14 @@
+module OpenAI
+  module Models
+    module Responses
+      class IncrementalResponse
+        attr_reader phase: (:provisional | :unavailable | :terminal)?
+        def initialize: -> void
+        def output: -> Array[(response_output_item | Hash[Symbol, untyped])]?
+        def terminal_event: -> connection_server_event?
+        def add: (connection_server_event event) -> void
+        def reset: -> void
+      end
+    end
+  end
+end

data/sig/openai/helpers/responses_websocket/transports/async_websocket.rbs

@@ -3,6 +3,27 @@ module OpenAI
     module Responses
       module Transports
         class AsyncWebSocket
+          # @api private
+          module PeekableFramer
+            # @api private
+            def next_frame_compressed?: -> bool
+          end
+
+          # @api private
+          class BoundedFramer
+            # @api private
+            def compression_negotiated=: (bool value) -> bool
+          end
+
+          # @api private
+          module BoundedInflate
+            # @api private
+            def bound_decoded_messages: (
+              Integer max_bytes,
+              BoundedFramer framer
+            ) -> void
+          end
+
           def initialize: -> void
           def open: (
             url: URI::Generic,

data/sig/openai/helpers/streaming/response_stream.rbs

@@ -98,6 +98,15 @@ module OpenAI
         def get_final_response: -> OpenAI::Responses::Response
         def get_output_text: -> String
       end
+
+      # @api private
+      class ResponseStreamState
+        def initialize: (
+          text_format: untyped,
+          ?starting_after: Integer?
+        ) -> void
+        def accumulate_output: (untyped event, Array[untyped] items) -> void
+      end
     end
   end
 end

data/sig/openai/internal/type/converter.rbs

@@ -9,6 +9,7 @@ module OpenAI
         type coerce_state =
           {
             translate_names: bool,
+            request_only: bool,
             strictness: bool,
             exactness: { yes: Integer, no: Integer, maybe: Integer },
             error: StandardError?,
@@ -57,7 +58,8 @@ module OpenAI
         ) -> ::Hash[Symbol, top]
 
         def self.new_coerce_state: (
-          ?translate_names: bool
+          ?translate_names: bool,
+          ?request_only: bool
         ) -> OpenAI::Internal::Type::Converter::coerce_state
 
         def self.coerce: (

data/sig/openai/models/audio/speech_create_params.rbs

@@ -136,6 +136,9 @@ module OpenAI
           | :verse
           | :marin
           | :cedar
+          | :fable
+          | :onyx
+          | :nova
           | OpenAI::Audio::SpeechCreateParams::Voice::ID
 
         module Voice
@@ -166,6 +169,9 @@ module OpenAI
           VERSE: :verse
           MARIN: :marin
           CEDAR: :cedar
+          FABLE: :fable
+          ONYX: :onyx
+          NOVA: :nova
         end
 
         type response_format = :mp3 | :opus | :aac | :flac | :wav | :pcm

data/sig/openai/models/audio/transcription_create_response.rbs

@@ -5,6 +5,7 @@ module OpenAI
         OpenAI::Audio::Transcription
         | OpenAI::Audio::TranscriptionDiarized
         | OpenAI::Audio::TranscriptionVerbose
+        | StringIO
 
       module TranscriptionCreateResponse
         extend OpenAI::Internal::Type::Union

data/sig/openai/models/audio/translation_create_response.rbs

@@ -2,7 +2,9 @@ module OpenAI
   module Models
     module Audio
       type translation_create_response =
-        OpenAI::Audio::Translation | OpenAI::Audio::TranslationVerbose
+        OpenAI::Audio::Translation
+        | OpenAI::Audio::TranslationVerbose
+        | StringIO
 
       module TranslationCreateResponse
         extend OpenAI::Internal::Type::Union

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

@@ -118,7 +118,8 @@ module OpenAI
           updated_at: Integer
         }
 
-        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,7 @@ module OpenAI
           FLEX: :flex
           PRIORITY: :priority
           FAST: :fast
+          ULTRAFAST: :ultrafast
 
           def self?.values: -> ::Array[OpenAI::Models::Beta::Agent::service_tier]
         end

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

@@ -98,7 +98,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
@@ -118,6 +119,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_session.rbs

@@ -195,7 +195,8 @@ module OpenAI
             tools: ::Array[OpenAI::Models::Beta::agent_tool]
           }
 
-          type service_tier = :auto | :default | :flex | :priority | :fast
+          type service_tier =
+            :auto | :default | :flex | :priority | :fast | :ultrafast
 
           module ServiceTier
             extend OpenAI::Internal::Type::Enum
@@ -205,6 +206,7 @@ module OpenAI
             FLEX: :flex
             PRIORITY: :priority
             FAST: :fast
+            ULTRAFAST: :ultrafast
 
             def self?.values: -> ::Array[OpenAI::Models::Beta::AgentSession::Agent::service_tier]
           end

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

@@ -106,7 +106,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
@@ -126,6 +127,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

data/sig/openai/models/beta/agents/environments/template_create_params.rbs

@@ -35,7 +35,7 @@ module OpenAI
             attr_accessor name: String?
 
             # Network access policy for the environment. Defaults to disabled for GA requests
-            # and enabled for alpha/beta requests.
+            # and enabled for beta requests.
             attr_accessor network: OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network?
 
             # Packages to install in the environment. Defaults to empty package lists.
@@ -62,7 +62,7 @@ module OpenAI
             #   An optional human-readable display name for the template.
             # @param network
             #   Network access policy for the environment. Defaults to disabled for GA requests
-            #   and enabled for alpha/beta requests.
+            #   and enabled for beta requests.
             # @param packages
             #   Packages to install in the environment. Defaults to empty package lists.
             # @param plugins

data/sig/openai/models/beta/agents/environments/template_update_params.rbs

@@ -37,8 +37,8 @@ module OpenAI
             attr_accessor name: String?
 
             # Network access available after setup completes. Omit to preserve the current
-            # policy, or pass `null` to reset to disabled for GA requests or enabled for
-            # alpha/beta requests.
+            # policy, or pass `null` to reset to disabled for GA requests or enabled for beta
+            # requests.
             attr_accessor network: OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Network?
 
             # Packages installed before the runtime network policy applies.
@@ -63,8 +63,8 @@ module OpenAI
             #   A replacement human-readable display name, or `null` to clear the name.
             # @param network
             #   Network access available after setup completes. Omit to preserve the current
-            #   policy, or pass `null` to reset to disabled for GA requests or enabled for
-            #   alpha/beta requests.
+            #   policy, or pass `null` to reset to disabled for GA requests or enabled for beta
+            #   requests.
             # @param packages
             #   Packages installed before the runtime network policy applies.
             # @param plugins

data/sig/openai/models/beta/agents/session_create_params.rbs

@@ -163,7 +163,8 @@ module OpenAI
               ?tools: ::Array[OpenAI::Models::Beta::agent_tool_param]?
             }
 
-            type service_tier = :auto | :default | :flex | :priority | :fast
+            type service_tier =
+              :auto | :default | :flex | :priority | :fast | :ultrafast
 
             module ServiceTier
               extend OpenAI::Internal::Type::Enum
@@ -183,6 +184,9 @@ module OpenAI
               # Uses the fast service tier.
               FAST: :fast
 
+              # Uses the ultrafast service tier.
+              ULTRAFAST: :ultrafast
+
               def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::SessionCreateParams::Agent::service_tier]
             end
           end

data/sig/openai/models/beta/agents/session_update_params.rbs

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

data/sig/openai/models/beta/agents/vaults/credential.rbs

@@ -8,6 +8,7 @@ module OpenAI
               id: String,
               auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth,
               created_at: Integer,
+              metadata: ::Hash[Symbol, String],
               name: String,
               ?object: :"vault.credential",
               updated_at: Integer,
@@ -24,6 +25,9 @@ module OpenAI
             # The Unix timestamp, in seconds, when the credential was created.
             attr_accessor created_at: Integer
 
+            # Application-defined key-value pairs associated with this credential.
+            attr_accessor metadata: ::Hash[Symbol, String]
+
             # The human-readable name of the credential.
             attr_accessor name: String
 
@@ -42,6 +46,8 @@ module OpenAI
             #   The authentication method and non-secret configuration of the credential.
             # @param created_at
             #   The Unix timestamp, in seconds, when the credential was created.
+            # @param metadata
+            #   Application-defined key-value pairs associated with this credential.
             # @param name
             #   The human-readable name of the credential.
             # @param updated_at
@@ -54,6 +60,7 @@ module OpenAI
               id: String,
               auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth,
               created_at: Integer,
+              metadata: ::Hash[Symbol, String],
               name: String,
               updated_at: Integer,
               vault_id: String,
@@ -64,6 +71,7 @@ module OpenAI
               id: String,
               auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth,
               created_at: Integer,
+              metadata: ::Hash[Symbol, String],
               name: String,
               ?object: :"vault.credential",
               updated_at: Integer,