openai 0.87.0 → 0.89.0

data/lib/openai/models/realtime/input_audio_buffer_speech_stopped_event.rb

@@ -31,20 +31,23 @@ module OpenAI
         required :type, const: :"input_audio_buffer.speech_stopped"
 
         # @!method initialize(audio_end_ms:, event_id:, item_id:, type: :"input_audio_buffer.speech_stopped")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferSpeechStoppedEvent} for more details.
-        #
         #   Returned in `server_vad` mode when the server detects the end of speech in the
         #   audio buffer. The server will also send an `conversation.item.created` event
         #   with the user message item that is created from the audio buffer.
         #
-        #   @param audio_end_ms [Integer] Milliseconds since the session started when speech stopped. This will
+        #   @param audio_end_ms [Integer]
+        #     Milliseconds since the session started when speech stopped. This will correspond
+        #     to the end of audio sent to the model, and thus includes the
+        #     `min_silence_duration_ms` configured in the Session.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the user message item that will be created.
+        #   @param item_id [String]
+        #     The ID of the user message item that will be created.
         #
-        #   @param type [Symbol, :"input_audio_buffer.speech_stopped"] The event type, must be `input_audio_buffer.speech_stopped`.
+        #   @param type [Symbol, :"input_audio_buffer.speech_stopped"]
+        #     The event type, must be `input_audio_buffer.speech_stopped`.
       end
     end
   end

data/lib/openai/models/realtime/input_audio_buffer_timeout_triggered.rb

@@ -37,9 +37,6 @@ module OpenAI
         required :type, const: :"input_audio_buffer.timeout_triggered"
 
         # @!method initialize(audio_end_ms:, audio_start_ms:, event_id:, item_id:, type: :"input_audio_buffer.timeout_triggered")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferTimeoutTriggered} for more details.
-        #
         #   Returned when the Server VAD timeout is triggered for the input audio buffer.
         #   This is configured with `idle_timeout_ms` in the `turn_detection` settings of
         #   the session, and it indicates that there hasn't been any speech detected for the
@@ -57,15 +54,22 @@ module OpenAI
         #   by the model, so the model may respond with something relevant to the
         #   conversation or a prompt to continue speaking.
         #
-        #   @param audio_end_ms [Integer] Millisecond offset of audio written to the input audio buffer at the time the ti
+        #   @param audio_end_ms [Integer]
+        #     Millisecond offset of audio written to the input audio buffer at the time the
+        #     timeout was triggered.
         #
-        #   @param audio_start_ms [Integer] Millisecond offset of audio written to the input audio buffer that was after the
+        #   @param audio_start_ms [Integer]
+        #     Millisecond offset of audio written to the input audio buffer that was after the
+        #     playback time of the last model response.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the item associated with this segment.
+        #   @param item_id [String]
+        #     The ID of the item associated with this segment.
         #
-        #   @param type [Symbol, :"input_audio_buffer.timeout_triggered"] The event type, must be `input_audio_buffer.timeout_triggered`.
+        #   @param type [Symbol, :"input_audio_buffer.timeout_triggered"]
+        #     The event type, must be `input_audio_buffer.timeout_triggered`.
       end
     end
   end

data/lib/openai/models/realtime/log_prob_properties.rb

@@ -23,16 +23,16 @@ module OpenAI
         required :logprob, Float
 
         # @!method initialize(token:, bytes:, logprob:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::LogProbProperties} for more details.
-        #
         #   A log probability object.
         #
-        #   @param token [String] The token that was used to generate the log probability.
+        #   @param token [String]
+        #     The token that was used to generate the log probability.
         #
-        #   @param bytes [Array<Integer>] The bytes that were used to generate the log probability.
+        #   @param bytes [Array<Integer>]
+        #     The bytes that were used to generate the log probability.
         #
-        #   @param logprob [Float] The log probability of the token.
+        #   @param logprob [Float]
+        #     The log probability of the token.
       end
     end
   end

data/lib/openai/models/realtime/mcp_list_tools_completed.rb

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(event_id:, item_id:, type: :"mcp_list_tools.completed")
         #   Returned when listing MCP tools has completed for an item.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the MCP list tools item.
+        #   @param item_id [String]
+        #     The ID of the MCP list tools item.
         #
