openai 0.87.0 → 0.89.0

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

@@ -24,18 +24,18 @@ module OpenAI
         required :value, String
 
         # @!method initialize(expires_at:, session:, value:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateResponse} for
-        #   more details.
-        #
         #   Response from creating a translation session and client secret for the Realtime
         #   API.
         #
-        #   @param expires_at [Integer] Expiration timestamp for the client secret, in seconds since epoch.
+        #   @param expires_at [Integer]
+        #     Expiration timestamp for the client secret, in seconds since epoch.
         #
-        #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSession] A Realtime translation session. Translation sessions continuously translate inpu
+        #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSession]
+        #     A Realtime translation session. Translation sessions continuously translate
+        #     input audio into the configured output language.
         #
-        #   @param value [String] The generated client secret value.
+        #   @param value [String]
+        #     The generated client secret value.
       end
     end
   end

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

@@ -40,11 +40,14 @@ module OpenAI
         #   audio and later resumes, model time treats the resumed audio as contiguous with
         #   the previous audio rather than as a real-world pause.
         #
-        #   @param audio [String] Base64-encoded 24 kHz PCM16 mono audio bytes.
+        #   @param audio [String]
+        #     Base64-encoded 24 kHz PCM16 mono audio bytes.
         #
-        #   @param event_id [String] Optional client-generated ID used to identify this event.
+        #   @param event_id [String]
+        #     Optional client-generated ID used to identify this event.
         #
-        #   @param type [Symbol, :"session.input_audio_buffer.append"] The event type, must be `session.input_audio_buffer.append`.
+        #   @param type [Symbol, :"session.input_audio_buffer.append"]
+        #     The event type, must be `session.input_audio_buffer.append`.
       end
     end
   end

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

@@ -32,23 +32,26 @@ module OpenAI
         optional :elapsed_ms, Integer, nil?: true
 
         # @!method initialize(delta:, event_id:, elapsed_ms: nil, type: :"session.input_transcript.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranslationInputTranscriptDeltaEvent} for
-        #   more details.
-        #
         #   Returned when optional source-language transcript text is available. This event
         #   is emitted only when `audio.input.transcription` is configured.
         #
         #   Transcript deltas are append-only text fragments. Clients should not insert
         #   unconditional spaces between deltas.
         #
-        #   @param delta [String] Append-only source-language transcript text.
+        #   @param delta [String]
+        #     Append-only source-language transcript text.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param elapsed_ms [Integer, nil] Timing metadata for stream alignment, derived from the translation frame
+        #   @param elapsed_ms [Integer, nil]
+        #     Timing metadata for stream alignment, derived from the translation frame when
+        #     available. It advances in 200 ms increments, but multiple transcript deltas may
+        #     share the same `elapsed_ms`. Treat it as alignment metadata, not a unique
+        #     transcript-delta identifier.
         #
-        #   @param type [Symbol, :"session.input_transcript.delta"] The event type, must be `session.input_transcript.delta`.
+        #   @param type [Symbol, :"session.input_transcript.delta"]
+        #     The event type, must be `session.input_transcript.delta`.
       end
     end
   end

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

@@ -53,27 +53,32 @@ module OpenAI
         optional :sample_rate, Integer
 
         # @!method initialize(delta:, event_id:, channels: nil, elapsed_ms: nil, format_: nil, sample_rate: nil, type: :"session.output_audio.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranslationOutputAudioDeltaEvent} for more
-        #   details.
-        #
         #   Returned when translated output audio is available. The `delta` contains a PCM16
         #   audio chunk whose length can vary. Clients should decode and queue the complete
         #   delta instead of assuming a fixed byte or sample count.
         #
-        #   @param delta [String] Base64-encoded translated audio data.
+        #   @param delta [String]
+        #     Base64-encoded translated audio data.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param channels [Integer] Number of audio channels.
+        #   @param channels [Integer]
+        #     Number of audio channels.
         #
-        #   @param elapsed_ms [Integer, nil] Timing metadata for stream alignment, derived from the translation frame
+        #   @param elapsed_ms [Integer, nil]
+        #     Timing metadata for stream alignment, derived from the translation frame when
+        #     available. Treat `elapsed_ms` as alignment metadata, not a unique event
+        #     identifier.
         #
-        #   @param format_ [Symbol, OpenAI::Models::Realtime::RealtimeTranslationOutputAudioDeltaEvent::Format] Audio encoding for `delta`.
+        #   @param format_ [Symbol, OpenAI::Models::Realtime::RealtimeTranslationOutputAudioDeltaEvent::Format]
+        #     Audio encoding for `delta`.
         #
