openai 0.95.0 → 0.97.0

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_browser_authentication_cancel_param.rbs

@@ -0,0 +1,21 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_browser_authentication_cancel_param =
+        { ?action: :cancel, ?type: :browser_authentication }
+
+      class AgentBrowserAuthenticationCancelParam < OpenAI::Internal::Type::BaseModel
+        attr_accessor action: :cancel
+
+        attr_accessor type: :browser_authentication
+
+        def initialize: (
+          ?action: :cancel,
+          ?type: :browser_authentication
+        ) -> void
+
+        def to_hash: -> { ?action: :cancel, ?type: :browser_authentication }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_browser_authentication_submit_param =
+        {
+          ?action: :submit,
+          fields: ::Array[OpenAI::Beta::AgentBrowserAuthenticationSubmitParam::Field],
+          ?type: :browser_authentication,
+          ?selected_option: String?
+        }
+
+      class AgentBrowserAuthenticationSubmitParam < OpenAI::Internal::Type::BaseModel
+        attr_accessor action: :submit
+
+        # Values for up to six active fields in the required action. The submitted
+        # field-value mapping and selected option must fit within 120 KiB of JSON.
+        attr_accessor fields: ::Array[OpenAI::Beta::AgentBrowserAuthenticationSubmitParam::Field]
+
+        attr_accessor type: :browser_authentication
+
+        # The chosen method. Required when the required action contains options.
+        attr_accessor selected_option: String?
+
+        # @param fields
+        #   Values for up to six active fields in the required action. The submitted
+        #   field-value mapping and selected option must fit within 120 KiB of JSON.
+        # @param selected_option
+        #   The chosen method. Required when the required action contains options.
+        def initialize: (
+          fields: ::Array[OpenAI::Beta::AgentBrowserAuthenticationSubmitParam::Field],
+          ?selected_option: String?,
+          ?action: :submit,
+          ?type: :browser_authentication
+        ) -> void
+
+        def to_hash: -> {
+          ?action: :submit,
+          fields: ::Array[OpenAI::Beta::AgentBrowserAuthenticationSubmitParam::Field],
+          ?type: :browser_authentication,
+          ?selected_option: String?
+        }
+
+        type field = { field_id: String, value: String }
+
+        class Field < OpenAI::Internal::Type::BaseModel
+          # The field ID from the required action.
+          attr_accessor field_id: String
+
+          # The value to enter into the registered control.
+          attr_accessor value: String
+
+          # @param field_id
+          #   The field ID from the required action.
+          # @param value
+          #   The value to enter into the registered control.
+          def initialize: (field_id: String, value: String) -> void
+
+          def to_hash: -> { field_id: String, value: String }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_browser_origin_access_param =
+        {
+          decision: OpenAI::Models::Beta::AgentBrowserOriginAccessParam::decision,
+          ?type: :browser_origin_access
+        }
+
+      class AgentBrowserOriginAccessParam < OpenAI::Internal::Type::BaseModel
+        # Whether to allow, deny, or cancel the requested origin access.
+        attr_accessor decision: OpenAI::Models::Beta::AgentBrowserOriginAccessParam::decision
+
+        attr_accessor type: :browser_origin_access
+
+        # @param decision
+        #   Whether to allow, deny, or cancel the requested origin access.
+        def initialize: (
+          decision: OpenAI::Models::Beta::AgentBrowserOriginAccessParam::decision,
+          ?type: :browser_origin_access
+        ) -> void
+
+        def to_hash: -> {
+          decision: OpenAI::Models::Beta::AgentBrowserOriginAccessParam::decision,
+          ?type: :browser_origin_access
+        }
+
+        type decision = :approve | :deny | :cancel
+
+        module Decision
+          extend OpenAI::Internal::Type::Enum
+
+          # Allow the browser to access this origin.
+          APPROVE: :approve
+
+          # Deny access to this origin.
+          DENY: :deny
+
+          # Dismiss this request without approving access.
+          CANCEL: :cancel
+
+          def self?.values: -> ::Array[OpenAI::Models::Beta::AgentBrowserOriginAccessParam::decision]
+        end
+      end
+    end
+  end
+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