openai 0.87.0 → 0.89.0

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

@@ -62,10 +62,6 @@ module OpenAI
         )
 
         # @!method initialize(content_index:, event_id:, item_id:, transcript:, usage:, languages: nil, logprobs: nil, type: :"conversation.item.input_audio_transcription.completed")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent}
-        #   for more details.
-        #
         #   This event is the output of audio transcription for user audio written to the
         #   user audio buffer. Transcription begins when the input audio buffer is committed
         #   by the client or server (when VAD is enabled). Transcription runs asynchronously
@@ -77,21 +73,31 @@ module OpenAI
         #   transcript may diverge somewhat from the model's interpretation, and should be
         #   treated as a rough guide.
         #
-        #   @param content_index [Integer] The index of the content part containing the audio.
+        #   @param content_index [Integer]
+        #     The index of the content part containing the audio.
         #
-        #   @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 containing the audio that is being transcribed.
+        #   @param item_id [String]
+        #     The ID of the item containing the audio that is being transcribed.
         #
-        #   @param transcript [String] The transcribed text.
+        #   @param transcript [String]
+        #     The transcribed text.
         #
-        #   @param usage [OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens, OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageDuration] Usage statistics for the transcription, this is billed according to the ASR mode
+        #   @param usage [OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens, OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageDuration]
+        #     Usage statistics for the transcription, this is billed according to the ASR
+        #     model's pricing rather than the realtime model's pricing.
         #
-        #   @param languages [Array<OpenAI::Models::Audio::TranscriptionLanguage>] The languages detected in the audio. Returned by `gpt-transcribe`. An empty arra
+        #   @param languages [Array<OpenAI::Models::Audio::TranscriptionLanguage>]
+        #     The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        #     array indicates that no language could be reliably detected.
         #
-        #   @param logprobs [Array<OpenAI::Models::Realtime::LogProbProperties>, nil] The log probabilities of the transcription.
+        #   @param logprobs [Array<OpenAI::Models::Realtime::LogProbProperties>, nil]
+        #     The log probabilities of the transcription.
         #
-        #   @param type [Symbol, :"conversation.item.input_audio_transcription.completed"] The event type, must be
+        #   @param type [Symbol, :"conversation.item.input_audio_transcription.completed"]
+        #     The event type, must be `conversation.item.input_audio_transcription.completed`.
 
         # Usage statistics for the transcription, this is billed according to the ASR
         # model's pricing rather than the realtime model's pricing.
@@ -153,15 +159,20 @@ module OpenAI
             # @!method initialize(input_tokens:, output_tokens:, total_tokens:, input_token_details: nil, type: :tokens)
             #   Usage statistics for models billed by token usage.
             #
-            #   @param input_tokens [Integer] Number of input tokens billed for this request.
+            #   @param input_tokens [Integer]
+            #     Number of input tokens billed for this request.
             #
-            #   @param output_tokens [Integer] Number of output tokens generated.
+            #   @param output_tokens [Integer]
+            #     Number of output tokens generated.
             #
-            #   @param total_tokens [Integer] Total number of tokens used (input + output).
+            #   @param total_tokens [Integer]
+            #     Total number of tokens used (input + output).
             #
-            #   @param input_token_details [OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails] Details about the input tokens billed for this request.
+            #   @param input_token_details [OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails]
+            #     Details about the input tokens billed for this request.
             #
-            #   @param type [Symbol, :tokens] The type of the usage object. Always `tokens` for this variant.
+            #   @param type [Symbol, :tokens]
+            #     The type of the usage object. Always `tokens` for this variant.
 
             # @see OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens#input_token_details
             class InputTokenDetails < OpenAI::Internal::Type::BaseModel
@@ -180,9 +191,11 @@ module OpenAI
               # @!method initialize(audio_tokens: nil, text_tokens: nil)
               #   Details about the input tokens billed for this request.
               #
-              #   @param audio_tokens [Integer] Number of audio tokens billed for this request.
+              #   @param audio_tokens [Integer]
+              #     Number of audio tokens billed for this request.
               #