-        #   @param sample_rate [Integer] Sample rate of the audio delta.
+        #   @param sample_rate [Integer]
+        #     Sample rate of the audio delta.
         #
-        #   @param type [Symbol, :"session.output_audio.delta"] The event type, must be `session.output_audio.delta`.
+        #   @param type [Symbol, :"session.output_audio.delta"]
+        #     The event type, must be `session.output_audio.delta`.
 
         # Audio encoding for `delta`.
         #

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

@@ -32,22 +32,25 @@ module OpenAI
         optional :elapsed_ms, Integer, nil?: true
 
         # @!method initialize(delta:, event_id:, elapsed_ms: nil, type: :"session.output_transcript.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranslationOutputTranscriptDeltaEvent} for
-        #   more details.
-        #
         #   Returned when translated transcript text is available.
         #
         #   Transcript deltas are append-only text fragments. Clients should not insert
         #   unconditional spaces between deltas.
         #
-        #   @param delta [String] Append-only transcript text for the translated output audio.
+        #   @param delta [String]
+        #     Append-only transcript text for the translated output audio.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param elapsed_ms [Integer, nil] Timing metadata for stream alignment, derived from the translation frame
+        #   @param elapsed_ms [Integer, nil]
+        #     Timing metadata for stream alignment, derived from the translation frame when
+        #     available. It advances in 200 ms increments, but multiple transcript deltas may
+        #     share the same `elapsed_ms`. Treat it as alignment metadata, not a unique
+        #     transcript-delta identifier.
         #
-        #   @param type [Symbol, :"session.output_transcript.delta"] The event type, must be `session.output_transcript.delta`.
+        #   @param type [Symbol, :"session.output_transcript.delta"]
+        #     The event type, must be `session.output_transcript.delta`.
       end
     end
   end

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

@@ -36,21 +36,24 @@ module OpenAI
         required :type, const: :translation
 
         # @!method initialize(id:, audio:, expires_at:, model:, type: :translation)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranslationSession} for more details.
-        #
         #   A Realtime translation session. Translation sessions continuously translate
         #   input audio into the configured output language.
         #
-        #   @param id [String] Unique identifier for the session that looks like `sess_1234567890abcdef`.
+        #   @param id [String]
+        #     Unique identifier for the session that looks like `sess_1234567890abcdef`.
         #
-        #   @param audio [OpenAI::Models::Realtime::RealtimeTranslationSession::Audio] Configuration for translation input and output audio.
+        #   @param audio [OpenAI::Models::Realtime::RealtimeTranslationSession::Audio]
+        #     Configuration for translation input and output audio.
         #
-        #   @param expires_at [Integer] Expiration timestamp for the session, in seconds since epoch.
+        #   @param expires_at [Integer]
+        #     Expiration timestamp for the session, in seconds since epoch.
         #
-        #   @param model [String] The Realtime translation model used for this session. This field is set at
+        #   @param model [String]
+        #     The Realtime translation model used for this session. This field is set at
+        #     session creation and cannot be changed with `session.update`.
         #
-        #   @param type [Symbol, :translation] The session type. Always `translation` for Realtime translation sessions.
+        #   @param type [Symbol, :translation]
+        #     The session type. Always `translation` for Realtime translation sessions.
 
         # @see OpenAI::Models::Realtime::RealtimeTranslationSession#audio
         class Audio < OpenAI::Internal::Type::BaseModel
@@ -95,13 +98,13 @@ module OpenAI
             )
 
             # @!method initialize(noise_reduction: nil, transcription: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::RealtimeTranslationSession::Audio::Input} for more
-            #   details.
-            #
-            #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeTranslationSession::Audio::Input::NoiseReduction, nil] Optional input noise reduction.
+            #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeTranslationSession::Audio::Input::NoiseReduction, nil]
+            #     Optional input noise reduction.
             #
-            #   @param transcription [OpenAI::Models::Realtime::RealtimeTranslationSession::Audio::Input::Transcription, nil] Optional source-language transcription. When configured, the server emits
+            #   @param transcription [OpenAI::Models::Realtime::RealtimeTranslationSession::Audio::Input::Transcription, nil]
+            #     Optional source-language transcription. When configured, the server emits
+            #     `session.input_transcript.delta` events. Translation itself still runs from the
+            #     input audio stream.
 
             # @see OpenAI::Models::Realtime::RealtimeTranslationSession::Audio::Input#noise_reduction
             class NoiseReduction < OpenAI::Internal::Type::BaseModel
