openai 0.92.0 → 0.93.0

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

@@ -15,32 +15,73 @@ module OpenAI
         }
 
       class ResponsesDelegationConfig < OpenAI::Internal::Type::BaseModel
+        # The model used for server-owned Responses delegations.
         attr_accessor model: String
 
+        # Instructions for the delegated Responses model, separate from Live instructions.
+        # See
+        # [backend prompting](https://developers.openai.com/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).
         attr_accessor instructions: String?
 
+        # Maximum number of output tokens for each delegated response.
         attr_accessor max_output_tokens: Integer?
 
+        # Whether the delegated Responses model may request multiple tool calls in a
+        # single response.
         attr_accessor parallel_tool_calls: bool?
 
+        # Reasoning settings passed to each delegated Responses request.
         attr_accessor reasoning: OpenAI::Live::ResponsesDelegationConfig::Reasoning?
 
+        # Service tier for delegated Responses requests.
         attr_accessor service_tier: OpenAI::Models::Live::ResponsesDelegationConfig::service_tier?
 
+        # Text generation settings passed to each delegated Responses request.
         attr_accessor text: OpenAI::Live::ResponsesDelegationConfig::Text?
 
+        # Controls which tool the Responses backend uses when handling a task delegated by
+        # the Live model.
         attr_reader tool_choice: OpenAI::Models::Live::ResponsesDelegationConfig::tool_choice?
 
+        # Controls which tool the Responses backend uses when handling a task delegated by
+        # the Live model.
         def tool_choice=: (
           OpenAI::Models::Live::ResponsesDelegationConfig::tool_choice
         ) -> OpenAI::Models::Live::ResponsesDelegationConfig::tool_choice
 
+        # Tools available to the Responses backend while it handles tasks delegated by the
+        # Live model.
         attr_reader tools: ::Array[OpenAI::Models::Live::ResponsesDelegationConfig::tool]?
 
+        # Tools available to the Responses backend while it handles tasks delegated by the
+        # Live model.
         def tools=: (
           ::Array[OpenAI::Models::Live::ResponsesDelegationConfig::tool]
         ) -> ::Array[OpenAI::Models::Live::ResponsesDelegationConfig::tool]
 
+        # @param model
+        #   The model used for server-owned Responses delegations.
+        # @param instructions
+        #   Instructions for the delegated Responses model, separate from Live instructions.
+        #   See
+        #   [backend prompting](https://developers.openai.com/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).
+        # @param max_output_tokens
+        #   Maximum number of output tokens for each delegated response.
+        # @param parallel_tool_calls
+        #   Whether the delegated Responses model may request multiple tool calls in a
+        #   single response.
+        # @param reasoning
+        #   Reasoning settings passed to each delegated Responses request.
+        # @param service_tier
+        #   Service tier for delegated Responses requests.
+        # @param text
+        #   Text generation settings passed to each delegated Responses request.
+        # @param tool_choice
+        #   Controls which tool the Responses backend uses when handling a task delegated by
+        #   the Live model.
+        # @param tools
+        #   Tools available to the Responses backend while it handles tasks delegated by the
+        #   Live model.
         def initialize: (
           model: String,
           ?instructions: String?,
@@ -72,10 +113,20 @@ module OpenAI
           }
 
         class Reasoning < OpenAI::Internal::Type::BaseModel
+          # How much reasoning effort the delegated Responses model should use. Supported
+          # values depend on the backend model.
           attr_accessor effort: OpenAI::Models::Live::ResponsesDelegationConfig::Reasoning::effort?
 
+          # The reasoning summary to request from the delegated Responses model, when
+          # supported.
           attr_accessor summary: OpenAI::Models::Live::ResponsesDelegationConfig::Reasoning::summary?
 
+          # @param effort
+          #   How much reasoning effort the delegated Responses model should use. Supported
+          #   values depend on the backend model.
+          # @param summary
+          #   The reasoning summary to request from the delegated Responses model, when
+          #   supported.
           def initialize: (
             ?effort: OpenAI::Models::Live::ResponsesDelegationConfig::Reasoning::effort?,
             ?summary: OpenAI::Models::Live::ResponsesDelegationConfig::Reasoning::summary?
@@ -141,8 +192,13 @@ module OpenAI
           }
 
         class Text < OpenAI::Internal::Type::BaseModel