-              #   @param text_tokens [Integer] Number of text tokens billed for this request.
+              #   @param text_tokens [Integer]
+              #     Number of text tokens billed for this request.
             end
           end
 
@@ -202,9 +215,11 @@ module OpenAI
             # @!method initialize(seconds:, type: :duration)
             #   Usage statistics for models billed by audio input duration.
             #
-            #   @param seconds [Float] Duration of the input audio in seconds.
+            #   @param seconds [Float]
+            #     Duration of the input audio in seconds.
             #
-            #   @param type [Symbol, :duration] The type of the usage object. Always `duration` for this variant.
+            #   @param type [Symbol, :duration]
+            #     The type of the usage object. Always `duration` for this variant.
           end
 
           # @!method self.variants

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

@@ -50,24 +50,31 @@ module OpenAI
         )
 
         # @!method initialize(event_id:, item_id:, content_index: nil, delta: nil, logprobs: nil, type: :"conversation.item.input_audio_transcription.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionDeltaEvent}
-        #   for more details.
-        #
         #   Returned when the text value of an input audio transcription content part is
         #   updated with incremental transcription results.
         #
-        #   @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 containing the audio that is being transcribed.
+        #   @param item_id [String]
+        #     The ID of the item containing the audio that is being transcribed.
         #
-        #   @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] The text delta.
+        #   @param delta [String]
+        #     The text delta.
         #
-        #   @param logprobs [Array<OpenAI::Models::Realtime::LogProbProperties>, nil] The log probabilities of the transcription. These can be enabled by configuratin
+        #   @param logprobs [Array<OpenAI::Models::Realtime::LogProbProperties>, nil]
+        #     The log probabilities of the transcription. These can be enabled by
+        #     configurating the session with
+        #     `"include": ["item.input_audio_transcription.logprobs"]`. Each entry in the
+        #     array corresponds a log probability of which token would be selected for this
+        #     chunk of transcription. This can help to identify if it was possible there were
+        #     multiple valid options for a given chunk of transcription.
         #
-        #   @param type [Symbol, :"conversation.item.input_audio_transcription.delta"] The event type, must be `conversation.item.input_audio_transcription.delta`.
+        #   @param type [Symbol, :"conversation.item.input_audio_transcription.delta"]
+        #     The event type, must be `conversation.item.input_audio_transcription.delta`.
       end
     end
   end

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

@@ -35,23 +35,24 @@ module OpenAI
         required :type, const: :"conversation.item.input_audio_transcription.failed"
 
         # @!method initialize(content_index:, error:, event_id:, item_id:, type: :"conversation.item.input_audio_transcription.failed")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent}
-        #   for more details.
-        #
         #   Returned when input audio transcription is configured, and a transcription
         #   request for a user message failed. These events are separate from other `error`
         #   events so that the client can identify the related Item.
         #
-        #   @param content_index [Integer] The index of the content part containing the audio.
+        #   @param content_index [Integer]
+        #     The index of the content part containing the audio.
         #
-        #   @param error [OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error] Details of the transcription error.
+        #   @param error [OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error]
+        #     Details of the transcription error.
         #
-        #   @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.
+        #   @param item_id [String]
+        #     The ID of the user message item.
         #
-        #   @param type [Symbol, :"conversation.item.input_audio_transcription.failed"] The event type, must be
+        #   @param type [Symbol, :"conversation.item.input_audio_transcription.failed"]
+        #     The event type, must be `conversation.item.input_audio_transcription.failed`.
 
         # @see OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent#error
         class Error < OpenAI::Internal::Type::BaseModel
@@ -82,13 +83,17 @@ module OpenAI
           # @!method initialize(code: nil, message: nil, param: nil, type: nil)
           #   Details of the transcription error.
           #
-          #   @param code [String] Error code, if any.
+          #   @param code [String]
+          #     Error code, if any.
           #
-          #   @param message [String] A human-readable error message.
+          #   @param message [String]
+          #     A human-readable error message.
           #
-          #   @param param [String] Parameter related to the error, if any.
+          #   @param param [String]
+          #     Parameter related to the error, if any.
           #