-        #   @param type [Symbol, :"mcp_list_tools.completed"] The event type, must be `mcp_list_tools.completed`.
+        #   @param type [Symbol, :"mcp_list_tools.completed"]
+        #     The event type, must be `mcp_list_tools.completed`.
       end
     end
   end

data/lib/openai/models/realtime/mcp_list_tools_failed.rb

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(event_id:, item_id:, type: :"mcp_list_tools.failed")
         #   Returned when listing MCP tools has failed for an item.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the MCP list tools item.
+        #   @param item_id [String]
+        #     The ID of the MCP list tools item.
         #
-        #   @param type [Symbol, :"mcp_list_tools.failed"] The event type, must be `mcp_list_tools.failed`.
+        #   @param type [Symbol, :"mcp_list_tools.failed"]
+        #     The event type, must be `mcp_list_tools.failed`.
       end
     end
   end

data/lib/openai/models/realtime/mcp_list_tools_in_progress.rb

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(event_id:, item_id:, type: :"mcp_list_tools.in_progress")
         #   Returned when listing MCP tools is in progress for an item.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the MCP list tools item.
+        #   @param item_id [String]
+        #     The ID of the MCP list tools item.
         #
-        #   @param type [Symbol, :"mcp_list_tools.in_progress"] The event type, must be `mcp_list_tools.in_progress`.
+        #   @param type [Symbol, :"mcp_list_tools.in_progress"]
+        #     The event type, must be `mcp_list_tools.in_progress`.
       end
     end
   end

data/lib/openai/models/realtime/output_audio_buffer_clear_event.rb

@@ -21,11 +21,13 @@ module OpenAI
         #   trigger the server to stop generating audio and emit a
         #   `output_audio_buffer.cleared` event. This event should be preceded by a
         #   `response.cancel` client event to stop the generation of the current response.
-        #   [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+        #   [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
         #
-        #   @param event_id [String] The unique ID of the client event used for error handling.
+        #   @param event_id [String]
+        #     The unique ID of the client event used for error handling.
         #
-        #   @param type [Symbol, :"output_audio_buffer.clear"] The event type, must be `output_audio_buffer.clear`.
+        #   @param type [Symbol, :"output_audio_buffer.clear"]
+        #     The event type, must be `output_audio_buffer.clear`.
       end
     end
   end

data/lib/openai/models/realtime/rate_limits_updated_event.rb

@@ -31,12 +31,14 @@ module OpenAI
         #   rate limits shown here reflect that reservation, which is then adjusted
         #   accordingly once the Response is completed.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param rate_limits [Array<OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit>] List of rate limit information.
+        #   @param rate_limits [Array<OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit>]
+        #     List of rate limit information.
         #
-        #   @param type [Symbol, :"rate_limits.updated"] The event type, must be `rate_limits.updated`.
-
+        #   @param type [Symbol, :"rate_limits.updated"]
+        #     The event type, must be `rate_limits.updated`.
         class RateLimit < OpenAI::Internal::Type::BaseModel
           # @!attribute limit
           #   The maximum allowed value for the rate limit.
@@ -63,16 +65,17 @@ module OpenAI
           optional :reset_seconds, Float
 
           # @!method initialize(limit: nil, name: nil, remaining: nil, reset_seconds: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit} for more details.
-          #
-          #   @param limit [Integer] The maximum allowed value for the rate limit.
+          #   @param limit [Integer]
+          #     The maximum allowed value for the rate limit.
           #
-          #   @param name [Symbol, OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit::Name] The name of the rate limit (`requests`, `tokens`).
+          #   @param name [Symbol, OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit::Name]
+          #     The name of the rate limit (`requests`, `tokens`).
           #
-          #   @param remaining [Integer] The remaining value before the limit is reached.
+          #   @param remaining [Integer]
+          #     The remaining value before the limit is reached.
           #
-          #   @param reset_seconds [Float] Seconds until the rate limit resets.
+          #   @param reset_seconds [Float]
+          #     Seconds until the rate limit resets.
 
           # The name of the rate limit (`requests`, `tokens`).
           #

data/lib/openai/models/realtime/realtime_audio_config_input.rb

@@ -25,7 +25,7 @@ module OpenAI
         #   `null` to turn off once on. Input audio transcription is not native to the
         #   model, since the model consumes audio directly. Transcription runs
         #   asynchronously through
-        #   [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription)
+        #   [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         #   and should be treated as guidance of input audio content rather than precisely
         #   what the model heard. The client can optionally set the language and prompt for
         #   transcription, these offer additional guidance to the transcription service.
