openai 0.20.0 → 0.21.0

data/rbi/openai/models/realtime/conversation_item_input_audio_transcription_segment.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemInputAudioTranscriptionSegment < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationItemInputAudioTranscriptionSegment,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The segment identifier.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The index of the input audio content part within the item.
+        sig { returns(Integer) }
+        attr_accessor :content_index
+
+        # End time of the segment in seconds.
+        sig { returns(Float) }
+        attr_accessor :end_
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The ID of the item containing the input audio content.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The detected speaker label for this segment.
+        sig { returns(String) }
+        attr_accessor :speaker
+
+        # Start time of the segment in seconds.
+        sig { returns(Float) }
+        attr_accessor :start
+
+        # The text for this segment.
+        sig { returns(String) }
+        attr_accessor :text
+
+        # The event type, must be `conversation.item.input_audio_transcription.segment`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when an input audio transcription segment is identified for an item.
+        sig do
+          params(
+            id: String,
+            content_index: Integer,
+            end_: Float,
+            event_id: String,
+            item_id: String,
+            speaker: String,
+            start: Float,
+            text: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The segment identifier.
+          id:,
+          # The index of the input audio content part within the item.
+          content_index:,
+          # End time of the segment in seconds.
+          end_:,
+          # The unique ID of the server event.
+          event_id:,
+          # The ID of the item containing the input audio content.
+          item_id:,
+          # The detected speaker label for this segment.
+          speaker:,
+          # Start time of the segment in seconds.
+          start:,
+          # The text for this segment.
+          text:,
+          # The event type, must be `conversation.item.input_audio_transcription.segment`.
+          type: :"conversation.item.input_audio_transcription.segment"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              content_index: Integer,
+              end_: Float,
+              event_id: String,
+              item_id: String,
+              speaker: String,
+              start: Float,
+              text: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/conversation_item_retrieve_event.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemRetrieveEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationItemRetrieveEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The ID of the item to retrieve.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The event type, must be `conversation.item.retrieve`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Optional client-generated ID used to identify this event.
+        sig { returns(T.nilable(String)) }
+        attr_reader :event_id
+
+        sig { params(event_id: String).void }
+        attr_writer :event_id
+
+        # 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.
+        sig do
+          params(item_id: String, event_id: String, type: Symbol).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The ID of the item to retrieve.
+          item_id:,
+          # Optional client-generated ID used to identify this event.
+          event_id: nil,
+          # The event type, must be `conversation.item.retrieve`.
+          type: :"conversation.item.retrieve"
+        )
+        end
+
+        sig do
+          override.returns({ item_id: String, type: Symbol, event_id: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/conversation_item_truncate_event.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemTruncateEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationItemTruncateEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # 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.
+        sig { returns(Integer) }
+        attr_accessor :audio_end_ms
+
+        # The index of the content part to truncate. Set this to 0.
+        sig { returns(Integer) }
+        attr_accessor :content_index
+
+        # The ID of the assistant message item to truncate. Only assistant message items
+        # can be truncated.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The event type, must be `conversation.item.truncate`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Optional client-generated ID used to identify this event.
+        sig { returns(T.nilable(String)) }
+        attr_reader :event_id
+
+        sig { params(event_id: String).void }
+        attr_writer :event_id
+
+        # 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.
+        sig do
+          params(
+            audio_end_ms: Integer,
+            content_index: Integer,
+            item_id: String,
+            event_id: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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.
+          audio_end_ms:,
+          # The index of the content part to truncate. Set this to 0.
+          content_index:,
+          # The ID of the assistant message item to truncate. Only assistant message items
+          # can be truncated.
+          item_id:,
+          # Optional client-generated ID used to identify this event.
+          event_id: nil,
+          # The event type, must be `conversation.item.truncate`.
+          type: :"conversation.item.truncate"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              audio_end_ms: Integer,
+              content_index: Integer,
+              item_id: String,
+              type: Symbol,
+              event_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/conversation_item_truncated_event.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemTruncatedEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationItemTruncatedEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The duration up to which the audio was truncated, in milliseconds.
+        sig { returns(Integer) }
+        attr_accessor :audio_end_ms
+
+        # The index of the content part that was truncated.
+        sig { returns(Integer) }
+        attr_accessor :content_index
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The ID of the assistant message item that was truncated.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The event type, must be `conversation.item.truncated`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # 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.
+        sig do
+          params(
+            audio_end_ms: Integer,
+            content_index: Integer,
+            event_id: String,
+            item_id: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The duration up to which the audio was truncated, in milliseconds.
+          audio_end_ms:,
+          # The index of the content part that was truncated.
+          content_index:,
+          # The unique ID of the server event.
+          event_id:,
+          # The ID of the assistant message item that was truncated.
+          item_id:,
+          # The event type, must be `conversation.item.truncated`.
+          type: :"conversation.item.truncated"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              audio_end_ms: Integer,
+              content_index: Integer,
+              event_id: String,
+              item_id: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end