-          #   @param type [String] The type of error.
+          #   @param type [String]
+          #     The type of error.
         end
       end
     end

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

@@ -61,23 +61,32 @@ module OpenAI
         # @!method initialize(id:, content_index:, end_:, event_id:, item_id:, speaker:, start:, text:, type: :"conversation.item.input_audio_transcription.segment")
         #   Returned when an input audio transcription segment is identified for an item.
         #
-        #   @param id [String] The segment identifier.
+        #   @param id [String]
+        #     The segment identifier.
         #
-        #   @param content_index [Integer] The index of the input audio content part within the item.
+        #   @param content_index [Integer]
+        #     The index of the input audio content part within the item.
         #
-        #   @param end_ [Float] End time of the segment in seconds.
+        #   @param end_ [Float]
+        #     End time of the segment in seconds.
         #
-        #   @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 containing the input audio content.
+        #   @param item_id [String]
+        #     The ID of the item containing the input audio content.
         #
-        #   @param speaker [String] The detected speaker label for this segment.
+        #   @param speaker [String]
+        #     The detected speaker label for this segment.
         #
-        #   @param start [Float] Start time of the segment in seconds.
+        #   @param start [Float]
+        #     Start time of the segment in seconds.
         #
-        #   @param text [String] The text for this segment.
+        #   @param text [String]
+        #     The text for this segment.
         #
-        #   @param type [Symbol, :"conversation.item.input_audio_transcription.segment"] The event type, must be `conversation.item.input_audio_transcription.segment`.
+        #   @param type [Symbol, :"conversation.item.input_audio_transcription.segment"]
+        #     The event type, must be `conversation.item.input_audio_transcription.segment`.
       end
     end
   end

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

@@ -29,11 +29,14 @@ module OpenAI
         #   with a `conversation.item.retrieved` event, unless the item does not exist in
         #   the conversation history, in which case the server will respond with an error.
         #
-        #   @param item_id [String] The ID of the item to retrieve.
+        #   @param item_id [String]
+        #     The ID of the item to retrieve.
         #
-        #   @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, :"conversation.item.retrieve"] The event type, must be `conversation.item.retrieve`.
+        #   @param type [Symbol, :"conversation.item.retrieve"]
+        #     The event type, must be `conversation.item.retrieve`.
       end
     end
   end

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

@@ -38,9 +38,6 @@ module OpenAI
         optional :event_id, String
 
         # @!method initialize(audio_end_ms:, content_index:, item_id:, event_id: nil, type: :"conversation.item.truncate")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemTruncateEvent} for more details.
-        #
         #   Send this event to truncate a previous assistant message’s audio. The server
         #   will produce audio faster than realtime, so this event is useful when the user
         #   interrupts to truncate audio that has already been sent to the client but not
@@ -53,15 +50,23 @@ module OpenAI
         #   If successful, the server will respond with a `conversation.item.truncated`
         #   event.
         #
-        #   @param audio_end_ms [Integer] Inclusive duration up to which audio is truncated, in milliseconds. If
+        #   @param audio_end_ms [Integer]
+        #     Inclusive duration up to which audio is truncated, in milliseconds. If the
+        #     audio_end_ms is greater than the actual audio duration, the server will respond
+        #     with an error.
         #
-        #   @param content_index [Integer] The index of the content part to truncate. Set this to `0`.
+        #   @param content_index [Integer]
+        #     The index of the content part to truncate. Set this to `0`.
         #
-        #   @param item_id [String] The ID of the assistant message item to truncate. Only assistant message
+        #   @param item_id [String]
+        #     The ID of the assistant message item to truncate. Only assistant message items
+        #     can be truncated.
         #
-        #   @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, :"conversation.item.truncate"] The event type, must be `conversation.item.truncate`.
+        #   @param type [Symbol, :"conversation.item.truncate"]
+        #     The event type, must be `conversation.item.truncate`.
       end
     end
   end

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

@@ -35,9 +35,6 @@ module OpenAI
         required :type, const: :"conversation.item.truncated"
 
         # @!method initialize(audio_end_ms:, content_index:, event_id:, item_id:, type: :"conversation.item.truncated")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemTruncatedEvent} for more details.