@@ -55,16 +55,43 @@ module OpenAI
         optional :turn_detection, union: -> { OpenAI::Realtime::RealtimeAudioInputTurnDetection }, nil?: true
 
         # @!method initialize(format_: nil, noise_reduction: nil, transcription: nil, turn_detection: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeAudioConfigInput} for more details.
+        #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA]
+        #     The format of the input audio.
         #
-        #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA] The format of the input audio.
+        #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeAudioConfigInput::NoiseReduction]
+        #     Configuration for input audio noise reduction. This can be set to `null` to turn
+        #     off. Noise reduction filters audio added to the input audio buffer before it is
+        #     sent to VAD and the model. Filtering the audio can improve VAD and turn
+        #     detection accuracy (reducing false positives) and model performance by improving
+        #     perception of the input audio.
         #
-        #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeAudioConfigInput::NoiseReduction] Configuration for input audio noise reduction. This can be set to `null` to turn
+        #   @param transcription [OpenAI::Models::Realtime::AudioTranscription]
+        #     Configuration for input audio transcription, defaults to off and can be set to
+        #     `null` to turn off once on. Input audio transcription is not native to the
+        #     model, since the model consumes audio directly. Transcription runs
+        #     asynchronously through
+        #     [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
+        #     and should be treated as guidance of input audio content rather than precisely
+        #     what the model heard. The client can optionally set the language and prompt for
+        #     transcription, these offer additional guidance to the transcription service.
         #
-        #   @param transcription [OpenAI::Models::Realtime::AudioTranscription] Configuration for input audio transcription, defaults to off and can be set to `
+        #   @param turn_detection [OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::ServerVad, OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::SemanticVad, nil]
+        #     Configuration for turn detection, ether Server VAD or Semantic VAD. This can be
+        #     set to `null` to turn off, in which case the client must manually trigger model
+        #     response.
         #
-        #   @param turn_detection [OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::ServerVad, OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::SemanticVad, nil] Configuration for turn detection, ether Server VAD or Semantic VAD. This can be
+        #     Server VAD means that the model will detect the start and end of speech based on
+        #     audio volume and respond at the end of user speech.
+        #
+        #     Semantic VAD is more advanced and uses a turn detection model (in conjunction
+        #     with VAD) to semantically estimate whether the user has finished speaking, then
+        #     dynamically sets a timeout based on this probability. For example, if user audio
+        #     trails off with "uhhm", the model will score a low probability of turn end and
+        #     wait longer for the user to continue speaking. This can be useful for more
+        #     natural conversations, but may have a higher latency.
+        #
+        #     For `gpt-realtime-whisper` transcription sessions, turn detection must be set to
+        #     `null`; VAD is not supported.
 
         # @see OpenAI::Models::Realtime::RealtimeAudioConfigInput#noise_reduction
         class NoiseReduction < OpenAI::Internal::Type::BaseModel
@@ -77,17 +104,16 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Realtime::NoiseReductionType }
 
           # @!method initialize(type: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeAudioConfigInput::NoiseReduction} for more
-          #   details.
-          #
           #   Configuration for input audio noise reduction. This can be set to `null` to turn
           #   off. Noise reduction filters audio added to the input audio buffer before it is
           #   sent to VAD and the model. Filtering the audio can improve VAD and turn
           #   detection accuracy (reducing false positives) and model performance by improving
           #   perception of the input audio.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::NoiseReductionType] Type of noise reduction. `near_field` is for close-talking microphones such as h
+          #   @param type [Symbol, OpenAI::Models::Realtime::NoiseReductionType]
+          #     Type of noise reduction. `near_field` is for close-talking microphones such as
+          #     headphones, `far_field` is for far-field microphones such as laptop or
+          #     conference room microphones.
         end
       end
     end

data/lib/openai/models/realtime/realtime_audio_config_output.rb

@@ -34,14 +34,25 @@ module OpenAI
         optional :voice, union: -> { OpenAI::Realtime::RealtimeAudioConfigOutput::Voice }
 
         # @!method initialize(format_: nil, speed: nil, voice: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeAudioConfigOutput} for more details.
+        #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA]
+        #     The format of the output audio.
         #