+          # The amount of detail in text generated by the Responses backend. This does not
+          # configure the Live model’s spoken delivery.
           attr_accessor verbosity: OpenAI::Models::Live::ResponsesDelegationConfig::Text::verbosity?
 
+          # @param verbosity
+          #   The amount of detail in text generated by the Responses backend. This does not
+          #   configure the Live model’s spoken delivery.
           def initialize: (
             ?verbosity: OpenAI::Models::Live::ResponsesDelegationConfig::Text::verbosity?
           ) -> void
@@ -229,8 +285,11 @@ module OpenAI
           type web_search = { ?type: :web_search }
 
           class WebSearch < OpenAI::Internal::Type::BaseModel
+            # The tool type. Always `web_search`.
             attr_accessor type: :web_search
 
+            # @param type
+            #   The tool type. Always `web_search`.
             def initialize: (?type: :web_search) -> void
 
             def to_hash: -> { ?type: :web_search }

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

@@ -15,34 +15,79 @@ module OpenAI
         }
 
       class ResponsesDelegationUpdateConfig < OpenAI::Internal::Type::BaseModel
+        # Instructions for the delegated Responses model, separate from Live instructions.
+        # See
+        # [backend prompting](https://developers.openai.com/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).
         attr_accessor instructions: String?
 
+        # Maximum number of output tokens for each delegated response.
         attr_accessor max_output_tokens: Integer?
 
+        # The Responses backend model to use for subsequent delegated requests. Omit to
+        # keep the current backend model.
         attr_reader model: String?
 
+        # The Responses backend model to use for subsequent delegated requests. Omit to
+        # keep the current backend model.
         def model=: (String) -> String
 
+        # Whether the delegated Responses model may request multiple tool calls in a
+        # single response.
         attr_accessor parallel_tool_calls: bool?
 
+        # Reasoning settings passed to each delegated Responses request.
         attr_accessor reasoning: OpenAI::Live::ResponsesDelegationUpdateConfig::Reasoning?
 
+        # Service tier for delegated Responses requests.
         attr_accessor service_tier: OpenAI::Models::Live::ResponsesDelegationUpdateConfig::service_tier?
 
+        # Text generation settings passed to each delegated Responses request.
         attr_accessor text: OpenAI::Live::ResponsesDelegationUpdateConfig::Text?
 
+        # Controls which tool the Responses backend uses when handling a task delegated by
+        # the Live model.
         attr_reader tool_choice: OpenAI::Models::Live::ResponsesDelegationUpdateConfig::tool_choice?
 
+        # Controls which tool the Responses backend uses when handling a task delegated by
+        # the Live model.
         def tool_choice=: (
           OpenAI::Models::Live::ResponsesDelegationUpdateConfig::tool_choice
         ) -> OpenAI::Models::Live::ResponsesDelegationUpdateConfig::tool_choice
 
+        # Tools available to the Responses backend while it handles tasks delegated by the
+        # Live model.
         attr_reader tools: ::Array[OpenAI::Models::Live::ResponsesDelegationUpdateConfig::tool]?
 
+        # Tools available to the Responses backend while it handles tasks delegated by the
+        # Live model.
         def tools=: (
           ::Array[OpenAI::Models::Live::ResponsesDelegationUpdateConfig::tool]
         ) -> ::Array[OpenAI::Models::Live::ResponsesDelegationUpdateConfig::tool]
 