@@ -114,13 +117,12 @@ module OpenAI
               required :type, enum: -> { OpenAI::Realtime::NoiseReductionType }
 
               # @!method initialize(type:)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Realtime::RealtimeTranslationSession::Audio::Input::NoiseReduction}
-              #   for more details.
-              #
               #   Optional input noise reduction.
               #
-              #   @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
 
             # @see OpenAI::Models::Realtime::RealtimeTranslationSession::Audio::Input#transcription
@@ -136,7 +138,8 @@ module OpenAI
               #   `session.input_transcript.delta` events. Translation itself still runs from the
               #   input audio stream.
               #
-              #   @param model [String] The transcription model used for source transcript deltas.
+              #   @param model [String]
+              #     The transcription model used for source transcript deltas.
             end
           end
 
@@ -149,11 +152,8 @@ module OpenAI
             optional :language, String
 
             # @!method initialize(language: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::RealtimeTranslationSession::Audio::Output} for more
-            #   details.
-            #
-            #   @param language [String] Target language for translated output audio and transcript deltas.
+            #   @param language [String]
+            #     Target language for translated output audio and transcript deltas.
           end
         end
       end

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

@@ -21,9 +21,11 @@ module OpenAI
         #   input audio and emits any remaining translated output before closing the
         #   session.
         #
-        #   @param event_id [String] Optional client-generated ID used to identify this event.
+        #   @param event_id [String]
+        #     Optional client-generated ID used to identify this event.
         #
-        #   @param type [Symbol, :"session.close"] The event type, must be `session.close`.
+        #   @param type [Symbol, :"session.close"]
+        #     The event type, must be `session.close`.
       end
     end
   end

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

@@ -19,9 +19,11 @@ module OpenAI
         # @!method initialize(event_id:, type: :"session.closed")
         #   Returned when a realtime translation session is closed.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param type [Symbol, :"session.closed"] The event type, must be `session.closed`.
+        #   @param type [Symbol, :"session.closed"]
+        #     The event type, must be `session.closed`.
       end
     end
   end

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

@@ -17,16 +17,14 @@ module OpenAI
         optional :audio, -> { OpenAI::Realtime::RealtimeTranslationSessionCreateRequest::Audio }
 
         # @!method initialize(model:, audio: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest} for more
-        #   details.
-        #
         #   Realtime translation session configuration. Translation sessions stream source
         #   audio in and translated audio plus transcript deltas out continuously.
         #
-        #   @param model [String] The Realtime translation model used for this session.
+        #   @param model [String]
+        #     The Realtime translation model used for this session.
         #
-        #   @param audio [OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio] Configuration for translation input and output audio.
+        #   @param audio [OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio]
+        #     Configuration for translation input and output audio.
 
         # @see OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest#audio
         class Audio < OpenAI::Internal::Type::BaseModel
@@ -75,13 +73,13 @@ module OpenAI
             )
 
             # @!method initialize(noise_reduction: nil, transcription: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio::Input}
-            #   for more details.
-            #
-            #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio::Input::NoiseReduction, nil] Optional input noise reduction. Set to `null` to disable it.
+            #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio::Input::NoiseReduction, nil]
+            #     Optional input noise reduction. Set to `null` to disable it.
             #
-            #   @param transcription [OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio::Input::Transcription, nil] Optional source-language transcription. When configured, the server emits
+            #   @param transcription [OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio::Input::Transcription, nil]
+            #     Optional source-language transcription. When configured, the server emits
+            #     `session.input_transcript.delta` events. Translation itself still runs from the
+            #     input audio stream.
 
             # @see OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio::Input#noise_reduction
             class NoiseReduction < OpenAI::Internal::Type::BaseModel
@@ -94,13 +92,12 @@ module OpenAI
               required :type, enum: -> { OpenAI::Realtime::NoiseReductionType }
 
               # @!method initialize(type:)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio::Input::NoiseReduction}
-              #   for more details.
-              #
               #   Optional input noise reduction. Set to `null` to disable it.
               #
-              #   @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
 
             # @see OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio::Input#transcription
@@ -116,7 +113,8 @@ module OpenAI
               #   `session.input_transcript.delta` events. Translation itself still runs from the
               #   input audio stream.
               #
