openai 0.86.0 → 0.88.0

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

@@ -25,12 +25,15 @@ module OpenAI
         optional :session, union: -> { OpenAI::Realtime::ClientSecretCreateParams::Session }
 
         # @!method initialize(expires_after: nil, session: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ClientSecretCreateParams} for more details.
+        #   @param expires_after [OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter]
+        #     Configuration for the client secret expiration. Expiration refers to the time
+        #     after which a client secret will no longer be valid for creating sessions. The
+        #     session itself may continue after that time once started. A secret can be used
+        #     to create multiple sessions until it expires.
         #
-        #   @param expires_after [OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter] Configuration for the client secret expiration. Expiration refers to the time af
-        #
-        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest] Session configuration to use for the client secret. Choose either a realtime
+        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest]
+        #     Session configuration to use for the client secret. Choose either a realtime
+        #     session or a transcription session.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
@@ -52,18 +55,20 @@ module OpenAI
           optional :seconds, Integer
 
           # @!method initialize(anchor: nil, seconds: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter} for more
-          #   details.
-          #
           #   Configuration for the client secret expiration. Expiration refers to the time
           #   after which a client secret will no longer be valid for creating sessions. The
           #   session itself may continue after that time once started. A secret can be used
           #   to create multiple sessions until it expires.
           #
-          #   @param anchor [Symbol, OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter::Anchor] The anchor point for the client secret expiration, meaning that `seconds` will b
+          #   @param anchor [Symbol, OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter::Anchor]
+          #     The anchor point for the client secret expiration, meaning that `seconds` will
+          #     be added to the `created_at` time of the client secret to produce an expiration
+          #     timestamp. Only `created_at` is currently supported.
           #
-          #   @param seconds [Integer] The number of seconds from the anchor point to the expiration. Select a value be
+          #   @param seconds [Integer]
+          #     The number of seconds from the anchor point to the expiration. Select a value
+          #     between `10` and `7200` (2 hours). This default to 600 seconds (10 minutes) if
+          #     not specified.
 
           # The anchor point for the client secret expiration, meaning that `seconds` will
           # be added to the `created_at` time of the client secret to produce an expiration

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

@@ -24,16 +24,16 @@ module OpenAI
         required :value, String
 
         # @!method initialize(expires_at:, session:, value:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ClientSecretCreateResponse} for more details.
-        #
         #   Response from creating a 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::RealtimeSessionCreateResponse, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse] The session configuration for either a realtime or transcription session.
+        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateResponse, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse]
+        #     The session configuration for either a realtime or transcription session.
         #
-        #   @param value [String] The generated client secret value.
+        #   @param value [String]
+        #     The generated client secret value.
 
         # The session configuration for either a realtime or transcription session.
         #

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

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(conversation:, event_id:, type: :"conversation.created")
         #   Returned when a conversation is created. Emitted right after session creation.
         #
-        #   @param conversation [OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation] The conversation resource.
+        #   @param conversation [OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation]
+        #     The conversation resource.
         #
-        #   @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, :"conversation.created"] The event type, must be `conversation.created`.
+        #   @param type [Symbol, :"conversation.created"]
+        #     The event type, must be `conversation.created`.
 
         # @see OpenAI::Models::Realtime::ConversationCreatedEvent#conversation
         class Conversation < OpenAI::Internal::Type::BaseModel
@@ -48,9 +51,11 @@ module OpenAI
           # @!method initialize(id: nil, object: nil)
           #   The conversation resource.
           #
-          #   @param id [String] The unique ID of the conversation.
+          #   @param id [String]
+          #     The unique ID of the conversation.
           #
-          #   @param object [Symbol, OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation::Object] The object type, must be `realtime.conversation`.
+          #   @param object [Symbol, OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation::Object]
+          #     The object type, must be `realtime.conversation`.
 
           # The object type, must be `realtime.conversation`.
           #

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

@@ -30,9 +30,6 @@ module OpenAI
         optional :previous_item_id, String, nil?: true
 
         # @!method initialize(event_id:, item:, previous_item_id: nil, type: :"conversation.item.added")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemAdded} for more details.
-        #
         #   Sent by the server when an Item is added to the default Conversation. This can
         #   happen in several cases:
         #
@@ -48,13 +45,18 @@ module OpenAI
         #   generating a Response) except for audio data, which can be retrieved separately
         #   with a `conversation.item.retrieve` event if necessary.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest] A single item within a Realtime conversation.
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #     A single item within a Realtime conversation.
         #
-        #   @param previous_item_id [String, nil] The ID of the item that precedes this one, if any. This is used to
+        #   @param previous_item_id [String, nil]
+        #     The ID of the item that precedes this one, if any. This is used to maintain
+        #     ordering when items are inserted.
         #
-        #   @param type [Symbol, :"conversation.item.added"] The event type, must be `conversation.item.added`.
+        #   @param type [Symbol, :"conversation.item.added"]
+        #     The event type, must be `conversation.item.added`.
       end
     end
   end

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

