openai 0.88.0 → 0.89.0

data/rbi/openai/models/live/fork_session_start_event.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Live
+
+      class ForkSessionStartEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Live::ForkSessionStartEvent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # Overrides for a stored session after connecting to the fork WebSocket. An empty
+        # object inherits the stored configuration; do not supply a new model.
+        # audio.format applies only to the new WebSocket connection. client overrides are
+        # only supported for WebRTC forks.
+        sig { returns(OpenAI::Live::ForkSessionConfig) }
+        attr_reader :session
+
+        sig { params(session: OpenAI::Live::ForkSessionConfig::OrHash).void }
+        attr_writer :session
+
+        # The Live client event type. Always `session.start`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Optional client identifier for correlating this command with a server event's
+        # client_event_id or error.client_event_id.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :event_id
+
+        # Start a Live session after connecting to a stored session’s fork WebSocket. Send
+        # an empty `session` object to use the stored configuration.
+        sig do
+          params(
+
+            session: OpenAI::Live::ForkSessionConfig::OrHash,
+
+            event_id: T.nilable(String),
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # Overrides for a stored session after connecting to the fork WebSocket. An empty
+          # object inherits the stored configuration; do not supply a new model.
+          # audio.format applies only to the new WebSocket connection. client overrides are
+          # only supported for WebRTC forks.
+          session:,
+
+          # Optional client identifier for correlating this command with a server event's
+          # client_event_id or error.client_event_id.
+          event_id: nil,
+
+          # The Live client event type. Always `session.start`.
+
+          type: :"session.start"
+        )
+        end
+
+        sig do
+          override.returns(
+            {session: OpenAI::Live::ForkSessionConfig, type: Symbol, event_id: T.nilable(String)}
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/live/function_tool.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Live
+
+      class FunctionTool < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Live::FunctionTool,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The name the delegated Responses model uses when calling this function.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The tool type. Always `function`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # What the function does and when the delegated Responses model should call it.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # A JSON Schema object describing the arguments accepted by the function.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :parameters
+
+        # Whether the delegated Responses model must follow the function’s parameter
+        # schema exactly.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :strict
+
+        # A function tool available to the Responses backend when the Live model delegates
+        # a task.
+        sig do
+          params(
+
+            name: String,
+
+            description: T.nilable(String),
+
+            parameters: T.nilable(T::Hash[Symbol, T.anything]),
+
+            strict: T.nilable(T::Boolean),
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The name the delegated Responses model uses when calling this function.
+          name:,
+
+          # What the function does and when the delegated Responses model should call it.
+          description: nil,
+
+          # A JSON Schema object describing the arguments accepted by the function.
+          parameters: nil,
+
+          # Whether the delegated Responses model must follow the function’s parameter
+          # schema exactly.
+          strict: nil,
+
+          # The tool type. Always `function`.
+
+          type: :function
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              name: String,
+              type: Symbol,
+              description: T.nilable(String),
+              parameters: T.nilable(T::Hash[Symbol, T.anything]),
+              strict: T.nilable(T::Boolean)
+            }
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/live/info_event.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Live
+
+      class InfoEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Live::InfoEvent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # A machine-readable code for the notice, such as `data_channel_permissions`.
+        sig { returns(String) }
+        attr_accessor :code
+
+        # The unique ID of the Live server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # A human-readable explanation of the Live session notice.
+        sig { returns(String) }
+        attr_accessor :message
+
+        # The event type, always `info`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The event_id of the client command associated with this server event, when
+        # supplied.
+        sig { returns(T.nilable(String)) }
+        attr_reader :client_event_id
+
+        sig { params(client_event_id: String).void }
+        attr_writer :client_event_id
+
+        # An informational notice about the Live session, such as the event permissions
+        # applied to a frontend data channel.
+        sig do
+          params(
+
+            code: String,
+
+            event_id: String,
+
+            message: String,
+
+            client_event_id: String,
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # A machine-readable code for the notice, such as `data_channel_permissions`.
+          code:,
+
+          # The unique ID of the Live server event.
+          event_id:,
+
+          # A human-readable explanation of the Live session notice.
+          message:,
+
+          # The event_id of the client command associated with this server event, when
+          # supplied.
+          client_event_id: nil,
+
+          # The event type, always `info`.
+
+          type: :info
+        )
+        end
+
+        sig do
+          override.returns(
+            {code: String, event_id: String, message: String, type: Symbol, client_event_id: T.nilable(String)}
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end