+        # @param instructions
+        #   Instructions for the delegated Responses model, separate from Live instructions.
+        #   See
+        #   [backend prompting](https://developers.openai.com/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).
+        # @param max_output_tokens
+        #   Maximum number of output tokens for each delegated response.
+        # @param model
+        #   The Responses backend model to use for subsequent delegated requests. Omit to
+        #   keep the current backend model.
+        # @param parallel_tool_calls
+        #   Whether the delegated Responses model may request multiple tool calls in a
+        #   single response.
+        # @param reasoning
+        #   Reasoning settings passed to each delegated Responses request.
+        # @param service_tier
+        #   Service tier for delegated Responses requests.
+        # @param text
+        #   Text generation settings passed to each delegated Responses request.
+        # @param tool_choice
+        #   Controls which tool the Responses backend uses when handling a task delegated by
+        #   the Live model.
+        # @param tools
+        #   Tools available to the Responses backend while it handles tasks delegated by the
+        #   Live model.
         def initialize: (
           ?instructions: String?,
           ?max_output_tokens: Integer?,
@@ -74,10 +119,20 @@ module OpenAI
           }
 
         class Reasoning < OpenAI::Internal::Type::BaseModel
+          # How much reasoning effort the delegated Responses model should use. Supported
+          # values depend on the backend model.
           attr_accessor effort: OpenAI::Models::Live::ResponsesDelegationUpdateConfig::Reasoning::effort?
 
+          # The reasoning summary to request from the delegated Responses model, when
+          # supported.
           attr_accessor summary: OpenAI::Models::Live::ResponsesDelegationUpdateConfig::Reasoning::summary?
 
+          # @param effort
+          #   How much reasoning effort the delegated Responses model should use. Supported
+          #   values depend on the backend model.
+          # @param summary
+          #   The reasoning summary to request from the delegated Responses model, when
+          #   supported.
           def initialize: (
             ?effort: OpenAI::Models::Live::ResponsesDelegationUpdateConfig::Reasoning::effort?,
             ?summary: OpenAI::Models::Live::ResponsesDelegationUpdateConfig::Reasoning::summary?
@@ -143,8 +198,13 @@ module OpenAI
           }
 
         class Text < OpenAI::Internal::Type::BaseModel
+          # The amount of detail in text generated by the Responses backend. This does not
+          # configure the Live model’s spoken delivery.
           attr_accessor verbosity: OpenAI::Models::Live::ResponsesDelegationUpdateConfig::Text::verbosity?
 
+          # @param verbosity
+          #   The amount of detail in text generated by the Responses backend. This does not
+          #   configure the Live model’s spoken delivery.
           def initialize: (
             ?verbosity: OpenAI::Models::Live::ResponsesDelegationUpdateConfig::Text::verbosity?
           ) -> void
@@ -231,8 +291,11 @@ module OpenAI
           type web_search = { ?type: :web_search }
 
           class WebSearch < OpenAI::Internal::Type::BaseModel
+            # The tool type. Always `web_search`.
             attr_accessor type: :web_search
 
+            # @param type
+            #   The tool type. Always `web_search`.
             def initialize: (?type: :web_search) -> void
 
             def to_hash: -> { ?type: :web_search }

data/sig/openai/models/live/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::ServerEvent::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/server_event_selector.rbs

@@ -4,12 +4,22 @@ module OpenAI
       type server_event_selector = { type: String, ?response_event: String }
 
       class ServerEventSelector < OpenAI::Internal::Type::BaseModel
+        # The outer Live server event type. Use 'response.event' for Responses events.
         attr_accessor type: String
 
+        # The nested Responses event type. Required when type is 'response.event';
+        # forbidden for other event types.
         attr_reader response_event: String?
 
+        # The nested Responses event type. Required when type is 'response.event';
+        # forbidden for other event types.
         def response_event=: (String) -> String
 
+        # @param type
+        #   The outer Live server event type. Use 'response.event' for Responses events.
+        # @param response_event
+        #   The nested Responses event type. Required when type is 'response.event';
+        #   forbidden for other event types.
         def initialize: (type: String, ?response_event: String) -> void
 
         def to_hash: -> { type: String, ?response_event: String }

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

@@ -14,8 +14,13 @@ module OpenAI
 
         attr_accessor session_id: String
 
+        # Model and startup configuration for the Live session that answers the incoming
+        # SIP call.
         attr_accessor session: OpenAI::Live::SessionAcceptParams::Session
 