@@ -37,9 +37,6 @@ module OpenAI
         optional :previous_item_id, String
 
         # @!method initialize(item:, event_id: nil, previous_item_id: nil, type: :"conversation.item.create")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemCreateEvent} for more details.
-        #
         #   Add a new Item to the Conversation's context, including messages, function
         #   calls, and function call responses. This event can be used both to populate a
         #   "history" of the conversation and to add new items mid-stream, but has the
@@ -48,13 +45,25 @@ module OpenAI
         #   If successful, the server will respond with a `conversation.item.created` event,
         #   otherwise an `error` event will be sent.
         #
-        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest] A single item within a Realtime conversation.
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #     A single item within a Realtime conversation.
+        #
+        #   @param event_id [String]
+        #     Optional client-generated ID used to identify this event.
+        #
+        #   @param previous_item_id [String]
+        #     The ID of the preceding item after which the new item will be inserted. If not
+        #     set, the new item will be appended to the end of the conversation.
         #
-        #   @param event_id [String] Optional client-generated ID used to identify this event.
+        #     If set to `root`, the new item will be added to the beginning of the
+        #     conversation.
         #
-        #   @param previous_item_id [String] The ID of the preceding item after which the new item will be inserted. If not s
+        #     If set to an existing ID, it allows an item to be inserted mid-conversation. If
+        #     the ID cannot be found, an error will be returned and the item will not be
+        #     added.
         #
-        #   @param type [Symbol, :"conversation.item.create"] The event type, must be `conversation.item.create`.
+        #   @param type [Symbol, :"conversation.item.create"]
+        #     The event type, must be `conversation.item.create`.
       end
     end
   end

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

@@ -31,9 +31,6 @@ module OpenAI
         optional :previous_item_id, String, nil?: true
 
         # @!method initialize(event_id:, item:, previous_item_id: nil, type: :"conversation.item.created")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemCreatedEvent} for more details.
-        #
         #   Returned when a conversation item is created. There are several scenarios that
         #   produce this event:
         #
@@ -46,13 +43,19 @@ module OpenAI
         #   - The client has sent a `conversation.item.create` event to add a new Item to
         #     the Conversation.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest] A single item within a Realtime conversation.
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #     A single item within a Realtime conversation.
         #
-        #   @param previous_item_id [String, nil] The ID of the preceding item in the Conversation context, allows the
+        #   @param previous_item_id [String, nil]
+        #     The ID of the preceding item in the Conversation context, allows the client to
+        #     understand the order of the conversation. Can be `null` if the item has no
+        #     predecessor.
         #
-        #   @param type [Symbol, :"conversation.item.created"] The event type, must be `conversation.item.created`.
+        #   @param type [Symbol, :"conversation.item.created"]
+        #     The event type, must be `conversation.item.created`.
       end
     end
   end

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

@@ -28,11 +28,14 @@ module OpenAI
         #   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 delete.
+        #   @param item_id [String]
+        #     The ID of the item to delete.
         #
-        #   @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.delete"] The event type, must be `conversation.item.delete`.
+        #   @param type [Symbol, :"conversation.item.delete"]
+        #     The event type, must be `conversation.item.delete`.
       end
     end
   end

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

@@ -27,11 +27,14 @@ module OpenAI
         #   `conversation.item.delete` event. This event is used to synchronize the server's
         #   understanding of the conversation history with the client's view.
         #
-        #   @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 that was deleted.
+        #   @param item_id [String]
+        #     The ID of the item that was deleted.
         #
-        #   @param type [Symbol, :"conversation.item.deleted"] The event type, must be `conversation.item.deleted`.
+        #   @param type [Symbol, :"conversation.item.deleted"]
+        #     The event type, must be `conversation.item.deleted`.
       end
     end
   end

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

@@ -30,21 +30,23 @@ module OpenAI
         optional :previous_item_id, String, nil?: true
 
         # @!method initialize(event_id:, item:, previous_item_id: nil, type: :"conversation.item.done")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemDone} for more details.
-        #
         #   Returned when a conversation item is finalized.
         #
         #   The event will include the full content of the Item except for audio data, which
         #   can be retrieved separately with a `conversation.item.retrieve` event if needed.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest] A single item within a Realtime conversation.
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #     A single item within a Realtime conversation.
         #
-        #   @param previous_item_id [String, nil] The ID of the item that precedes this one, if any. This is used to
+        #   @param previous_item_id [String, nil]
+        #     The ID of the item that precedes this one, if any. This is used to maintain
+        #     ordering when items are inserted.
         #
-        #   @param type [Symbol, :"conversation.item.done"] The event type, must be `conversation.item.done`.
+        #   @param type [Symbol, :"conversation.item.done"]
+        #     The event type, must be `conversation.item.done`.
       end
     end
   end

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