-        #
         #   Returned when an earlier assistant audio message item is truncated by the client
         #   with a `conversation.item.truncate` event. This event is used to synchronize the
         #   server's understanding of the audio with the client's playback.
@@ -45,15 +42,20 @@ module OpenAI
         #   This action will truncate the audio and remove the server-side text transcript
         #   to ensure there is no text in the context that hasn't been heard by the user.
         #
-        #   @param audio_end_ms [Integer] The duration up to which the audio was truncated, in milliseconds.
+        #   @param audio_end_ms [Integer]
+        #     The duration up to which the audio was truncated, in milliseconds.
         #
-        #   @param content_index [Integer] The index of the content part that was truncated.
+        #   @param content_index [Integer]
+        #     The index of the content part that was truncated.
         #
-        #   @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 assistant message item that was truncated.
+        #   @param item_id [String]
+        #     The ID of the assistant message item that was truncated.
         #
-        #   @param type [Symbol, :"conversation.item.truncated"] The event type, must be `conversation.item.truncated`.
+        #   @param type [Symbol, :"conversation.item.truncated"]
+        #     The event type, must be `conversation.item.truncated`.
       end
     end
   end

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

@@ -83,32 +83,52 @@ module OpenAI
         optional :type, enum: -> { OpenAI::Realtime::ConversationItemWithReference::Type }
 
         # @!method initialize(id: nil, arguments: nil, call_id: nil, content: nil, name: nil, object: nil, output: nil, role: nil, status: nil, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemWithReference} for more details.
-        #
         #   The item to add to the conversation.
         #
-        #   @param id [String] For an item of type (`message` | `function_call` | `function_call_output`)
+        #   @param id [String]
+        #     For an item of type (`message` | `function_call` | `function_call_output`) this
+        #     field allows the client to assign the unique ID of the item. It is not required
+        #     because the server will generate one if not provided.
         #
-        #   @param arguments [String] The arguments of the function call (for `function_call` items).
+        #     For an item of type `item_reference`, this field is required and is a reference
+        #     to any item that has previously existed in the conversation.
         #
-        #   @param call_id [String] The ID of the function call (for `function_call` and
+        #   @param arguments [String]
+        #     The arguments of the function call (for `function_call` items).
         #
-        #   @param content [Array<OpenAI::Models::Realtime::ConversationItemWithReference::Content>] The content of the message, applicable for `message` items.
+        #   @param call_id [String]
+        #     The ID of the function call (for `function_call` and `function_call_output`
+        #     items). If passed on a `function_call_output` item, the server will check that a
+        #     `function_call` item with the same ID exists in the conversation history.
         #
-        #   @param name [String] The name of the function being called (for `function_call` items).
+        #   @param content [Array<OpenAI::Models::Realtime::ConversationItemWithReference::Content>]
+        #     The content of the message, applicable for `message` items.
         #
-        #   @param object [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Object] Identifier for the API object being returned - always `realtime.item`.
+        #     - Message items of role `system` support only `input_text` content
+        #     - Message items of role `user` support `input_text` and `input_audio` content
+        #     - Message items of role `assistant` support `text` content.
         #
-        #   @param output [String] The output of the function call (for `function_call_output` items).
+        #   @param name [String]
+        #     The name of the function being called (for `function_call` items).
         #
-        #   @param role [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Role] The role of the message sender (`user`, `assistant`, `system`), only
+        #   @param object [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Object]
+        #     Identifier for the API object being returned - always `realtime.item`.
         #
-        #   @param status [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Status] The status of the item (`completed`, `incomplete`, `in_progress`). These have no
+        #   @param output [String]
+        #     The output of the function call (for `function_call_output` items).
         #