+        # @param session
+        #   Model and startup configuration for the Live session that answers the incoming
+        #   SIP call.
         def initialize: (
           session_id: String,
           session: OpenAI::Live::SessionAcceptParams::Session,
@@ -40,30 +45,83 @@ module OpenAI
           }
 
         class Session < OpenAI::Internal::Type::BaseModel
+          # The Live model to use for the accepted call.
           attr_accessor model: OpenAI::Models::Live::SessionAcceptParams::Session::model
 
+          # The session type. Always `live`.
           attr_accessor type: :live
 
+          # Startup audio output configuration. SIP negotiates the media format;
+          # audio.format is only accepted for primary WebSockets. Voice cannot change after
+          # startup.
           attr_reader audio: OpenAI::Live::SessionAcceptParams::Session::Audio?
 
+          # Startup audio output configuration. SIP negotiates the media format;
+          # audio.format is only accepted for primary WebSockets. Voice cannot change after
+          # startup.
           def audio=: (
             OpenAI::Live::SessionAcceptParams::Session::Audio
           ) -> OpenAI::Live::SessionAcceptParams::Session::Audio
 
+          # 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::SessionAcceptParams::Session::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 to use for the accepted call.
+          # @param audio
+          #   Startup audio output configuration. SIP negotiates the media format;
+          #   audio.format is only accepted for primary WebSockets. Voice cannot change after
+          #   startup.
+          # @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 type
+          #   The session type. Always `live`.
           def initialize: (
             model: OpenAI::Models::Live::SessionAcceptParams::Session::model,
             ?audio: OpenAI::Live::SessionAcceptParams::Session::Audio,
@@ -100,12 +158,19 @@ module OpenAI
             }
 
           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::SessionAcceptParams::Session::Audio::Output?
 
+            # Settings for speech generated by the Live model. Choose the voice before
+            # starting the session.
             def output=: (
               OpenAI::Live::SessionAcceptParams::Session::Audio::Output
             ) -> OpenAI::Live::SessionAcceptParams::Session::Audio::Output
 
+            # @param output
+            #   Settings for speech generated by the Live model. Choose the voice before
+            #   starting the session.
             def initialize: (
               ?output: OpenAI::Live::SessionAcceptParams::Session::Audio::Output
             ) -> void
@@ -120,12 +185,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::SessionAcceptParams::Session::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::SessionAcceptParams::Session::Audio::Output::voice
               ) -> OpenAI::Models::Live::SessionAcceptParams::Session::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::SessionAcceptParams::Session::Audio::Output::voice
               ) -> void
@@ -161,10 +233,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_close_event.rbs

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

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

@@ -12,20 +12,48 @@ module OpenAI
         }
 
       class SessionClosedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the Live server event.
         attr_accessor event_id: String
 
+        # Why the Live session ended: `close_requested` for an application close or hangup
+        # request, `expired` for the session duration limit, `content` for a safety
+        # filter, `remote_hangup` for a graceful remote disconnect, or `connection_lost`
+        # for an unexpected primary or upstream disconnection.
         attr_accessor reason: OpenAI::Models::Live::SessionClosedEvent::reason
 
+        # The resolved Live session configuration and server-assigned session metadata.
         attr_accessor session: OpenAI::Live::SessionResource
 
+        # The event type, always `session.closed`.
         attr_accessor type: :"session.closed"
 
+        # The final cumulative Live audio usage after session finalization.
         attr_accessor usage: OpenAI::Live::SessionUsage
 
+        # 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 reason
+        #   Why the Live session ended: `close_requested` for an application close or hangup
+        #   request, `expired` for the session duration limit, `content` for a safety
+        #   filter, `remote_hangup` for a graceful remote disconnect, or `connection_lost`
+        #   for an unexpected primary or upstream disconnection.
+        # @param session
+        #   The resolved Live session configuration and server-assigned session metadata.
+        # @param usage
+        #   The final cumulative Live audio usage after session finalization.
+        # @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.closed`.
         def initialize: (
           event_id: String,
           reason: OpenAI::Models::Live::SessionClosedEvent::reason,