-        #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA] The format of the output audio.
+        #   @param speed [Float]
+        #     The speed of the model's spoken response as a multiple of the original speed.
+        #     1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed.
+        #     This value can only be changed in between model turns, not while a response is
+        #     in progress.
         #
-        #   @param speed [Float] The speed of the model's spoken response as a multiple of the original speed.
+        #     This parameter is a post-processing adjustment to the audio after it is
+        #     generated, it's also possible to prompt the model to speak faster or slower.
         #
-        #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice::ID, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice] The voice the model uses to respond. Supported built-in voices are
+        #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice::ID, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice]
+        #     The voice the model uses to respond. Supported built-in voices are `alloy`,
+        #     `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
+        #     `cedar`. You may also provide a custom voice object with an `id`, for example
+        #     `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+        #     model has responded with audio at least once. We recommend `marin` and `cedar`
+        #     for best quality.
 
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
@@ -89,7 +100,8 @@ module OpenAI
             # @!method initialize(id:)
             #   Custom voice reference.
             #
-            #   @param id [String] The custom voice ID, e.g. `voice_1234`.
+            #   @param id [String]
+            #     The custom voice ID, e.g. `voice_1234`.
           end
 
           # @!method self.variants

data/lib/openai/models/realtime/realtime_audio_formats.rb

@@ -34,9 +34,11 @@ module OpenAI
           # @!method initialize(rate: nil, type: nil)
           #   The PCM audio format. Only a 24kHz sample rate is supported.
           #
-          #   @param rate [Integer, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM::Rate] The sample rate of the audio. Always `24000`.
+          #   @param rate [Integer, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM::Rate]
+          #     The sample rate of the audio. Always `24000`.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM::Type] The audio format. Always `audio/pcm`.
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM::Type]
+          #     The audio format. Always `audio/pcm`.
 
           # The sample rate of the audio. Always `24000`.
           #
@@ -73,7 +75,8 @@ module OpenAI
           # @!method initialize(type: nil)
           #   The G.711 μ-law format.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU::Type] The audio format. Always `audio/pcmu`.
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU::Type]
+          #     The audio format. Always `audio/pcmu`.
 
           # The audio format. Always `audio/pcmu`.
           #
@@ -98,7 +101,8 @@ module OpenAI
           # @!method initialize(type: nil)
           #   The G.711 A-law format.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA::Type] The audio format. Always `audio/pcma`.
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA::Type]
+          #     The audio format. Always `audio/pcma`.
 
           # The audio format. Always `audio/pcma`.
           #

data/lib/openai/models/realtime/realtime_audio_input_turn_detection.rb

@@ -101,26 +101,56 @@ module OpenAI
           optional :threshold, Float
 
           # @!method initialize(create_response: nil, idle_timeout_ms: nil, interrupt_response: nil, prefix_padding_ms: nil, silence_duration_ms: nil, threshold: nil, type: :server_vad)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::ServerVad} for more
-          #   details.
-          #
           #   Server-side voice activity detection (VAD) which flips on when user speech is
           #   detected and off after a period of silence.
           #
