openai 0.92.0 → 0.94.0

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

@@ -12,20 +12,48 @@ module OpenAI
         }
 
       class InputTranscriptDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The transcript text fragment for the audio in this time range. Append fragments
+        # in delivery order to build the transcript.
         attr_accessor delta: String
 
+        # The end of this event on the Live session timeline, in milliseconds from the
+        # beginning of the session. For appended context, this can equal start_ms.
         attr_accessor end_ms: Integer
 
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
 
+        # The start of this event on the Live session timeline, in milliseconds from the
+        # beginning of the session.
         attr_accessor start_ms: Integer
 
+        # The event type, always `session.input_transcript.delta`.
         attr_accessor type: :"session.input_transcript.delta"
 
+        # 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 delta
+        #   The transcript text fragment for the audio in this time range. Append fragments
+        #   in delivery order to build the transcript.
+        # @param end_ms
+        #   The end of this event on the Live session timeline, in milliseconds from the
+        #   beginning of the session. For appended context, this can equal start_ms.
+        # @param event_id
+        #   The unique ID of the Live server event.
+        # @param start_ms
+        #   The start of this event on the Live session timeline, in milliseconds from the
+        #   beginning of the session.
+        # @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_transcript.delta`.
         def initialize: (
           delta: String,
           end_ms: Integer,

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

@@ -10,14 +10,34 @@ module OpenAI
         }
 
       class InstructionsAppendEvent < OpenAI::Internal::Type::BaseModel
+        # Instruction text to append, limited to 500 tokens. This is a plain string, not
+        # an array of content parts.
         attr_accessor content: String
 
+        # Required, nullable. Set null for general session context, or use the ID from
+        # session.delegation.created for an existing client delegation. Non-null IDs are
+        # not accepted with Responses delegation.
         attr_accessor delegation_id: String?
 
+        # The Live client event type. Always `session.instructions.append`.
         attr_accessor type: :"session.instructions.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 content
+        #   Instruction text to append, limited to 500 tokens. This is a plain string, not
+        #   an array of content parts.
+        # @param delegation_id
+        #   Required, nullable. Set null for general session context, or use the ID from
+        #   session.delegation.created for an existing client delegation. Non-null IDs are
+        #   not accepted with Responses delegation.
+        # @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.instructions.append`.
         def initialize: (
           content: String,
           delegation_id: String?,

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

@@ -11,18 +11,41 @@ module OpenAI
         }
 
       class InstructionsAppendedEvent < OpenAI::Internal::Type::BaseModel
+        # The end of this event on the Live session timeline, in milliseconds from the
+        # beginning of the session. For appended context, this can equal start_ms.
         attr_accessor end_ms: Integer
 
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
 
+        # The start of this event on the Live session timeline, in milliseconds from the
+        # beginning of the session.
         attr_accessor start_ms: Integer
 
+        # The event type, always `session.instructions.appended`.
         attr_accessor type: :"session.instructions.appended"
 
+        # 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 end_ms
+        #   The end of this event on the Live session timeline, in milliseconds from the
+        #   beginning of the session. For appended context, this can equal start_ms.
+        # @param event_id
+        #   The unique ID of the Live server event.
+        # @param start_ms
+        #   The start of this event on the Live session timeline, in milliseconds from the
+        #   beginning of the session.
+        # @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.instructions.appended`.
         def initialize: (
           end_ms: Integer,
           event_id: String,

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

@@ -12,10 +12,16 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
+        # Startup configuration for the Live session.
         attr_accessor session: OpenAI::Live::MediaSessionConfig
 
+        # WebRTC transport with the browser's SDP offer.
         attr_accessor transport: OpenAI::Live::LiveCreateParams::Transport
 
+        # @param session
+        #   Startup configuration for the Live session.
+        # @param transport
+        #   WebRTC transport with the browser's SDP offer.
         def initialize: (
           session: OpenAI::Live::MediaSessionConfig,
           transport: OpenAI::Live::LiveCreateParams::Transport,
@@ -31,10 +37,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/live_create_response.rbs

@@ -8,10 +8,18 @@ module OpenAI
         }
 
       class LiveCreateResponse < OpenAI::Internal::Type::BaseModel
+        # The newly created Live session. Use its ID for session controls and sideband
+        # connections.
         attr_accessor session: OpenAI::Models::Live::LiveCreateResponse::Session
 
+        # WebRTC transport with the SDP answer.
         attr_accessor transport: OpenAI::Models::Live::LiveCreateResponse::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::LiveCreateResponse::Session,
           transport: OpenAI::Models::Live::LiveCreateResponse::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/media_session_config.rbs

@@ -13,32 +13,88 @@ module OpenAI
         }
 
       class MediaSessionConfig < 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::MediaSessionConfig::model
 
