RubyGems - openai - Versions diffs - 0.91.0 → 0.93.0 - Mend

openai 0.91.0 → 0.93.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1351) hide show

data/sig/openai/models/live/session_config.rbs CHANGED Viewed

@@ -13,32 +13,91 @@ module OpenAI
         }
       class SessionConfig < OpenAI::Internal::Type::BaseModel
+        # The Live model. Required in the session configuration for every transport; do
+        # not pass it as a URL query parameter.
         attr_accessor model: OpenAI::Models::Live::SessionConfig::model
+        # Startup audio configuration. Only primary WebSockets accept audio.format; WebRTC
+        # and SIP negotiate their media format. Voice and format are immutable after
+        # startup.
         attr_reader audio: OpenAI::Live::SessionConfig::Audio?
+        # Startup audio configuration. Only primary WebSockets accept audio.format; WebRTC
+        # and SIP negotiate their media format. Voice and format are immutable after
+        # startup.
         def audio=: (
           OpenAI::Live::SessionConfig::Audio
         ) -> OpenAI::Live::SessionConfig::Audio
+        # Startup-only capabilities for an untrusted frontend attached to a unified WebRTC
+        # session. Trusted sideband connections are unaffected.
         attr_reader client: OpenAI::Live::ClientConfig?
+        # Startup-only capabilities for an untrusted frontend attached to a unified WebRTC
+        # session. Trusted sideband connections are unaffected.
         def client=: (OpenAI::Live::ClientConfig) -> OpenAI::Live::ClientConfig
+        # Who handles tasks delegated by the Live model. Omitted or null selects your
+        # application; use `responses` to let the API manage a Responses backend.
         attr_accessor delegation: OpenAI::Models::Live::SessionConfig::delegation?
+        # Ordered text-only history supplied before startup. Supports developer, user, and
+        # assistant messages with one text part each; at most 128 messages and 8,192
+        # rendered tokens in total.
         attr_reader input: ::Array[OpenAI::Models::Live::initial_item]?
+        # Ordered text-only history supplied before startup. Supports developer, user, and
+        # assistant messages with one text part each; at most 128 messages and 8,192
+        # rendered tokens in total.
         def input=: (
           ::Array[OpenAI::Models::Live::initial_item]
         ) -> ::Array[OpenAI::Models::Live::initial_item]
+        # Frontend instructions for voice, conversation, interruptions, and when to
+        # delegate. Start with the
+        # [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting);
+        # put business rules and tool workflows in a separate
+        # [backend prompt](https://developers.openai.com/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).
+        # Limited to 16,384 client-supplied tokens. Omitted or blank instructions use
+        # server defaults. Immutable after startup.
         attr_accessor instructions: String?
+        # Whether to store the session for later forking and recording download. Defaults
+        # to false for new sessions.
         attr_reader store: bool?
+        # Whether to store the session for later forking and recording download. Defaults
+        # to false for new sessions.
         def store=: (bool) -> bool
+        # @param model
+        #   The Live model. Required in the session configuration for every transport; do
+        #   not pass it as a URL query parameter.
+        # @param audio
+        #   Startup audio configuration. Only primary WebSockets accept audio.format; WebRTC
+        #   and SIP negotiate their media format. Voice and format are immutable after
+        #   startup.
+        # @param client
+        #   Startup-only capabilities for an untrusted frontend attached to a unified WebRTC
+        #   session. Trusted sideband connections are unaffected.
+        # @param delegation
+        #   Who handles tasks delegated by the Live model. Omitted or null selects your
+        #   application; use `responses` to let the API manage a Responses backend.
+        # @param input
+        #   Ordered text-only history supplied before startup. Supports developer, user, and
+        #   assistant messages with one text part each; at most 128 messages and 8,192
+        #   rendered tokens in total.
+        # @param instructions
+        #   Frontend instructions for voice, conversation, interruptions, and when to
+        #   delegate. Start with the
+        #   [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting);
+        #   put business rules and tool workflows in a separate
+        #   [backend prompt](https://developers.openai.com/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).
+        #   Limited to 16,384 client-supplied tokens. Omitted or blank instructions use
+        #   server defaults. Immutable after startup.
+        # @param store
+        #   Whether to store the session for later forking and recording download. Defaults
+        #   to false for new sessions.
         def initialize: (
           model: OpenAI::Models::Live::SessionConfig::model,
           ?audio: OpenAI::Live::SessionConfig::Audio,
@@ -76,18 +135,29 @@ module OpenAI
           }
         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