-          #   @param create_response [Boolean] Whether or not to automatically generate a response when a VAD stop event occurs
-          #
-          #   @param idle_timeout_ms [Integer, nil] Optional timeout after which a model response will be triggered automatically. T
-          #
-          #   @param interrupt_response [Boolean] Whether or not to automatically interrupt (cancel) any ongoing response with out
-          #
-          #   @param prefix_padding_ms [Integer] Used only for `server_vad` mode. Amount of audio to include before the VAD detec
-          #
-          #   @param silence_duration_ms [Integer] Used only for `server_vad` mode. Duration of silence to detect speech stop (in m
-          #
-          #   @param threshold [Float] Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this
-          #
-          #   @param type [Symbol, :server_vad] Type of turn detection, `server_vad` to turn on simple Server VAD.
+          #   @param create_response [Boolean]
+          #     Whether or not to automatically generate a response when a VAD stop event
+          #     occurs. If `interrupt_response` is set to `false` this may fail to create a
+          #     response if the model is already responding.
+          #
+          #     If both `create_response` and `interrupt_response` are set to `false`, the model
+          #     will never respond automatically but VAD events will still be emitted.
+          #
+          #   @param idle_timeout_ms [Integer, nil]
+          #     Optional timeout after which a model response will be triggered automatically.
+          #     This is useful for situations in which a long pause from the user is unexpected,
+          #     such as a phone call. The model will effectively prompt the user to continue the
+          #     conversation based on the current context.
+          #
+          #     The timeout value will be applied after the last model response's audio has
+          #     finished playing, i.e. it's set to the `response.done` time plus audio playback
+          #     duration.
+          #
+          #     An `input_audio_buffer.timeout_triggered` event (plus events associated with the
+          #     Response) will be emitted when the timeout is reached. Idle timeout is currently
+          #     only supported for `server_vad` mode.
+          #
+          #   @param interrupt_response [Boolean]
+          #     Whether or not to automatically interrupt (cancel) any ongoing response with
+          #     output to the default conversation (i.e. `conversation` of `auto`) when a VAD
+          #     start event occurs. If `true` then the response will be cancelled, otherwise it
+          #     will continue until complete.
+          #
+          #     If both `create_response` and `interrupt_response` are set to `false`, the model
+          #     will never respond automatically but VAD events will still be emitted.
+          #
+          #   @param prefix_padding_ms [Integer]
+          #     Used only for `server_vad` mode. Amount of audio to include before the VAD
+          #     detected speech (in milliseconds). Defaults to 300ms.
+          #
+          #   @param silence_duration_ms [Integer]
+          #     Used only for `server_vad` mode. Duration of silence to detect speech stop (in
+          #     milliseconds). Defaults to 500ms. With shorter values the model will respond
+          #     more quickly, but may jump in on short pauses from the user.
+          #
+          #   @param threshold [Float]
+          #     Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this
+          #     defaults to 0.5. A higher threshold will require louder audio to activate the
+          #     model, and thus might perform better in noisy environments.
+          #
+          #   @param type [Symbol, :server_vad]
+          #     Type of turn detection, `server_vad` to turn on simple Server VAD.
         end
 
         class SemanticVad < OpenAI::Internal::Type::BaseModel
@@ -158,20 +188,26 @@ module OpenAI
           optional :interrupt_response, OpenAI::Internal::Type::Boolean
 
           # @!method initialize(create_response: nil, eagerness: nil, interrupt_response: nil, type: :semantic_vad)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::SemanticVad} for
-          #   more details.
-          #
           #   Server-side semantic turn detection which uses a model to determine when the
           #   user has finished speaking.
           #
-          #   @param create_response [Boolean] Whether or not to automatically generate a response when a VAD stop event occurs
+          #   @param create_response [Boolean]
+          #     Whether or not to automatically generate a response when a VAD stop event
+          #     occurs.
           #
-          #   @param eagerness [Symbol, OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::SemanticVad::Eagerness] Used only for `semantic_vad` mode. The eagerness of the model to respond. `low`
+          #   @param eagerness [Symbol, OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::SemanticVad::Eagerness]
+          #     Used only for `semantic_vad` mode. The eagerness of the model to respond. `low`
+          #     will wait longer for the user to continue speaking, `high` will respond more
+          #     quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`,
+          #     and `high` have max timeouts of 8s, 4s, and 2s respectively.
           #
-          #   @param interrupt_response [Boolean] Whether or not to automatically interrupt any ongoing response with output to th
+          #   @param interrupt_response [Boolean]
+          #     Whether or not to automatically interrupt any ongoing response with output to
+          #     the default conversation (i.e. `conversation` of `auto`) when a VAD start event
+          #     occurs.
           #
-          #   @param type [Symbol, :semantic_vad] Type of turn detection, `semantic_vad` to turn on Semantic VAD.
+          #   @param type [Symbol, :semantic_vad]
+          #     Type of turn detection, `semantic_vad` to turn on Semantic VAD.
 
           # Used only for `semantic_vad` mode. The eagerness of the model to respond. `low`
           # will wait longer for the user to continue speaking, `high` will respond more

data/lib/openai/models/realtime/realtime_client_event.rb

@@ -66,7 +66,7 @@ module OpenAI
         # stop generating audio and emit a `output_audio_buffer.cleared` event. This
         # event should be preceded by a `response.cancel` client event to stop the
         # generation of the current response.
-        # [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+        # [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
         variant :"output_audio_buffer.clear", -> { OpenAI::Realtime::OutputAudioBufferClearEvent }
 
         # Send this event to commit the user input audio buffer, which will create a  new user message item in the conversation. This event will produce an error  if the input audio buffer is empty. When in Server VAD mode, the client does  not need to send this event, the server will commit the audio buffer  automatically.