+        # Startup audio configuration. WebRTC and SIP negotiate their audio format on the
+        # media transport.
         attr_reader audio: OpenAI::Live::MediaSessionConfig::Audio?
 
+        # Startup audio configuration. WebRTC and SIP negotiate their audio format on the
+        # media transport.
         def audio=: (
           OpenAI::Live::MediaSessionConfig::Audio
         ) -> OpenAI::Live::MediaSessionConfig::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::MediaSessionConfig::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. WebRTC and SIP negotiate their audio format on the
+        #   media transport.
+        # @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::MediaSessionConfig::model,
           ?audio: OpenAI::Live::MediaSessionConfig::Audio,
@@ -73,12 +129,19 @@ module OpenAI
           { ?output: OpenAI::Live::MediaSessionConfig::Audio::Output }
 
         class Audio < OpenAI::Internal::Type::BaseModel
+          # Settings for speech generated by the Live model. Choose the voice before
+          # starting the session.
           attr_reader output: OpenAI::Live::MediaSessionConfig::Audio::Output?
 
+          # Settings for speech generated by the Live model. Choose the voice before
+          # starting the session.
           def output=: (
             OpenAI::Live::MediaSessionConfig::Audio::Output
           ) -> OpenAI::Live::MediaSessionConfig::Audio::Output
 
+          # @param output
+          #   Settings for speech generated by the Live model. Choose the voice before
+          #   starting the session.
           def initialize: (
             ?output: OpenAI::Live::MediaSessionConfig::Audio::Output
           ) -> void
@@ -93,12 +156,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::MediaSessionConfig::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::MediaSessionConfig::Audio::Output::voice
             ) -> OpenAI::Models::Live::MediaSessionConfig::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::MediaSessionConfig::Audio::Output::voice
             ) -> void
@@ -134,10 +204,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/media_session_fork_config.rbs

@@ -9,20 +9,41 @@ module OpenAI
         }
 
       class MediaSessionForkConfig < OpenAI::Internal::Type::BaseModel
+        # 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
 
+        # Update the Responses backend for an existing Live session without changing
+        # delegation ownership.
         attr_reader delegation: OpenAI::Live::MediaSessionForkConfig::Delegation?
 
+        # Update the Responses backend for an existing Live session without changing
+        # delegation ownership.
         def delegation=: (
           OpenAI::Live::MediaSessionForkConfig::Delegation
         ) -> OpenAI::Live::MediaSessionForkConfig::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 client
+        #   Startup-only capabilities for an untrusted frontend attached to a unified WebRTC
+        #   session. Trusted sideband connections are unaffected.
+        # @param delegation
+        #   Update the Responses backend for an existing Live session without changing
+        #   delegation ownership.
+        # @param store
+        #   Whether to store the forked session. Omission inherits the stored session's
+        #   setting.
         def initialize: (
           ?client: OpenAI::Live::ClientConfig,
           ?delegation: OpenAI::Live::MediaSessionForkConfig::Delegation,
@@ -42,14 +63,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/output_audio_delta_event.rbs

@@ -10,18 +10,43 @@ module OpenAI
         }
 
       class OutputAudioDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # Base64-encoded raw audio. Primary WebSocket events use the session's configured
+        # format; reflected sideband events use mono PCM16LE at 24 kHz.
         attr_accessor delta: String
 
+        # The event type, always `session.output_audio.delta`.
         attr_accessor type: :"session.output_audio.delta"
 
+        # Exclusive session-relative end in milliseconds. Required on reflected sideband
+        # events; omitted on the primary WebSocket. Dropped output frames leave gaps
+        # between reflected ranges.
         attr_reader end_ms: Integer?
 
+        # Exclusive session-relative end in milliseconds. Required on reflected sideband
+        # events; omitted on the primary WebSocket. Dropped output frames leave gaps
+        # between reflected ranges.
         def end_ms=: (Integer) -> Integer
 
+        # Inclusive session-relative start in milliseconds. Required on reflected sideband
+        # events; omitted on the primary WebSocket.
         attr_reader start_ms: Integer?
 