-        #   @param type [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Type] The type of the item (`message`, `function_call`, `function_call_output`,
-        #   `item\_
-
+        #   @param role [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Role]
+        #     The role of the message sender (`user`, `assistant`, `system`), only applicable
+        #     for `message` items.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Status]
+        #     The status of the item (`completed`, `incomplete`, `in_progress`). These have no
+        #     effect on the conversation, but are accepted for consistency with the
+        #     `conversation.item.created` event.
+        #
+        #   @param type [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Type]
+        #     The type of the item (`message`, `function_call`, `function_call_output`,
+        #     `item_reference`).
         class Content < OpenAI::Internal::Type::BaseModel
           # @!attribute id
           #   ID of a previous conversation item to reference (for `item_reference` content
@@ -143,19 +163,22 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Realtime::ConversationItemWithReference::Content::Type }
 
           # @!method initialize(id: nil, audio: nil, text: nil, transcript: nil, type: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::ConversationItemWithReference::Content} for more
-          #   details.
-          #
-          #   @param id [String] ID of a previous conversation item to reference (for `item_reference`
+          #   @param id [String]
+          #     ID of a previous conversation item to reference (for `item_reference` content
+          #     types in `response.create` events). These can reference both client and server
+          #     created items.
           #
-          #   @param audio [String] Base64-encoded audio bytes, used for `input_audio` content type.
+          #   @param audio [String]
+          #     Base64-encoded audio bytes, used for `input_audio` content type.
           #
-          #   @param text [String] The text content, used for `input_text` and `text` content types.
+          #   @param text [String]
+          #     The text content, used for `input_text` and `text` content types.
           #
-          #   @param transcript [String] The transcript of the audio, used for `input_audio` content type.
+          #   @param transcript [String]
+          #     The transcript of the audio, used for `input_audio` content type.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Content::Type] The content type (`input_text`, `input_audio`, `item_reference`, `text`).
+          #   @param type [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Content::Type]
+          #     The content type (`input_text`, `input_audio`, `item_reference`, `text`).
 
           # The content type (`input_text`, `input_audio`, `item_reference`, `text`).
           #

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

@@ -24,9 +24,6 @@ module OpenAI
         optional :event_id, String
 
         # @!method initialize(audio:, event_id: nil, type: :"input_audio_buffer.append")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferAppendEvent} for more details.
-        #
         #   Send this event to append audio bytes to the input audio buffer. The audio
         #   buffer is temporary storage you can write to and later commit. A "commit" will
         #   create a new user message item in the conversation history from the buffer
@@ -43,11 +40,15 @@ module OpenAI
         #   to be more responsive. Unlike most other client events, the server will not send
         #   a confirmation response to this event.
         #
-        #   @param audio [String] Base64-encoded audio bytes. This must be in the format specified by the
+        #   @param audio [String]
+        #     Base64-encoded audio bytes. This must be in the format specified by the
+        #     `input_audio_format` field in the session configuration.
         #
-        #   @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, :"input_audio_buffer.append"] The event type, must be `input_audio_buffer.append`.
+        #   @param type [Symbol, :"input_audio_buffer.append"]
+        #     The event type, must be `input_audio_buffer.append`.
       end
     end
   end

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

@@ -20,9 +20,11 @@ module OpenAI
         #   Send this event to clear the audio bytes in the buffer. The server will respond
         #   with an `input_audio_buffer.cleared` event.
         #
-        #   @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, :"input_audio_buffer.clear"] The event type, must be `input_audio_buffer.clear`.
+        #   @param type [Symbol, :"input_audio_buffer.clear"]
+        #     The event type, must be `input_audio_buffer.clear`.
       end
     end
   end

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

@@ -20,9 +20,11 @@ module OpenAI
         #   Returned when the input audio buffer is cleared by the client with a
         #   `input_audio_buffer.clear` event.
         #
-        #   @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, :"input_audio_buffer.cleared"] The event type, must be `input_audio_buffer.cleared`.
+        #   @param type [Symbol, :"input_audio_buffer.cleared"]
+        #     The event type, must be `input_audio_buffer.cleared`.
       end
     end
   end

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

@@ -26,9 +26,11 @@ module OpenAI
         #   enabled in session configuration), but it will not create a response from the
         #   model. The server will respond with an `input_audio_buffer.committed` event.
         #