data/lib/openai/models/realtime/realtime_conversation_item_assistant_message.rb

@@ -46,24 +46,27 @@ module OpenAI
         optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status }
 
         # @!method initialize(content:, id: nil, object: nil, status: nil, role: :assistant, type: :message)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage} for more
-        #   details.
-        #
         #   An assistant message item in a Realtime conversation.
         #
-        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content>] The content of the message.
+        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content>]
+        #     The content of the message.
         #
-        #   @param id [String] The unique ID of the item. This may be provided by the client or generated by th
+        #   @param id [String]
+        #     The unique ID of the item. This may be provided by the client or generated by
+        #     the server.
         #
-        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Object] Identifier for the API object being returned - always `realtime.item`. Optional
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Object]
+        #     Identifier for the API object being returned - always `realtime.item`. Optional
+        #     when creating a new item.
         #
-        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Status] The status of the item. Has no effect on the conversation.
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Status]
+        #     The status of the item. Has no effect on the conversation.
         #
-        #   @param role [Symbol, :assistant] The role of the message sender. Always `assistant`.
+        #   @param role [Symbol, :assistant]
+        #     The role of the message sender. Always `assistant`.
         #
-        #   @param type [Symbol, :message] The type of the item. Always `message`.
-
+        #   @param type [Symbol, :message]
+        #     The type of the item. Always `message`.
         class Content < OpenAI::Internal::Type::BaseModel
           # @!attribute audio
           #   Base64-encoded audio bytes, these will be parsed as the format specified in the
@@ -94,17 +97,21 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type }
 
           # @!method initialize(audio: nil, text: nil, transcript: nil, type: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content}
-          #   for more details.
-          #
-          #   @param audio [String] Base64-encoded audio bytes, these will be parsed as the format specified in the
+          #   @param audio [String]
+          #     Base64-encoded audio bytes, these will be parsed as the format specified in the
+          #     session output audio type configuration. This defaults to PCM 16-bit 24kHz mono
+          #     if not specified.
           #
-          #   @param text [String] The text content.
+          #   @param text [String]
+          #     The text content.
           #
-          #   @param transcript [String] The transcript of the audio content, this will always be present if the output t
+          #   @param transcript [String]
+          #     The transcript of the audio content, this will always be present if the output
+          #     type is `audio`.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::Type] The content type, `output_text` or `output_audio` depending on the session `outp
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::Type]
+          #     The content type, `output_text` or `output_audio` depending on the session
+          #     `output_modalities` configuration.
 
           # The content type, `output_text` or `output_audio` depending on the session
           # `output_modalities` configuration.

data/lib/openai/models/realtime/realtime_conversation_item_function_call.rb

@@ -51,25 +51,32 @@ module OpenAI
         optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status }
 
         # @!method initialize(arguments:, name:, id: nil, call_id: nil, object: nil, status: nil, type: :function_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall} for more
-        #   details.
-        #
         #   A function call item in a Realtime conversation.
         #
-        #   @param arguments [String] The arguments of the function call. This is a JSON-encoded string representing t
+        #   @param arguments [String]
+        #     The arguments of the function call. This is a JSON-encoded string representing
+        #     the arguments passed to the function, for example
+        #     `{"arg1": "value1", "arg2": 42}`.
         #
-        #   @param name [String] The name of the function being called.
+        #   @param name [String]
+        #     The name of the function being called.
         #
-        #   @param id [String] The unique ID of the item. This may be provided by the client or generated by th
+        #   @param id [String]
+        #     The unique ID of the item. This may be provided by the client or generated by
+        #     the server.
         #
-        #   @param call_id [String] The ID of the function call.
+        #   @param call_id [String]
+        #     The ID of the function call.
         #
-        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Object] Identifier for the API object being returned - always `realtime.item`. Optional
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Object]
+        #     Identifier for the API object being returned - always `realtime.item`. Optional
+        #     when creating a new item.
         #
-        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Status] The status of the item. Has no effect on the conversation.
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Status]
+        #     The status of the item. Has no effect on the conversation.
         #
-        #   @param type [Symbol, :function_call] The type of the item. Always `function_call`.
+        #   @param type [Symbol, :function_call]
+        #     The type of the item. Always `function_call`.
 
         # Identifier for the API object being returned - always `realtime.item`. Optional
         # when creating a new item.