openai 0.92.0 → 0.93.0

data/sig/openai/models/live/error_event.rbs

@@ -10,16 +10,32 @@ module OpenAI
         }
 
       class ErrorEvent < OpenAI::Internal::Type::BaseModel
+        # Details of the Live error and the client command that caused it, when known.
         attr_accessor error: OpenAI::Live::Error
 
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
 
+        # The event type, always `error`.
         attr_accessor type: :error
 
+        # The event_id of the client command associated with this server event, when
+        # supplied.
         attr_reader client_event_id: String?
 
+        # The event_id of the client command associated with this server event, when
+        # supplied.
         def client_event_id=: (String) -> String
 
+        # @param error
+        #   Details of the Live error and the client command that caused it, when known.
+        # @param event_id
+        #   The unique ID of the Live server event.
+        # @param client_event_id
+        #   The event_id of the client command associated with this server event, when
+        #   supplied.
+        # @param type
+        #   The event type, always `error`.
         def initialize: (
           error: OpenAI::Live::Error,
           event_id: String,

data/sig/openai/models/live/fork_server_event.rbs

@@ -32,10 +32,20 @@ module OpenAI
           { audio: String, ?type: :"session.input_audio.append" }
 
         class SessionInputAudioAppend < OpenAI::Internal::Type::BaseModel
+          # 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.
           attr_accessor audio: String
 
+          # The event type, always `session.input_audio.append`.
           attr_accessor type: :"session.input_audio.append"
 
+          # @param audio
+          #   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.
+          # @param type
+          #   The event type, always `session.input_audio.append`.
           def initialize: (
             audio: String,
             ?type: :"session.input_audio.append"
@@ -99,10 +109,13 @@ module OpenAI
         class TransportRinging < OpenAI::Internal::Type::BaseModel
           attr_accessor event_id: String
 
+          # The canonical Live session ID.
           attr_accessor session_id: String
 
           attr_accessor type: :"transport.ringing"
 
+          # @param session_id
+          #   The canonical Live session ID.
           def initialize: (
             event_id: String,
             session_id: String,
@@ -122,10 +135,13 @@ module OpenAI
         class TransportAnswered < OpenAI::Internal::Type::BaseModel
           attr_accessor event_id: String
 
+          # The canonical Live session ID.
           attr_accessor session_id: String
 
           attr_accessor type: :"transport.answered"
 
+          # @param session_id
+          #   The canonical Live session ID.
           def initialize: (
             event_id: String,
             session_id: String,
@@ -152,10 +168,13 @@ module OpenAI
 
           attr_accessor event_id: String
 
+          # The canonical Live session ID.
           attr_accessor session_id: String
 
           attr_accessor type: :"transport.failed"
 
+          # @param session_id
+          #   The canonical Live session ID.
           def initialize: (
             error: OpenAI::Live::ForkServerEvent::TransportFailed::Error,
             event_id: String,
@@ -179,16 +198,23 @@ module OpenAI
             }
 
           class Error < OpenAI::Internal::Type::BaseModel
+            # The call setup failure code.
             attr_accessor code: String
 
             attr_accessor message: String
 
             attr_accessor type: :call_error
 
+            # The parameter related to the error, if any. Empty when no parameter applies.
             attr_reader param: String?
 
+            # The parameter related to the error, if any. Empty when no parameter applies.
             def param=: (String) -> String
 
+            # @param code
+            #   The call setup failure code.
+            # @param param
+            #   The parameter related to the error, if any. Empty when no parameter applies.
             def initialize: (
               code: String,
               message: String,

data/sig/openai/models/live/fork_session_config.rbs

@@ -10,26 +10,57 @@ module OpenAI
         }
 
       class ForkSessionConfig < OpenAI::Internal::Type::BaseModel
+        # Audio format for a WebSocket fork. WebRTC forks negotiate their audio format and
+        # must omit this field.
         attr_reader audio: OpenAI::Live::ForkSessionConfig::Audio?
 
+        # Audio format for a WebSocket fork. WebRTC forks negotiate their audio format and
+        # must omit this field.
         def audio=: (
           OpenAI::Live::ForkSessionConfig::Audio
         ) -> OpenAI::Live::ForkSessionConfig::Audio
 
+        # Frontend data-channel permissions for a WebRTC fork. Omitted permissions inherit
+        # the stored values. Not supported for WebSocket forks.
         attr_reader client: OpenAI::Live::ClientConfig?
 
+        # Frontend data-channel permissions for a WebRTC fork. Omitted permissions inherit
+        # the stored values. Not supported for WebSocket forks.
         def client=: (OpenAI::Live::ClientConfig) -> OpenAI::Live::ClientConfig
 
+        # Overrides for the stored session’s Responses backend. Only supported when the
+        # stored session already uses Responses delegation; the delegation type cannot
+        # change.
         attr_reader delegation: OpenAI::Live::ForkSessionConfig::Delegation?
 
+        # Overrides for the stored session’s Responses backend. Only supported when the
+        # stored session already uses Responses delegation; the delegation type cannot
+        # change.
         def delegation=: (
           OpenAI::Live::ForkSessionConfig::Delegation
         ) -> OpenAI::Live::ForkSessionConfig::Delegation
 
+        # Whether to store the forked session. Omission inherits the stored session's
+        # setting.
         attr_reader store: bool?
 
+        # Whether to store the forked session. Omission inherits the stored session's
+        # setting.
         def store=: (bool) -> bool
 
+        # @param audio
+        #   Audio format for a WebSocket fork. WebRTC forks negotiate their audio format and
+        #   must omit this field.
+        # @param client
+        #   Frontend data-channel permissions for a WebRTC fork. Omitted permissions inherit
+        #   the stored values. Not supported for WebSocket forks.
+        # @param delegation
+        #   Overrides for the stored session’s Responses backend. Only supported when the
+        #   stored session already uses Responses delegation; the delegation type cannot
+        #   change.
+        # @param store
+        #   Whether to store the forked session. Omission inherits the stored session's
+        #   setting.
         def initialize: (
           ?audio: OpenAI::Live::ForkSessionConfig::Audio,
           ?client: OpenAI::Live::ClientConfig,
@@ -47,12 +78,19 @@ module OpenAI
         type audio = { ?format_: OpenAI::Models::Live::audio_format }
 
         class Audio < OpenAI::Internal::Type::BaseModel
+          # Audio encoding and sample rate for audio sent and received over a Live WebSocket
+          # connection. WebRTC and SIP negotiate their media format separately.
           attr_reader format_: OpenAI::Models::Live::audio_format?
 
+          # Audio encoding and sample rate for audio sent and received over a Live WebSocket
+          # connection. WebRTC and SIP negotiate their media format separately.
           def format_=: (
             OpenAI::Models::Live::audio_format
           ) -> OpenAI::Models::Live::audio_format
 
+          # @param format_
+          #   Audio encoding and sample rate for audio sent and received over a Live WebSocket
+          #   connection. WebRTC and SIP negotiate their media format separately.
           def initialize: (?format_: OpenAI::Models::Live::audio_format) -> void
 
           def to_hash: -> { ?format_: OpenAI::Models::Live::audio_format }
@@ -65,14 +103,24 @@ module OpenAI
           }
 
         class Delegation < OpenAI::Internal::Type::BaseModel
+          # The delegation owner. Always `responses` for tasks handled by the Responses API.
           attr_accessor type: :responses
 
+          # Responses backend settings to update. Omitted settings keep their existing
+          # values.
           attr_reader responses: OpenAI::Live::ResponsesDelegationUpdateConfig?
 
+          # Responses backend settings to update. Omitted settings keep their existing
+          # values.
           def responses=: (
             OpenAI::Live::ResponsesDelegationUpdateConfig
           ) -> OpenAI::Live::ResponsesDelegationUpdateConfig
 
+          # @param responses
+          #   Responses backend settings to update. Omitted settings keep their existing
+          #   values.
+          # @param type
+          #   The delegation owner. Always `responses` for tasks handled by the Responses API.
           def initialize: (
             ?responses: OpenAI::Live::ResponsesDelegationUpdateConfig,
             ?type: :responses

data/sig/openai/models/live/fork_session_start_event.rbs

@@ -9,12 +9,29 @@ module OpenAI
         }
 
       class ForkSessionStartEvent < OpenAI::Internal::Type::BaseModel
+        # 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.
         attr_accessor session: OpenAI::Live::ForkSessionConfig
 
+        # The Live client event type. Always `session.start`.
         attr_accessor type: :"session.start"
 
+        # Optional client identifier for correlating this command with a server event's
+        # client_event_id or error.client_event_id.
         attr_accessor event_id: String?
 
+        # @param session
+        #   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.
+        # @param event_id
+        #   Optional client identifier for correlating this command with a server event's
+        #   client_event_id or error.client_event_id.
+        # @param type
+        #   The Live client event type. Always `session.start`.
         def initialize: (
           session: OpenAI::Live::ForkSessionConfig,
           ?event_id: String?,

data/sig/openai/models/live/function_tool.rbs

@@ -11,16 +11,33 @@ module OpenAI
         }
 
       class FunctionTool < OpenAI::Internal::Type::BaseModel
+        # The name the delegated Responses model uses when calling this function.
         attr_accessor name: String
 
+        # The tool type. Always `function`.
         attr_accessor type: :function
 
+        # What the function does and when the delegated Responses model should call it.
         attr_accessor description: String?
 
+        # A JSON Schema object describing the arguments accepted by the function.
         attr_accessor parameters: ::Hash[Symbol, top]?
 
+        # Whether the delegated Responses model must follow the function’s parameter
+        # schema exactly.
         attr_accessor strict: bool?
 
+        # @param name
+        #   The name the delegated Responses model uses when calling this function.
+        # @param description
+        #   What the function does and when the delegated Responses model should call it.
+        # @param parameters
+        #   A JSON Schema object describing the arguments accepted by the function.
+        # @param strict
+        #   Whether the delegated Responses model must follow the function’s parameter
+        #   schema exactly.
+        # @param type
+        #   The tool type. Always `function`.
         def initialize: (
           name: String,
           ?description: String?,

data/sig/openai/models/live/info_event.rbs

@@ -11,18 +11,37 @@ module OpenAI
         }
 
       class InfoEvent < OpenAI::Internal::Type::BaseModel
+        # A machine-readable code for the notice, such as `data_channel_permissions`.
         attr_accessor code: String
 
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
 
+        # A human-readable explanation of the Live session notice.
         attr_accessor message: String
 
+        # The event type, always `info`.
         attr_accessor type: :info
 
+        # The event_id of the client command associated with this server event, when
+        # supplied.
         attr_reader client_event_id: String?
 
+        # The event_id of the client command associated with this server event, when
+        # supplied.
         def client_event_id=: (String) -> String
 
+        # @param code
+        #   A machine-readable code for the notice, such as `data_channel_permissions`.
+        # @param event_id
+        #   The unique ID of the Live server event.
+        # @param message
+        #   A human-readable explanation of the Live session notice.
+        # @param client_event_id
+        #   The event_id of the client command associated with this server event, when
+        #   supplied.
+        # @param type
+        #   The event type, always `info`.
         def initialize: (
           code: String,
           event_id: String,

data/sig/openai/models/live/initial_item.rbs

@@ -19,20 +19,42 @@ module OpenAI
           }
 
         class Developer < OpenAI::Internal::Type::BaseModel
+          # The message content. Supply exactly one text part for the initial Live
+          # conversation history.
           attr_accessor content: ::Array[OpenAI::Live::InitialItem::Developer::Content]
 
+          # The author of this history message. Always `developer`.
           attr_accessor role: :developer
 
+          # An optional identifier for the supplied history message. Live uses the message’s
+          # role and text to initialize the conversation.
           attr_accessor id: String?
 
+          # The supplied message’s status. Live uses its text as history and does not resume
+          # an incomplete message.
           attr_accessor status: OpenAI::Models::Live::InitialItem::Developer::status?
 
+          # The history item type. Always `message`.
           attr_reader type: OpenAI::Models::Live::InitialItem::Developer::type_?
 
+          # The history item type. Always `message`.
           def type=: (
             OpenAI::Models::Live::InitialItem::Developer::type_
           ) -> OpenAI::Models::Live::InitialItem::Developer::type_
 
+          # @param content
+          #   The message content. Supply exactly one text part for the initial Live
+          #   conversation history.
+          # @param id
+          #   An optional identifier for the supplied history message. Live uses the message’s
+          #   role and text to initialize the conversation.
+          # @param status
+          #   The supplied message’s status. Live uses its text as history and does not resume
+          #   an incomplete message.
+          # @param type
+          #   The history item type. Always `message`.
+          # @param role
+          #   The author of this history message. Always `developer`.
           def initialize: (
             content: ::Array[OpenAI::Live::InitialItem::Developer::Content],
             ?id: String?,
@@ -56,14 +78,21 @@ module OpenAI
             }
 
           class Content < OpenAI::Internal::Type::BaseModel
+            # The message text to include in the Live session’s initial conversation history.
             attr_accessor text: String
 
+            # The text content type. Always `input_text`.
             attr_reader type: OpenAI::Models::Live::InitialItem::Developer::Content::type_?
 
+            # The text content type. Always `input_text`.
             def type=: (
               OpenAI::Models::Live::InitialItem::Developer::Content::type_
             ) -> OpenAI::Models::Live::InitialItem::Developer::Content::type_
 
+            # @param text
+            #   The message text to include in the Live session’s initial conversation history.
+            # @param type
+            #   The text content type. Always `input_text`.
             def initialize: (
               text: String,
               ?type: OpenAI::Models::Live::InitialItem::Developer::Content::type_
@@ -117,20 +146,42 @@ module OpenAI
           }
 
         class User < OpenAI::Internal::Type::BaseModel
+          # The message content. Supply exactly one text part for the initial Live
+          # conversation history.
           attr_accessor content: ::Array[OpenAI::Live::InitialItem::User::Content]
 
+          # The author of this history message. Always `user`.
           attr_accessor role: :user
 
+          # An optional identifier for the supplied history message. Live uses the message’s
+          # role and text to initialize the conversation.
           attr_accessor id: String?
 
+          # The supplied message’s status. Live uses its text as history and does not resume
+          # an incomplete message.
           attr_accessor status: OpenAI::Models::Live::InitialItem::User::status?
 
+          # The history item type. Always `message`.
           attr_reader type: OpenAI::Models::Live::InitialItem::User::type_?
 
+          # The history item type. Always `message`.
           def type=: (
             OpenAI::Models::Live::InitialItem::User::type_
           ) -> OpenAI::Models::Live::InitialItem::User::type_
 
+          # @param content
+          #   The message content. Supply exactly one text part for the initial Live
+          #   conversation history.
+          # @param id
+          #   An optional identifier for the supplied history message. Live uses the message’s
+          #   role and text to initialize the conversation.
+          # @param status
+          #   The supplied message’s status. Live uses its text as history and does not resume
+          #   an incomplete message.
+          # @param type
+          #   The history item type. Always `message`.
+          # @param role
+          #   The author of this history message. Always `user`.
           def initialize: (
             content: ::Array[OpenAI::Live::InitialItem::User::Content],
             ?id: String?,
@@ -154,14 +205,21 @@ module OpenAI
             }
 
           class Content < OpenAI::Internal::Type::BaseModel
+            # The message text to include in the Live session’s initial conversation history.
             attr_accessor text: String
 
+            # The text content type. Always `input_text`.
             attr_reader type: OpenAI::Models::Live::InitialItem::User::Content::type_?
 
+            # The text content type. Always `input_text`.
             def type=: (
               OpenAI::Models::Live::InitialItem::User::Content::type_
             ) -> OpenAI::Models::Live::InitialItem::User::Content::type_
 
+            # @param text
+            #   The message text to include in the Live session’s initial conversation history.
+            # @param type
+            #   The text content type. Always `input_text`.
             def initialize: (
               text: String,
               ?type: OpenAI::Models::Live::InitialItem::User::Content::type_
@@ -215,20 +273,42 @@ module OpenAI
           }
 
         class Assistant < OpenAI::Internal::Type::BaseModel
+          # The message content. Supply exactly one text part for the initial Live
+          # conversation history.
           attr_accessor content: ::Array[OpenAI::Models::Live::InitialItem::Assistant::content]
 
+          # The author of this history message. Always `assistant`.
           attr_accessor role: :assistant
 
+          # An optional identifier for the supplied history message. Live uses the message’s
+          # role and text to initialize the conversation.
           attr_accessor id: String?
 
+          # The supplied message’s status. Live uses its text as history and does not resume
+          # an incomplete message.
           attr_accessor status: OpenAI::Models::Live::InitialItem::Assistant::status?
 
+          # The history item type. Always `message`.
           attr_reader type: OpenAI::Models::Live::InitialItem::Assistant::type_?
 
+          # The history item type. Always `message`.
           def type=: (
             OpenAI::Models::Live::InitialItem::Assistant::type_
           ) -> OpenAI::Models::Live::InitialItem::Assistant::type_
 
+          # @param content
+          #   The message content. Supply exactly one text part for the initial Live
+          #   conversation history.
+          # @param id
+          #   An optional identifier for the supplied history message. Live uses the message’s
+          #   role and text to initialize the conversation.
+          # @param status
+          #   The supplied message’s status. Live uses its text as history and does not resume
+          #   an incomplete message.
+          # @param type
+          #   The history item type. Always `message`.
+          # @param role
+          #   The author of this history message. Always `assistant`.
           def initialize: (
             content: ::Array[OpenAI::Models::Live::InitialItem::Assistant::content],
             ?id: String?,
@@ -259,14 +339,21 @@ module OpenAI
               }
 
             class Text < OpenAI::Internal::Type::BaseModel
+              # The message text to include in the Live session’s initial conversation history.
               attr_accessor text: String
 
+              # The text content type. Always `text`.
               attr_reader type: OpenAI::Models::Live::InitialItem::Assistant::Content::Text::type_?
 
+              # The text content type. Always `text`.
               def type=: (
                 OpenAI::Models::Live::InitialItem::Assistant::Content::Text::type_
               ) -> OpenAI::Models::Live::InitialItem::Assistant::Content::Text::type_
 
+              # @param text
+              #   The message text to include in the Live session’s initial conversation history.
+              # @param type
+              #   The text content type. Always `text`.
               def initialize: (
                 text: String,
                 ?type: OpenAI::Models::Live::InitialItem::Assistant::Content::Text::type_
@@ -291,10 +378,16 @@ module OpenAI
             type output_text = { text: String, ?type: :output_text }
 
             class OutputText < OpenAI::Internal::Type::BaseModel
+              # The message text to include in the Live session’s initial conversation history.
               attr_accessor text: String
 
+              # The text content type. Always `output_text`.
               attr_accessor type: :output_text
 
+              # @param text
+              #   The message text to include in the Live session’s initial conversation history.
+              # @param type
+              #   The text content type. Always `output_text`.
               def initialize: (text: String, ?type: :output_text) -> void
 
               def to_hash: -> { text: String, ?type: :output_text }

data/sig/openai/models/live/input_audio_append_event.rbs

@@ -9,12 +9,31 @@ module OpenAI
         }
 
       class InputAudioAppendEvent < OpenAI::Internal::Type::BaseModel
+        # Base64-encoded raw audio in the startup-selected format, without a WAV or other
+        # container header. Primary WebSocket only; media transports use their audio
+        # track. Audio appends have no acknowledgment. Reflected sideband server events
+        # reuse this event type and audio key, with no timestamps or event_id; their audio
+        # is always mono PCM16LE at 24 kHz.
         attr_accessor audio: String
 
+        # The Live client event type. Always `session.input_audio.append`.
         attr_accessor type: :"session.input_audio.append"
 
+        # Optional client identifier for correlating this command with a server event's
+        # client_event_id or error.client_event_id.
         attr_accessor event_id: String?
 
+        # @param audio
+        #   Base64-encoded raw audio in the startup-selected format, without a WAV or other
+        #   container header. Primary WebSocket only; media transports use their audio
+        #   track. Audio appends have no acknowledgment. Reflected sideband server events
+        #   reuse this event type and audio key, with no timestamps or event_id; their audio
+        #   is always mono PCM16LE at 24 kHz.
+        # @param event_id
+        #   Optional client identifier for correlating this command with a server event's
+        #   client_event_id or error.client_event_id.
+        # @param type
+        #   The Live client event type. Always `session.input_audio.append`.
         def initialize: (
           audio: String,
           ?event_id: String?,

data/sig/openai/models/live/input_audio_mute_event.rbs

@@ -5,10 +5,18 @@ module OpenAI
         { ?type: :"session.input_audio.mute", ?event_id: String? }
 
       class InputAudioMuteEvent < OpenAI::Internal::Type::BaseModel
+        # The Live client event type. Always `session.input_audio.mute`.
         attr_accessor type: :"session.input_audio.mute"
 
+        # Optional client identifier for correlating this command with a server event's
+        # client_event_id or error.client_event_id.
         attr_accessor event_id: String?
 
+        # @param event_id
+        #   Optional client identifier for correlating this command with a server event's
+        #   client_event_id or error.client_event_id.
+        # @param type
+        #   The Live client event type. Always `session.input_audio.mute`.
         def initialize: (
           ?event_id: String?,
           ?type: :"session.input_audio.mute"

data/sig/openai/models/live/input_audio_muted_event.rbs

@@ -9,14 +9,27 @@ module OpenAI
         }
 
       class InputAudioMutedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
 
+        # The event type, always `session.input_audio.muted`.
         attr_accessor type: :"session.input_audio.muted"
 
+        # The event_id of the client command associated with this server event, when
+        # supplied.
         attr_reader client_event_id: String?
 
+        # The event_id of the client command associated with this server event, when
+        # supplied.
         def client_event_id=: (String) -> String
 
+        # @param event_id
+        #   The unique ID of the Live server event.
+        # @param client_event_id
+        #   The event_id of the client command associated with this server event, when
+        #   supplied.
+        # @param type
+        #   The event type, always `session.input_audio.muted`.
         def initialize: (
           event_id: String,
           ?client_event_id: String,

data/sig/openai/models/live/input_audio_unmute_event.rbs

@@ -5,10 +5,18 @@ module OpenAI
         { ?type: :"session.input_audio.unmute", ?event_id: String? }
 
       class InputAudioUnmuteEvent < OpenAI::Internal::Type::BaseModel
+        # The Live client event type. Always `session.input_audio.unmute`.
         attr_accessor type: :"session.input_audio.unmute"
 
+        # Optional client identifier for correlating this command with a server event's
+        # client_event_id or error.client_event_id.
         attr_accessor event_id: String?
 
+        # @param event_id
+        #   Optional client identifier for correlating this command with a server event's
+        #   client_event_id or error.client_event_id.
+        # @param type
+        #   The Live client event type. Always `session.input_audio.unmute`.
         def initialize: (
           ?event_id: String?,
           ?type: :"session.input_audio.unmute"

data/sig/openai/models/live/input_audio_unmuted_event.rbs

@@ -9,14 +9,27 @@ module OpenAI
         }
 
       class InputAudioUnmutedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
 
+        # The event type, always `session.input_audio.unmuted`.
         attr_accessor type: :"session.input_audio.unmuted"
 
+        # The event_id of the client command associated with this server event, when
+        # supplied.
         attr_reader client_event_id: String?
 
+        # The event_id of the client command associated with this server event, when
+        # supplied.
         def client_event_id=: (String) -> String
 
+        # @param event_id
+        #   The unique ID of the Live server event.
+        # @param client_event_id
+        #   The event_id of the client command associated with this server event, when
+        #   supplied.
+        # @param type
+        #   The event type, always `session.input_audio.unmuted`.
         def initialize: (
           event_id: String,
           ?client_event_id: String,