+          # The voice used for speech generated by the Live model.
           attr_reader output: OpenAI::Live::SessionConfig::Audio::Output?
+          # The voice used for speech generated by the Live model.
           def output=: (
             OpenAI::Live::SessionConfig::Audio::Output
           ) -> OpenAI::Live::SessionConfig::Audio::Output
+          # @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.
+          # @param output
+          #   The voice used for speech generated by the Live model.
           def initialize: (
             ?format_: OpenAI::Models::Live::audio_format,
             ?output: OpenAI::Live::SessionConfig::Audio::Output
@@ -104,12 +174,19 @@ module OpenAI
             }
           class Output < OpenAI::Internal::Type::BaseModel
+            # The voice used for Live speech, as a built-in voice name or a custom voice
+            # object containing its ID. Defaults to `marin` and cannot change after startup.
             attr_reader voice: OpenAI::Models::Live::SessionConfig::Audio::Output::voice?
+            # The voice used for Live speech, as a built-in voice name or a custom voice
+            # object containing its ID. Defaults to `marin` and cannot change after startup.
             def voice=: (
               OpenAI::Models::Live::SessionConfig::Audio::Output::voice
             ) -> OpenAI::Models::Live::SessionConfig::Audio::Output::voice
+            # @param voice
+            #   The voice used for Live speech, as a built-in voice name or a custom voice
+            #   object containing its ID. Defaults to `marin` and cannot change after startup.
             def initialize: (
               ?voice: OpenAI::Models::Live::SessionConfig::Audio::Output::voice
             ) -> void
@@ -145,10 +222,18 @@ module OpenAI
             }
           class Responses < OpenAI::Internal::Type::BaseModel
+            # Backend model, prompt, and tools used when the Live session delegates a task to
+            # Responses.
             attr_accessor responses: OpenAI::Live::ResponsesDelegationConfig
+            # The delegation owner. Always `responses` for tasks handled by the Responses API.
             attr_accessor type: :responses
