openai 0.19.0 → 0.21.0

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemDone < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item
+        #   A single item within a Realtime conversation.
+        #
+        #   @return [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]
+        required :item, union: -> { OpenAI::Realtime::ConversationItem }
+
+        # @!attribute type
+        #   The event type, must be `conversation.item.done`.
+        #
+        #   @return [Symbol, :"conversation.item.done"]
+        required :type, const: :"conversation.item.done"
+
+        # @!attribute previous_item_id
+        #   The ID of the item that precedes this one, if any. This is used to maintain
+        #   ordering when items are inserted.
+        #
+        #   @return [String, nil]
+        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.
+        #
+        #   @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 previous_item_id [String, nil] The ID of the item that precedes this one, if any. This is used to
+        #
+        #   @param type [Symbol, :"conversation.item.done"] The event type, must be `conversation.item.done`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemInputAudioTranscriptionCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the content part containing the audio.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the user message item containing the audio.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute transcript
+        #   The transcribed text.
+        #
+        #   @return [String]
+        required :transcript, String
+
+        # @!attribute type
+        #   The event type, must be `conversation.item.input_audio_transcription.completed`.
+        #
+        #   @return [Symbol, :"conversation.item.input_audio_transcription.completed"]
+        required :type, const: :"conversation.item.input_audio_transcription.completed"
+
+        # @!attribute usage
+        #   Usage statistics for the transcription.
+        #
+        #   @return [OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens, OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageDuration]
+        required :usage,
+                 union: -> { OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage }
+
+        # @!attribute logprobs
+        #   The log probabilities of the transcription.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::LogProbProperties>, nil]
+        optional :logprobs,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::LogProbProperties] },
+                 nil?: true
+
+        # @!method initialize(content_index:, event_id:, item_id:, transcript:, usage:, 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 (in `server_vad` mode). Transcription runs
+        #   asynchronously with Response creation, so this event may come before or after
+        #   the Response events.
+        #
+        #   Realtime API models accept audio natively, and thus input transcription is a
+        #   separate process run on a separate ASR (Automatic Speech Recognition) model. The
+        #   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 event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the user message item containing the audio.
+        #
+        #   @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.
+        #
+        #   @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
+
+        # Usage statistics for the transcription.
+        #
+        # @see OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent#usage
+        module Usage
+          extend OpenAI::Internal::Type::Union
+
+          # Usage statistics for models billed by token usage.
+          variant -> { OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens }
+
+          # Usage statistics for models billed by audio input duration.
+          variant -> { OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageDuration }
+
+          class TranscriptTextUsageTokens < OpenAI::Internal::Type::BaseModel
+            # @!attribute input_tokens
+            #   Number of input tokens billed for this request.
+            #
+            #   @return [Integer]
+            required :input_tokens, Integer
+
+            # @!attribute output_tokens
+            #   Number of output tokens generated.
+            #
+            #   @return [Integer]
+            required :output_tokens, Integer
+
+            # @!attribute total_tokens
+            #   Total number of tokens used (input + output).
+            #
+            #   @return [Integer]
+            required :total_tokens, Integer
+
+            # @!attribute type
+            #   The type of the usage object. Always `tokens` for this variant.
+            #
+            #   @return [Symbol, :tokens]
+            required :type, const: :tokens
+
+            # @!attribute input_token_details
+            #   Details about the input tokens billed for this request.
+            #
+            #   @return [OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails, nil]
+            optional :input_token_details,
+                     -> { OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails }
+
+            # @!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 output_tokens [Integer] Number of output tokens generated.
+            #
+            #   @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 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
+              # @!attribute audio_tokens
+              #   Number of audio tokens billed for this request.
+              #
+              #   @return [Integer, nil]
+              optional :audio_tokens, Integer
+
+              # @!attribute text_tokens
+              #   Number of text tokens billed for this request.
+              #
+              #   @return [Integer, nil]
+              optional :text_tokens, Integer
+
+              # @!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 text_tokens [Integer] Number of text tokens billed for this request.
+            end
+          end
+
+          class TranscriptTextUsageDuration < OpenAI::Internal::Type::BaseModel
+            # @!attribute seconds
+            #   Duration of the input audio in seconds.
+            #
+            #   @return [Float]
+            required :seconds, Float
+
+            # @!attribute type
+            #   The type of the usage object. Always `duration` for this variant.
+            #
+            #   @return [Symbol, :duration]
+            required :type, const: :duration
+
+            # @!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 type [Symbol, :duration] The type of the usage object. Always `duration` for this variant.
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens, OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageDuration)]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemInputAudioTranscriptionDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `conversation.item.input_audio_transcription.delta`.
+        #
+        #   @return [Symbol, :"conversation.item.input_audio_transcription.delta"]
+        required :type, const: :"conversation.item.input_audio_transcription.delta"
+
+        # @!attribute content_index
+        #   The index of the content part in the item's content array.
+        #
+        #   @return [Integer, nil]
+        optional :content_index, Integer
+
+        # @!attribute delta
+        #   The text delta.
+        #
+        #   @return [String, nil]
+        optional :delta, String
+
+        # @!attribute logprobs
+        #   The log probabilities of the transcription.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::LogProbProperties>, nil]
+        optional :logprobs,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::LogProbProperties] },
+                 nil?: true
+
+        # @!method initialize(event_id:, item_id:, content_index: nil, delta: nil, logprobs: nil, type: :"conversation.item.input_audio_transcription.delta")
+        #   Returned when the text value of an input audio transcription content part is
+        #   updated.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the item.
+        #
+        #   @param content_index [Integer] The index of the content part in the item's content array.
+        #
+        #   @param delta [String] The text delta.
+        #
+        #   @param logprobs [Array<OpenAI::Models::Realtime::LogProbProperties>, nil] The log probabilities of the transcription.
+        #
+        #   @param type [Symbol, :"conversation.item.input_audio_transcription.delta"] The event type, must be `conversation.item.input_audio_transcription.delta`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemInputAudioTranscriptionFailedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the content part containing the audio.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute error
+        #   Details of the transcription error.
+        #
+        #   @return [OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error]
+        required :error, -> { OpenAI::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error }
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the user message item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `conversation.item.input_audio_transcription.failed`.
+        #
+        #   @return [Symbol, :"conversation.item.input_audio_transcription.failed"]
+        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 error [OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error] Details of the transcription error.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @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
+
+        # @see OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionFailedEvent#error
+        class Error < OpenAI::Internal::Type::BaseModel
+          # @!attribute code
+          #   Error code, if any.
+          #
+          #   @return [String, nil]
+          optional :code, String
+
+          # @!attribute message
+          #   A human-readable error message.
+          #
+          #   @return [String, nil]
+          optional :message, String
+
+          # @!attribute param
+          #   Parameter related to the error, if any.
+          #
+          #   @return [String, nil]
+          optional :param, String
+
+          # @!attribute type
+          #   The type of error.
+          #
+          #   @return [String, nil]
+          optional :type, String
+
+          # @!method initialize(code: nil, message: nil, param: nil, type: nil)
+          #   Details of the transcription error.
+          #
+          #   @param code [String] Error code, if any.
+          #
+          #   @param message [String] A human-readable error message.
+          #
+          #   @param param [String] Parameter related to the error, if any.
+          #
+          #   @param type [String] The type of error.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemInputAudioTranscriptionSegment < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The segment identifier.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute content_index
+        #   The index of the input audio content part within the item.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute end_
+        #   End time of the segment in seconds.
+        #
+        #   @return [Float]
+        required :end_, Float, api_name: :end
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the item containing the input audio content.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute speaker
+        #   The detected speaker label for this segment.
+        #
+        #   @return [String]
+        required :speaker, String
+
+        # @!attribute start
+        #   Start time of the segment in seconds.
+        #
+        #   @return [Float]
+        required :start, Float
+
+        # @!attribute text
+        #   The text for this segment.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #   The event type, must be `conversation.item.input_audio_transcription.segment`.
+        #
+        #   @return [Symbol, :"conversation.item.input_audio_transcription.segment"]
+        required :type, const: :"conversation.item.input_audio_transcription.segment"
+
+        # @!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 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 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 speaker [String] The detected speaker label for this segment.
+        #
+        #   @param start [Float] Start time of the segment in seconds.
+        #
+        #   @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`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemRetrieveEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the item to retrieve.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `conversation.item.retrieve`.
+        #
+        #   @return [Symbol, :"conversation.item.retrieve"]
+        required :type, const: :"conversation.item.retrieve"
+
+        # @!attribute event_id
+        #   Optional client-generated ID used to identify this event.
+        #
+        #   @return [String, nil]
+        optional :event_id, String
+
+        # @!method initialize(item_id:, event_id: nil, type: :"conversation.item.retrieve")
+        #   Send this event when you want to retrieve the server's representation of a
+        #   specific item in the conversation history. This is useful, for example, to
+        #   inspect user audio after noise cancellation and VAD. The server will respond
+        #   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 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`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemTruncateEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute audio_end_ms
+        #   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.
+        #
+        #   @return [Integer]
+        required :audio_end_ms, Integer
+
+        # @!attribute content_index
+        #   The index of the content part to truncate. Set this to 0.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute item_id
+        #   The ID of the assistant message item to truncate. Only assistant message items
+        #   can be truncated.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `conversation.item.truncate`.
+        #
+        #   @return [Symbol, :"conversation.item.truncate"]
+        required :type, const: :"conversation.item.truncate"
+
+        # @!attribute event_id
+        #   Optional client-generated ID used to identify this event.
+        #
+        #   @return [String, nil]
+        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
+        #   yet played. This will synchronize the server's understanding of the audio with
+        #   the client's playback.
+        #
+        #   Truncating audio will delete the server-side text transcript to ensure there is
+        #   not text in the context that hasn't been heard by the user.
+        #
+        #   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 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 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`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemTruncatedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute audio_end_ms
+        #   The duration up to which the audio was truncated, in milliseconds.
+        #
+        #   @return [Integer]
+        required :audio_end_ms, Integer
+
+        # @!attribute content_index
+        #   The index of the content part that was truncated.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the assistant message item that was truncated.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute type
+        #   The event type, must be `conversation.item.truncated`.
+        #
+        #   @return [Symbol, :"conversation.item.truncated"]
+        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.
+        #
+        #   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 content_index [Integer] The index of the content part that was truncated.
+        #
+        #   @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 type [Symbol, :"conversation.item.truncated"] The event type, must be `conversation.item.truncated`.
+      end
+    end
+  end
+end