-              #   @param model [String] The transcription model to use for source transcript deltas.
+              #   @param model [String]
+              #     The transcription model to use for source transcript deltas.
             end
           end
 
@@ -129,11 +127,8 @@ module OpenAI
             optional :language, String
 
             # @!method initialize(language: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest::Audio::Output}
-            #   for more details.
-            #
-            #   @param language [String] Target language for translated output audio and transcript deltas.
+            #   @param language [String]
+            #     Target language for translated output audio and transcript deltas.
           end
         end
       end

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

@@ -27,11 +27,14 @@ module OpenAI
         #   connection is established as the first server event. This event contains the
         #   default translation session configuration.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSession] The translation session configuration.
+        #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSession]
+        #     The translation session configuration.
         #
-        #   @param type [Symbol, :"session.created"] The event type, must be `session.created`.
+        #   @param type [Symbol, :"session.created"]
+        #     The event type, must be `session.created`.
       end
     end
   end

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

@@ -24,19 +24,19 @@ module OpenAI
         optional :event_id, String
 
         # @!method initialize(session:, event_id: nil, type: :"session.update")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateEvent} for more
-        #   details.
-        #
         #   Send this event to update the translation session configuration. Translation
         #   sessions support updates to `audio.output.language`,
         #   `audio.input.transcription`, and `audio.input.noise_reduction`.
         #
-        #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest] Translation session fields to update. The session `type` and `model` are set
+        #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest]
+        #     Translation session fields to update. The session `type` and `model` are set at
+        #     creation and cannot be changed with `session.update`.
         #
-        #   @param event_id [String] Optional client-generated ID used to identify this event.
+        #   @param event_id [String]
+        #     Optional client-generated ID used to identify this event.
         #
-        #   @param type [Symbol, :"session.update"] The event type, must be `session.update`.
+        #   @param type [Symbol, :"session.update"]
+        #     The event type, must be `session.update`.
       end
     end
   end

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

@@ -11,13 +11,10 @@ module OpenAI
         optional :audio, -> { OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio }
 
         # @!method initialize(audio: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest} for more
-        #   details.
-        #
         #   Realtime translation session fields that can be updated with `session.update`.
         #
-        #   @param audio [OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio] Configuration for translation input and output audio.
+        #   @param audio [OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio]
+        #     Configuration for translation input and output audio.
 
         # @see OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest#audio
         class Audio < OpenAI::Internal::Type::BaseModel
@@ -66,13 +63,13 @@ module OpenAI
             )
 
             # @!method initialize(noise_reduction: nil, transcription: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input}
-            #   for more details.
-            #
-            #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::NoiseReduction, nil] Optional input noise reduction. Set to `null` to disable it.
+            #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::NoiseReduction, nil]
+            #     Optional input noise reduction. Set to `null` to disable it.
             #
-            #   @param transcription [OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::Transcription, nil] Optional source-language transcription. When configured, the server emits
+            #   @param transcription [OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::Transcription, nil]
+            #     Optional source-language transcription. When configured, the server emits
+            #     `session.input_transcript.delta` events. Translation itself still runs from the
+            #     input audio stream.
 
             # @see OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input#noise_reduction
             class NoiseReduction < OpenAI::Internal::Type::BaseModel
@@ -85,13 +82,12 @@ module OpenAI
               required :type, enum: -> { OpenAI::Realtime::NoiseReductionType }
 
               # @!method initialize(type:)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::NoiseReduction}
-              #   for more details.
-              #
               #   Optional input noise reduction. Set to `null` to disable it.
               #
-              #   @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
 
             # @see OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input#transcription
@@ -107,7 +103,8 @@ module OpenAI
               #   `session.input_transcript.delta` events. Translation itself still runs from the
               #   input audio stream.
               #
-              #   @param model [String] The transcription model to use for source transcript deltas.
+              #   @param model [String]
+              #     The transcription model to use for source transcript deltas.
             end
           end
 
@@ -120,11 +117,8 @@ module OpenAI
             optional :language, String
 
             # @!method initialize(language: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Output}
-            #   for more details.
-            #
-            #   @param language [String] Target language for translated output audio and transcript deltas.
+            #   @param language [String]
+            #     Target language for translated output audio and transcript deltas.
           end
         end
       end

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

@@ -26,11 +26,14 @@ module OpenAI
         #   Returned when a translation session is updated with a `session.update` event,
         #   unless there is an error.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSession] The translation session configuration.
+        #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSession]
+        #     The translation session configuration.
         #
