openai 0.20.0 → 0.21.0

data/rbi/openai/models/realtime/realtime_truncation.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      # Controls how the realtime conversation is truncated prior to model inference.
+      # The default is `auto`. When set to `retention_ratio`, the server retains a
+      # fraction of the conversation tokens prior to the instructions.
+      module RealtimeTruncation
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeTruncation::RealtimeTruncationStrategy::TaggedSymbol,
+              OpenAI::Realtime::RealtimeTruncation::RetentionRatioTruncation
+            )
+          end
+
+        # The truncation strategy to use for the session.
+        module RealtimeTruncationStrategy
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Realtime::RealtimeTruncation::RealtimeTruncationStrategy
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AUTO =
+            T.let(
+              :auto,
+              OpenAI::Realtime::RealtimeTruncation::RealtimeTruncationStrategy::TaggedSymbol
+            )
+          DISABLED =
+            T.let(
+              :disabled,
+              OpenAI::Realtime::RealtimeTruncation::RealtimeTruncationStrategy::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Realtime::RealtimeTruncation::RealtimeTruncationStrategy::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class RetentionRatioTruncation < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Realtime::RealtimeTruncation::RetentionRatioTruncation,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Fraction of pre-instruction conversation tokens to retain (0.0 - 1.0).
+          sig { returns(Float) }
+          attr_accessor :retention_ratio
+
+          # Use retention ratio truncation.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Optional cap on tokens allowed after the instructions.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :post_instructions_token_limit
+
+          # Retain a fraction of the conversation tokens.
+          sig do
+            params(
+              retention_ratio: Float,
+              post_instructions_token_limit: T.nilable(Integer),
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Fraction of pre-instruction conversation tokens to retain (0.0 - 1.0).
+            retention_ratio:,
+            # Optional cap on tokens allowed after the instructions.
+            post_instructions_token_limit: nil,
+            # Use retention ratio truncation.
+            type: :retention_ratio
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                retention_ratio: Float,
+                type: Symbol,
+                post_instructions_token_limit: T.nilable(Integer)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::Realtime::RealtimeTruncation::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/response_audio_delta_event.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseAudioDeltaEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ResponseAudioDeltaEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The index of the content part in the item's content array.
+        sig { returns(Integer) }
+        attr_accessor :content_index
+
+        # Base64-encoded audio data delta.
+        sig { returns(String) }
+        attr_accessor :delta
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The ID of the item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item in the response.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The ID of the response.
+        sig { returns(String) }
+        attr_accessor :response_id
+
+        # The event type, must be `response.output_audio.delta`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when the model-generated audio is updated.
+        sig do
+          params(
+            content_index: Integer,
+            delta: String,
+            event_id: String,
+            item_id: String,
+            output_index: Integer,
+            response_id: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The index of the content part in the item's content array.
+          content_index:,
+          # Base64-encoded audio data delta.
+          delta:,
+          # The unique ID of the server event.
+          event_id:,
+          # The ID of the item.
+          item_id:,
+          # The index of the output item in the response.
+          output_index:,
+          # The ID of the response.
+          response_id:,
+          # The event type, must be `response.output_audio.delta`.
+          type: :"response.output_audio.delta"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              content_index: Integer,
+              delta: String,
+              event_id: String,
+              item_id: String,
+              output_index: Integer,
+              response_id: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/response_audio_done_event.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseAudioDoneEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ResponseAudioDoneEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The index of the content part in the item's content array.
+        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 item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item in the response.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The ID of the response.
+        sig { returns(String) }
+        attr_accessor :response_id
+
+        # The event type, must be `response.output_audio.done`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when the model-generated audio is done. Also emitted when a Response is
+        # interrupted, incomplete, or cancelled.
+        sig do
+          params(
+            content_index: Integer,
+            event_id: String,
+            item_id: String,
+            output_index: Integer,
+            response_id: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The index of the content part in the item's content array.
+          content_index:,
+          # The unique ID of the server event.
+          event_id:,
+          # The ID of the item.
+          item_id:,
+          # The index of the output item in the response.
+          output_index:,
+          # The ID of the response.
+          response_id:,
+          # The event type, must be `response.output_audio.done`.
+          type: :"response.output_audio.done"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              content_index: Integer,
+              event_id: String,
+              item_id: String,
+              output_index: Integer,
+              response_id: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/response_audio_transcript_delta_event.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseAudioTranscriptDeltaEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ResponseAudioTranscriptDeltaEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The index of the content part in the item's content array.
+        sig { returns(Integer) }
+        attr_accessor :content_index
+
+        # The transcript delta.
+        sig { returns(String) }
+        attr_accessor :delta
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The ID of the item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item in the response.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The ID of the response.
+        sig { returns(String) }
+        attr_accessor :response_id
+
+        # The event type, must be `response.output_audio_transcript.delta`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when the model-generated transcription of audio output is updated.
+        sig do
+          params(
+            content_index: Integer,
+            delta: String,
+            event_id: String,
+            item_id: String,
+            output_index: Integer,
+            response_id: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The index of the content part in the item's content array.
+          content_index:,
+          # The transcript delta.
+          delta:,
+          # The unique ID of the server event.
+          event_id:,
+          # The ID of the item.
+          item_id:,
+          # The index of the output item in the response.
+          output_index:,
+          # The ID of the response.
+          response_id:,
+          # The event type, must be `response.output_audio_transcript.delta`.
+          type: :"response.output_audio_transcript.delta"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              content_index: Integer,
+              delta: String,
+              event_id: String,
+              item_id: String,
+              output_index: Integer,
+              response_id: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/response_audio_transcript_done_event.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseAudioTranscriptDoneEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ResponseAudioTranscriptDoneEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The index of the content part in the item's content array.
+        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 item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item in the response.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The ID of the response.
+        sig { returns(String) }
+        attr_accessor :response_id
+
+        # The final transcript of the audio.
+        sig { returns(String) }
+        attr_accessor :transcript
+
+        # The event type, must be `response.output_audio_transcript.done`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when the model-generated transcription of audio output is done
+        # streaming. Also emitted when a Response is interrupted, incomplete, or
+        # cancelled.
+        sig do
+          params(
+            content_index: Integer,
+            event_id: String,
+            item_id: String,
+            output_index: Integer,
+            response_id: String,
+            transcript: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The index of the content part in the item's content array.
+          content_index:,
+          # The unique ID of the server event.
+          event_id:,
+          # The ID of the item.
+          item_id:,
+          # The index of the output item in the response.
+          output_index:,
+          # The ID of the response.
+          response_id:,
+          # The final transcript of the audio.
+          transcript:,
+          # The event type, must be `response.output_audio_transcript.done`.
+          type: :"response.output_audio_transcript.done"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              content_index: Integer,
+              event_id: String,
+              item_id: String,
+              output_index: Integer,
+              response_id: String,
+              transcript: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/response_cancel_event.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseCancelEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ResponseCancelEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The event type, must be `response.cancel`.
+        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
+
+        # A specific response ID to cancel - if not provided, will cancel an in-progress
+        # response in the default conversation.
+        sig { returns(T.nilable(String)) }
+        attr_reader :response_id
+
+        sig { params(response_id: String).void }
+        attr_writer :response_id
+
+        # Send this event to cancel an in-progress response. The server will respond with
+        # a `response.done` event with a status of `response.status=cancelled`. If there
+        # is no response to cancel, the server will respond with an error.
+        sig do
+          params(event_id: String, response_id: String, type: Symbol).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Optional client-generated ID used to identify this event.
+          event_id: nil,
+          # A specific response ID to cancel - if not provided, will cancel an in-progress
+          # response in the default conversation.
+          response_id: nil,
+          # The event type, must be `response.cancel`.
+          type: :"response.cancel"
+        )
+        end
+
+        sig do
+          override.returns(
+            { type: Symbol, event_id: String, response_id: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end