+            # @param responses
+            #   Backend model, prompt, and tools used when the Live session delegates a task to
+            #   Responses.
+            # @param type
+            #   The delegation owner. Always `responses` for tasks handled by the Responses API.
             def initialize: (
               responses: OpenAI::Live::ResponsesDelegationConfig,
               ?type: :responses

data/sig/openai/models/live/session_download_recording_params.rbs CHANGED Viewed

@@ -8,8 +8,13 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
+        # The ID of the stored Live session to download. Use the session ID returned when
+        # the session started with storage enabled.
         attr_accessor session_id: String
+        # @param session_id
+        #   The ID of the stored Live session to download. Use the session ID returned when
+        #   the session started with storage enabled.
         def initialize: (
           session_id: String,
           ?request_options: OpenAI::request_opts

data/sig/openai/models/live/session_fork_params.rbs CHANGED Viewed

@@ -15,14 +15,24 @@ module OpenAI
         attr_accessor session_id: String
+        # WebRTC transport with an SDP offer for the new connection to the forked session.
         attr_accessor transport: OpenAI::Live::SessionForkParams::Transport
+        # Optional configuration overrides for the new Live session. Omit this object or
+        # send an empty object to inherit the stored session's settings.
         attr_reader session: OpenAI::Live::MediaSessionForkConfig?
+        # Optional configuration overrides for the new Live session. Omit this object or
+        # send an empty object to inherit the stored session's settings.
         def session=: (
           OpenAI::Live::MediaSessionForkConfig
         ) -> OpenAI::Live::MediaSessionForkConfig
+        # @param transport
+        #   WebRTC transport with an SDP offer for the new connection to the forked session.
+        # @param session
+        #   Optional configuration overrides for the new Live session. Omit this object or
+        #   send an empty object to inherit the stored session's settings.
         def initialize: (
           session_id: String,
           transport: OpenAI::Live::SessionForkParams::Transport,
@@ -40,10 +50,16 @@ module OpenAI
         type transport = { sdp: String, ?type: :webrtc }
         class Transport < OpenAI::Internal::Type::BaseModel
+          # Session Description Protocol message for the WebRTC connection.
           attr_accessor sdp: String
+          # The transport used for the Live session. Always `webrtc`.
           attr_accessor type: :webrtc
+          # @param sdp
+          #   Session Description Protocol message for the WebRTC connection.
+          # @param type
+          #   The transport used for the Live session. Always `webrtc`.
           def initialize: (sdp: String, ?type: :webrtc) -> void
           def to_hash: -> { sdp: String, ?type: :webrtc }

data/sig/openai/models/live/session_fork_response.rbs CHANGED Viewed

@@ -8,10 +8,18 @@ module OpenAI
         }
       class SessionForkResponse < OpenAI::Internal::Type::BaseModel
+        # The newly created Live session. Use its ID for session controls and sideband
+        # connections.
         attr_accessor session: OpenAI::Models::Live::SessionForkResponse::Session
+        # WebRTC transport with the SDP answer.
         attr_accessor transport: OpenAI::Models::Live::SessionForkResponse::Transport
+        # @param session
+        #   The newly created Live session. Use its ID for session controls and sideband
+        #   connections.
+        # @param transport
+        #   WebRTC transport with the SDP answer.
         def initialize: (
           session: OpenAI::Models::Live::SessionForkResponse::Session,
           transport: OpenAI::Models::Live::SessionForkResponse::Transport
@@ -25,8 +33,13 @@ module OpenAI
         type session = { id: String }
         class Session < OpenAI::Internal::Type::BaseModel
+          # Opaque session identifier. Preserve the returned value unchanged, including its
+          # prefix.
           attr_accessor id: String
+          # @param id
+          #   Opaque session identifier. Preserve the returned value unchanged, including its
+          #   prefix.
           def initialize: (id: String) -> void
           def to_hash: -> { id: String }
@@ -35,10 +48,16 @@ module OpenAI
         type transport = { sdp: String, ?type: :webrtc }
         class Transport < OpenAI::Internal::Type::BaseModel
+          # Session Description Protocol message for the WebRTC connection.
           attr_accessor sdp: String
+          # The transport used for the Live session. Always `webrtc`.
           attr_accessor type: :webrtc
+          # @param sdp
+          #   Session Description Protocol message for the WebRTC connection.
+          # @param type
+          #   The transport used for the Live session. Always `webrtc`.
           def initialize: (sdp: String, ?type: :webrtc) -> void
           def to_hash: -> { sdp: String, ?type: :webrtc }

data/sig/openai/models/live/session_refer_params.rbs CHANGED Viewed

@@ -14,8 +14,13 @@ module OpenAI
         attr_accessor session_id: String
+        # Nonblank URI for the SIP Refer-To header, such as tel:+14155550123 or
+        # sip:agent@example.com.
         attr_accessor target_uri: String
+        # @param target_uri
+        #   Nonblank URI for the SIP Refer-To header, such as tel:+14155550123 or
+        #   sip:agent@example.com.
         def initialize: (
           session_id: String,
           target_uri: String,

data/sig/openai/models/live/session_reject_params.rbs CHANGED Viewed

@@ -14,8 +14,11 @@ module OpenAI
         attr_accessor session_id: String
+        # SIP rejection status sent to the caller. This field is required.
         attr_accessor status_code: Integer
+        # @param status_code
+        #   SIP rejection status sent to the caller. This field is required.
         def initialize: (
           session_id: String,
           status_code: Integer,

data/sig/openai/models/live/session_resource.rbs CHANGED Viewed

@@ -16,38 +16,112 @@ module OpenAI
         }
       class SessionResource < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the Live session. Use this ID for sideband connections,
+        # forking, and recording download.
         attr_accessor id: String
+        # The Unix timestamp, in seconds, at which the Live session expires.
         attr_accessor expires_at: Integer
+        # The Live model. Required in the session configuration for every transport; do
+        # not pass it as a URL query parameter.
         attr_accessor model: OpenAI::Models::Live::SessionResource::model
+        # The status of the session snapshot. Always `active`, including the final
+        # snapshot in session.closed; use the event type to determine that the session has
+        # closed.
         attr_accessor status: :active
+        # Startup audio configuration. Only primary WebSockets accept audio.format; WebRTC
+        # and SIP negotiate their media format. Voice and format are immutable after
+        # startup.
         attr_reader audio: OpenAI::Live::SessionResource::Audio?
+        # Startup audio configuration. Only primary WebSockets accept audio.format; WebRTC
+        # and SIP negotiate their media format. Voice and format are immutable after
+        # startup.
         def audio=: (
           OpenAI::Live::SessionResource::Audio
         ) -> OpenAI::Live::SessionResource::Audio
+        # Startup-only capabilities for an untrusted frontend attached to a unified WebRTC
+        # session. Trusted sideband connections are unaffected.
         attr_reader client: OpenAI::Live::ClientConfig?
+        # Startup-only capabilities for an untrusted frontend attached to a unified WebRTC
+        # session. Trusted sideband connections are unaffected.
         def client=: (OpenAI::Live::ClientConfig) -> OpenAI::Live::ClientConfig
+        # Who handles tasks delegated by the Live model. Omitted or null selects your
+        # application; use `responses` to let the API manage a Responses backend.
         attr_accessor delegation: OpenAI::Models::Live::SessionResource::delegation?
+        # Ordered text-only history supplied before startup. Supports developer, user, and
+        # assistant messages with one text part each; at most 128 messages and 8,192
+        # rendered tokens in total.
         attr_reader input: ::Array[OpenAI::Models::Live::initial_item]?
+        # Ordered text-only history supplied before startup. Supports developer, user, and
+        # assistant messages with one text part each; at most 128 messages and 8,192
+        # rendered tokens in total.
         def input=: (
           ::Array[OpenAI::Models::Live::initial_item]
         ) -> ::Array[OpenAI::Models::Live::initial_item]
+        # Frontend instructions for voice, conversation, interruptions, and when to
+        # delegate. Start with the
+        # [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting);
+        # put business rules and tool workflows in a separate
+        # [backend prompt](https://developers.openai.com/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).
+        # Limited to 16,384 client-supplied tokens. Omitted or blank instructions use
+        # server defaults. Immutable after startup.
         attr_accessor instructions: String?
+        # Whether to store the session for later forking and recording download. Defaults
+        # to false for new sessions.
         attr_reader store: bool?
+        # Whether to store the session for later forking and recording download. Defaults
+        # to false for new sessions.
         def store=: (bool) -> bool
+        # @param id
+        #   The unique ID of the Live session. Use this ID for sideband connections,
+        #   forking, and recording download.
+        # @param expires_at
+        #   The Unix timestamp, in seconds, at which the Live session expires.
+        # @param model
+        #   The Live model. Required in the session configuration for every transport; do
+        #   not pass it as a URL query parameter.
+        # @param audio
+        #   Startup audio configuration. Only primary WebSockets accept audio.format; WebRTC
+        #   and SIP negotiate their media format. Voice and format are immutable after
+        #   startup.
+        # @param client
+        #   Startup-only capabilities for an untrusted frontend attached to a unified WebRTC
+        #   session. Trusted sideband connections are unaffected.
+        # @param delegation
+        #   Who handles tasks delegated by the Live model. Omitted or null selects your
+        #   application; use `responses` to let the API manage a Responses backend.
+        # @param input
+        #   Ordered text-only history supplied before startup. Supports developer, user, and
+        #   assistant messages with one text part each; at most 128 messages and 8,192
+        #   rendered tokens in total.
+        # @param instructions
+        #   Frontend instructions for voice, conversation, interruptions, and when to
+        #   delegate. Start with the
+        #   [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting);
+        #   put business rules and tool workflows in a separate
+        #   [backend prompt](https://developers.openai.com/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).
+        #   Limited to 16,384 client-supplied tokens. Omitted or blank instructions use
+        #   server defaults. Immutable after startup.
+        # @param store
+        #   Whether to store the session for later forking and recording download. Defaults
+        #   to false for new sessions.
+        # @param status
+        #   The status of the session snapshot. Always `active`, including the final
+        #   snapshot in session.closed; use the event type to determine that the session has
+        #   closed.
         def initialize: (
           id: String,
           expires_at: Integer,
@@ -91,18 +165,29 @@ module OpenAI
           }
         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
+          # The voice used for speech generated by the Live model.
           attr_reader output: OpenAI::Live::SessionResource::Audio::Output?
+          # The voice used for speech generated by the Live model.
           def output=: (
             OpenAI::Live::SessionResource::Audio::Output
           ) -> OpenAI::Live::SessionResource::Audio::Output
+          # @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.
+          # @param output
+          #   The voice used for speech generated by the Live model.
           def initialize: (
             ?format_: OpenAI::Models::Live::audio_format,
             ?output: OpenAI::Live::SessionResource::Audio::Output
@@ -119,12 +204,19 @@ module OpenAI
             }
           class Output < OpenAI::Internal::Type::BaseModel
+            # The voice used for Live speech, as a built-in voice name or a custom voice
+            # object containing its ID. Defaults to `marin` and cannot change after startup.
             attr_reader voice: OpenAI::Models::Live::SessionResource::Audio::Output::voice?
+            # The voice used for Live speech, as a built-in voice name or a custom voice
+            # object containing its ID. Defaults to `marin` and cannot change after startup.
             def voice=: (
               OpenAI::Models::Live::SessionResource::Audio::Output::voice
             ) -> OpenAI::Models::Live::SessionResource::Audio::Output::voice
+            # @param voice
+            #   The voice used for Live speech, as a built-in voice name or a custom voice
+            #   object containing its ID. Defaults to `marin` and cannot change after startup.
             def initialize: (
               ?voice: OpenAI::Models::Live::SessionResource::Audio::Output::voice
             ) -> void
@@ -160,10 +252,18 @@ module OpenAI
             }
           class Responses < OpenAI::Internal::Type::BaseModel
+            # Backend model, prompt, and tools used when the Live session delegates a task to
+            # Responses.
             attr_accessor responses: OpenAI::Live::ResponsesDelegationConfig
+            # The delegation owner. Always `responses` for tasks handled by the Responses API.
             attr_accessor type: :responses
+            # @param responses
+            #   Backend model, prompt, and tools used when the Live session delegates a task to
+            #   Responses.
+            # @param type
+            #   The delegation owner. Always `responses` for tasks handled by the Responses API.
             def initialize: (
               responses: OpenAI::Live::ResponsesDelegationConfig,
               ?type: :responses

data/sig/openai/models/live/session_start_event.rbs CHANGED Viewed

@@ -9,12 +9,27 @@ module OpenAI
         }
       class SessionStartEvent < OpenAI::Internal::Type::BaseModel
+        # Initial configuration for a primary WebSocket. Send session.start first and wait
+        # for session.started before application commands. WebRTC creation already starts
+        # the session; do not send this event again on its data channel.
         attr_accessor session: OpenAI::Live::SessionConfig
+        # 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
+        #   Initial configuration for a primary WebSocket. Send session.start first and wait
+        #   for session.started before application commands. WebRTC creation already starts
+        #   the session; do not send this event again on its data channel.
+        # @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::SessionConfig,
           ?event_id: String?,

data/sig/openai/models/live/session_started_event.rbs CHANGED Viewed

@@ -10,16 +10,32 @@ module OpenAI
         }
       class SessionStartedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
+        # The resolved Live session configuration and server-assigned session metadata.
         attr_accessor session: OpenAI::Live::SessionResource
+        # The event type, always `session.started`.
         attr_accessor type: :"session.started"
+        # 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 session
+        #   The resolved Live session configuration and server-assigned session metadata.
+        # @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.started`.
         def initialize: (
           event_id: String,
           session: OpenAI::Live::SessionResource,

data/sig/openai/models/live/session_update_config.rbs CHANGED Viewed

@@ -5,8 +5,13 @@ module OpenAI
         { ?delegation: OpenAI::Models::Live::SessionUpdateConfig::delegation? }
       class SessionUpdateConfig < OpenAI::Internal::Type::BaseModel
+        # Delegation settings to update. The delegation type must match the current
+        # session; omitted settings retain their values.
         attr_accessor delegation: OpenAI::Models::Live::SessionUpdateConfig::delegation?
+        # @param delegation
+        #   Delegation settings to update. The delegation type must match the current
+        #   session; omitted settings retain their values.
         def initialize: (
           ?delegation: OpenAI::Models::Live::SessionUpdateConfig::delegation?
         ) -> void
@@ -29,14 +34,24 @@ module OpenAI
             }
           class Responses < 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/session_update_event.rbs CHANGED Viewed

@@ -9,12 +9,27 @@ module OpenAI
         }
       class SessionUpdateEvent < OpenAI::Internal::Type::BaseModel
+        # Sparse delegation updates. Omitted settings retain their values. The delegation
+        # type cannot change, including resetting Responses delegation to null or client.
+        # Model, frontend instructions, audio, and startup input are immutable.
         attr_accessor session: OpenAI::Live::SessionUpdateConfig
+        # The Live client event type. Always `session.update`.
         attr_accessor type: :"session.update"
+        # 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
+        #   Sparse delegation updates. Omitted settings retain their values. The delegation
+        #   type cannot change, including resetting Responses delegation to null or client.
+        #   Model, frontend instructions, audio, and startup input are immutable.
+        # @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.update`.
         def initialize: (
           session: OpenAI::Live::SessionUpdateConfig,
           ?event_id: String?,

data/sig/openai/models/live/session_updated_event.rbs CHANGED Viewed

@@ -10,16 +10,32 @@ module OpenAI
         }
       class SessionUpdatedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
+        # The resolved Live session configuration and server-assigned session metadata.
         attr_accessor session: OpenAI::Live::SessionResource
+        # The event type, always `session.updated`.
         attr_accessor type: :"session.updated"
+        # 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 session
+        #   The resolved Live session configuration and server-assigned session metadata.
+        # @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.updated`.
         def initialize: (
           event_id: String,
           session: OpenAI::Live::SessionResource,

data/sig/openai/models/live/session_usage.rbs CHANGED Viewed

@@ -4,8 +4,13 @@ module OpenAI
       type session_usage = { seconds: Float }
       class SessionUsage < OpenAI::Internal::Type::BaseModel
+        # The cumulative Live audio duration in seconds. Do not sum this value across
+        # usage events.
         attr_accessor seconds: Float
+        # @param seconds
+        #   The cumulative Live audio duration in seconds. Do not sum this value across
+        #   usage events.
         def initialize: (seconds: Float) -> void
         def to_hash: -> { seconds: Float }