-        #   @param type [Symbol, :"session.updated"] The event type, must be `session.updated`.
+        #   @param type [Symbol, :"session.updated"]
+        #     The event type, must be `session.updated`.
       end
     end
   end

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

@@ -27,18 +27,22 @@ module OpenAI
         optional :token_limits, -> { OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits }
 
         # @!method initialize(retention_ratio:, token_limits: nil, type: :retention_ratio)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio} for more details.
-        #
         #   Retain a fraction of the conversation tokens when the conversation exceeds the
         #   input token limit. This allows you to amortize truncations across multiple
         #   turns, which can help improve cached token usage.
         #
-        #   @param retention_ratio [Float] Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when
+        #   @param retention_ratio [Float]
+        #     Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when
+        #     the conversation exceeds the input token limit. Setting this to `0.8` means that
+        #     messages will be dropped until 80% of the maximum allowed tokens are used. This
+        #     helps reduce the frequency of truncations and improve cache rates.
         #
-        #   @param token_limits [OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio::TokenLimits] Optional custom token limits for this truncation strategy. If not provided, the
+        #   @param token_limits [OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio::TokenLimits]
+        #     Optional custom token limits for this truncation strategy. If not provided, the
+        #     model's default token limits will be used.
         #
-        #   @param type [Symbol, :retention_ratio] Use retention ratio truncation.
+        #   @param type [Symbol, :retention_ratio]
+        #     Use retention ratio truncation.
 
         # @see OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio#token_limits
         class TokenLimits < OpenAI::Internal::Type::BaseModel
@@ -53,14 +57,15 @@ module OpenAI
           optional :post_instructions, Integer
 
           # @!method initialize(post_instructions: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio::TokenLimits} for
-          #   more details.
-          #
           #   Optional custom token limits for this truncation strategy. If not provided, the
           #   model's default token limits will be used.
           #
-          #   @param post_instructions [Integer] Maximum tokens allowed in the conversation after instructions (which including t
+          #   @param post_instructions [Integer]
+          #     Maximum tokens allowed in the conversation after instructions (which including
+          #     tool definitions). For example, setting this to 5,000 would mean that truncation
+          #     would occur when the conversation exceeds 5,000 tokens after instructions. This
+          #     cannot be higher than the model's context window size minus the maximum output
+          #     tokens.
         end
       end
     end

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

@@ -49,19 +49,26 @@ module OpenAI
         # @!method initialize(content_index:, delta:, event_id:, item_id:, output_index:, response_id:, type: :"response.output_audio.delta")
         #   Returned when the model-generated audio is updated.
         #
-        #   @param content_index [Integer] The index of the content part in the item's content array.
+        #   @param content_index [Integer]
+        #     The index of the content part in the item's content array.
         #
-        #   @param delta [String] Base64-encoded audio data delta.
+        #   @param delta [String]
+        #     Base64-encoded audio data delta.
         #
-        #   @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.
+        #   @param item_id [String]
+        #     The ID of the item.
         #
-        #   @param output_index [Integer] The index of the output item in the response.
+        #   @param output_index [Integer]
+        #     The index of the output item in the response.
         #
-        #   @param response_id [String] The ID of the response.
+        #   @param response_id [String]
+        #     The ID of the response.
         #
-        #   @param type [Symbol, :"response.output_audio.delta"] The event type, must be `response.output_audio.delta`.
+        #   @param type [Symbol, :"response.output_audio.delta"]
+        #     The event type, must be `response.output_audio.delta`.
       end
     end
   end

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

@@ -44,17 +44,23 @@ module OpenAI
         #   Returned when the model-generated audio is done. Also emitted when a Response is
         #   interrupted, incomplete, or cancelled.
         #
-        #   @param content_index [Integer] The index of the content part in the item's content array.
+        #   @param content_index [Integer]
+        #     The index of the content part in the item's content array.
         #
-        #   @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.
+        #   @param item_id [String]
+        #     The ID of the item.
         #
-        #   @param output_index [Integer] The index of the output item in the response.
+        #   @param output_index [Integer]
+        #     The index of the output item in the response.
         #
-        #   @param response_id [String] The ID of the response.
+        #   @param response_id [String]
+        #     The ID of the response.
         #
-        #   @param type [Symbol, :"response.output_audio.done"] The event type, must be `response.output_audio.done`.
+        #   @param type [Symbol, :"response.output_audio.done"]
+        #     The event type, must be `response.output_audio.done`.
       end
     end
   end