+        # Inclusive session-relative start in milliseconds. Required on reflected sideband
+        # events; omitted on the primary WebSocket.
         def start_ms=: (Integer) -> Integer
 
+        # @param delta
+        #   Base64-encoded raw audio. Primary WebSocket events use the session's configured
+        #   format; reflected sideband events use mono PCM16LE at 24 kHz.
+        # @param end_ms
+        #   Exclusive session-relative end in milliseconds. Required on reflected sideband
+        #   events; omitted on the primary WebSocket. Dropped output frames leave gaps
+        #   between reflected ranges.
+        # @param start_ms
+        #   Inclusive session-relative start in milliseconds. Required on reflected sideband
+        #   events; omitted on the primary WebSocket.
+        # @param type
+        #   The event type, always `session.output_audio.delta`.
         def initialize: (
           delta: String,
           ?end_ms: Integer,

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

@@ -12,20 +12,48 @@ module OpenAI
         }
 
       class OutputTranscriptDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The transcript text fragment for the audio in this time range. Append fragments
+        # in delivery order to build the transcript.
         attr_accessor delta: String
 
+        # The end of this event on the Live session timeline, in milliseconds from the
+        # beginning of the session. For appended context, this can equal start_ms.
         attr_accessor end_ms: Integer
 
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
 
+        # The start of this event on the Live session timeline, in milliseconds from the
+        # beginning of the session.
         attr_accessor start_ms: Integer
 
+        # The event type, always `session.output_transcript.delta`.
         attr_accessor type: :"session.output_transcript.delta"
 
+        # 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 delta
+        #   The transcript text fragment for the audio in this time range. Append fragments
+        #   in delivery order to build the transcript.
+        # @param end_ms
+        #   The end of this event on the Live session timeline, in milliseconds from the
+        #   beginning of the session. For appended context, this can equal start_ms.
+        # @param event_id
+        #   The unique ID of the Live server event.
+        # @param start_ms
+        #   The start of this event on the Live session timeline, in milliseconds from the
+        #   beginning of the session.
+        # @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.output_transcript.delta`.
         def initialize: (
           delta: String,
           end_ms: Integer,

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

@@ -5,10 +5,18 @@ module OpenAI
         { ?type: :"response.create", ?event_id: String? }
 
       class ResponseCreateEvent < OpenAI::Internal::Type::BaseModel
+        # The Live client event type. Always `response.create`.
         attr_accessor type: :"response.create"
 
+        # 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 `response.create`.
         def initialize: (?event_id: String?, ?type: :"response.create") -> void
 
         def to_hash: -> { ?type: :"response.create", ?event_id: String? }

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

@@ -11,18 +11,43 @@ module OpenAI
         }
 
       class ResponseEvent < OpenAI::Internal::Type::BaseModel
+        # The nested Responses streaming event. Dispatch on its type field. Response
+        # lifecycle snapshots omit input and clear instructions, tools, and output to keep
+        # messages small; consume granular output events for the generated content.
         attr_accessor event: ::Hash[Symbol, top]
 
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
 
+        # The event type, always `response.event`.
         attr_accessor type: :"response.event"
 
+        # 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
 
+        # The Live delegation associated with the nested Responses event. May be null or
+        # omitted when the event cannot be correlated with a delegation.
         attr_accessor delegation_id: String?
 
+        # @param event
+        #   The nested Responses streaming event. Dispatch on its type field. Response
+        #   lifecycle snapshots omit input and clear instructions, tools, and output to keep
+        #   messages small; consume granular output events for the generated content.
+        # @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 delegation_id
+        #   The Live delegation associated with the nested Responses event. May be null or
+        #   omitted when the event cannot be correlated with a delegation.
+        # @param type
+        #   The event type, always `response.event`.
         def initialize: (
           event: ::Hash[Symbol, top],
           event_id: String,

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

@@ -9,12 +9,25 @@ module OpenAI
         }
 
       class ResponseItemCreateEvent < OpenAI::Internal::Type::BaseModel
+        # An input item to append to the Responses backend conversation, such as a user
+        # message or a function tool result.
         attr_accessor item: OpenAI::Models::Responses::response_input_item
 
+        # The Live client event type. Always `response.item.create`.
         attr_accessor type: :"response.item.create"
 
+        # 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 item
+        #   An input item to append to the Responses backend conversation, such as a user
+        #   message or a function tool result.
+        # @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 `response.item.create`.
         def initialize: (
           item: OpenAI::Models::Responses::response_input_item,
           ?event_id: String?,