-        #   @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, :"input_audio_buffer.commit"] The event type, must be `input_audio_buffer.commit`.
+        #   @param type [Symbol, :"input_audio_buffer.commit"]
+        #     The event type, must be `input_audio_buffer.commit`.
       end
     end
   end

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

@@ -30,21 +30,23 @@ module OpenAI
         optional :previous_item_id, String, nil?: true
 
         # @!method initialize(event_id:, item_id:, previous_item_id: nil, type: :"input_audio_buffer.committed")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferCommittedEvent} for more details.
-        #
         #   Returned when an input audio buffer is committed, either by the client or
         #   automatically in server VAD mode. The `item_id` property is the ID of the user
         #   message item that will be created, thus a `conversation.item.created` event will
         #   also be sent to the client.
         #
-        #   @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 previous_item_id [String, nil] The ID of the preceding item after which the new item will be inserted.
+        #   @param previous_item_id [String, nil]
+        #     The ID of the preceding item after which the new item will be inserted. Can be
+        #     `null` if the item has no predecessor.
         #
-        #   @param type [Symbol, :"input_audio_buffer.committed"] The event type, must be `input_audio_buffer.committed`.
+        #   @param type [Symbol, :"input_audio_buffer.committed"]
+        #     The event type, must be `input_audio_buffer.committed`.
       end
     end
   end

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

@@ -23,20 +23,19 @@ module OpenAI
         required :type, const: :"input_audio_buffer.dtmf_event_received"
 
         # @!method initialize(event:, received_at:, type: :"input_audio_buffer.dtmf_event_received")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferDtmfEventReceivedEvent} for more
-        #   details.
-        #
         #   **SIP Only:** Returned when an DTMF event is received. A DTMF event is a message
         #   that represents a telephone keypad press (0–9, \*, #, A–D). The `event` property
         #   is the keypad that the user press. The `received_at` is the UTC Unix Timestamp
         #   that the server received the event.
         #
-        #   @param event [String] The telephone keypad that was pressed by the user.
+        #   @param event [String]
+        #     The telephone keypad that was pressed by the user.
         #
-        #   @param received_at [Integer] UTC Unix Timestamp when DTMF Event was received by server.
+        #   @param received_at [Integer]
+        #     UTC Unix Timestamp when DTMF Event was received by server.
         #
-        #   @param type [Symbol, :"input_audio_buffer.dtmf_event_received"] The event type, must be `input_audio_buffer.dtmf_event_received`.
+        #   @param type [Symbol, :"input_audio_buffer.dtmf_event_received"]
+        #     The event type, must be `input_audio_buffer.dtmf_event_received`.
       end
     end
   end

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

@@ -32,9 +32,6 @@ module OpenAI
         required :type, const: :"input_audio_buffer.speech_started"
 
         # @!method initialize(audio_start_ms:, event_id:, item_id:, type: :"input_audio_buffer.speech_started")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferSpeechStartedEvent} for more details.
-        #
         #   Sent by the server when in `server_vad` mode to indicate that speech has been
         #   detected in the audio buffer. This can happen any time audio is added to the
         #   buffer (unless speech is already detected). The client may want to use this
@@ -46,13 +43,20 @@ module OpenAI
         #   `input_audio_buffer.speech_stopped` event (unless the client manually commits
         #   the audio buffer during VAD activation).
         #
-        #   @param audio_start_ms [Integer] Milliseconds from the start of all audio written to the buffer during the
+        #   @param audio_start_ms [Integer]
+        #     Milliseconds from the start of all audio written to the buffer during the
+        #     session when speech was first detected. This will correspond to the beginning of
+        #     audio sent to the model, and thus includes the `prefix_padding_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 when speech stops.
+        #   @param item_id [String]
+        #     The ID of the user message item that will be created when speech stops.
         #
-        #   @param type [Symbol, :"input_audio_buffer.speech_started"] The event type, must be `input_audio_buffer.speech_started`.
+        #   @param type [Symbol, :"input_audio_buffer.speech_started"]
+        #     The event type, must be `input_audio_buffer.speech_started`.
       end
     end
   end