openai 0.20.0 → 0.21.0

data/sig/openai/models/realtime/realtime_response.rbs

@@ -0,0 +1,210 @@
+module OpenAI
+  module Models
+    module Realtime
+      type realtime_response =
+        {
+          id: String,
+          conversation_id: String,
+          max_output_tokens: OpenAI::Models::Realtime::RealtimeResponse::max_output_tokens,
+          metadata: OpenAI::Models::metadata?,
+          modalities: ::Array[OpenAI::Models::Realtime::RealtimeResponse::modality],
+          object: OpenAI::Models::Realtime::RealtimeResponse::object,
+          output: ::Array[OpenAI::Models::Realtime::conversation_item],
+          output_audio_format: OpenAI::Models::Realtime::RealtimeResponse::output_audio_format,
+          status: OpenAI::Models::Realtime::RealtimeResponse::status,
+          status_details: OpenAI::Realtime::RealtimeResponseStatus,
+          temperature: Float,
+          usage: OpenAI::Realtime::RealtimeResponseUsage,
+          voice: OpenAI::Models::Realtime::RealtimeResponse::voice
+        }
+
+      class RealtimeResponse < OpenAI::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader conversation_id: String?
+
+        def conversation_id=: (String) -> String
+
+        attr_reader max_output_tokens: OpenAI::Models::Realtime::RealtimeResponse::max_output_tokens?
+
+        def max_output_tokens=: (
+          OpenAI::Models::Realtime::RealtimeResponse::max_output_tokens
+        ) -> OpenAI::Models::Realtime::RealtimeResponse::max_output_tokens
+
+        attr_accessor metadata: OpenAI::Models::metadata?
+
+        attr_reader modalities: ::Array[OpenAI::Models::Realtime::RealtimeResponse::modality]?
+
+        def modalities=: (
+          ::Array[OpenAI::Models::Realtime::RealtimeResponse::modality]
+        ) -> ::Array[OpenAI::Models::Realtime::RealtimeResponse::modality]
+
+        attr_reader object: OpenAI::Models::Realtime::RealtimeResponse::object?
+
+        def object=: (
+          OpenAI::Models::Realtime::RealtimeResponse::object
+        ) -> OpenAI::Models::Realtime::RealtimeResponse::object
+
+        attr_reader output: ::Array[OpenAI::Models::Realtime::conversation_item]?
+
+        def output=: (
+          ::Array[OpenAI::Models::Realtime::conversation_item]
+        ) -> ::Array[OpenAI::Models::Realtime::conversation_item]
+
+        attr_reader output_audio_format: OpenAI::Models::Realtime::RealtimeResponse::output_audio_format?
+
+        def output_audio_format=: (
+          OpenAI::Models::Realtime::RealtimeResponse::output_audio_format
+        ) -> OpenAI::Models::Realtime::RealtimeResponse::output_audio_format
+
+        attr_reader status: OpenAI::Models::Realtime::RealtimeResponse::status?
+
+        def status=: (
+          OpenAI::Models::Realtime::RealtimeResponse::status
+        ) -> OpenAI::Models::Realtime::RealtimeResponse::status
+
+        attr_reader status_details: OpenAI::Realtime::RealtimeResponseStatus?
+
+        def status_details=: (
+          OpenAI::Realtime::RealtimeResponseStatus
+        ) -> OpenAI::Realtime::RealtimeResponseStatus
+
+        attr_reader temperature: Float?
+
+        def temperature=: (Float) -> Float
+
+        attr_reader usage: OpenAI::Realtime::RealtimeResponseUsage?
+
+        def usage=: (
+          OpenAI::Realtime::RealtimeResponseUsage
+        ) -> OpenAI::Realtime::RealtimeResponseUsage
+
+        attr_reader voice: OpenAI::Models::Realtime::RealtimeResponse::voice?
+
+        def voice=: (
+          OpenAI::Models::Realtime::RealtimeResponse::voice
+        ) -> OpenAI::Models::Realtime::RealtimeResponse::voice
+
+        def initialize: (
+          ?id: String,
+          ?conversation_id: String,
+          ?max_output_tokens: OpenAI::Models::Realtime::RealtimeResponse::max_output_tokens,
+          ?metadata: OpenAI::Models::metadata?,
+          ?modalities: ::Array[OpenAI::Models::Realtime::RealtimeResponse::modality],
+          ?object: OpenAI::Models::Realtime::RealtimeResponse::object,
+          ?output: ::Array[OpenAI::Models::Realtime::conversation_item],
+          ?output_audio_format: OpenAI::Models::Realtime::RealtimeResponse::output_audio_format,
+          ?status: OpenAI::Models::Realtime::RealtimeResponse::status,
+          ?status_details: OpenAI::Realtime::RealtimeResponseStatus,
+          ?temperature: Float,
+          ?usage: OpenAI::Realtime::RealtimeResponseUsage,
+          ?voice: OpenAI::Models::Realtime::RealtimeResponse::voice
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          conversation_id: String,
+          max_output_tokens: OpenAI::Models::Realtime::RealtimeResponse::max_output_tokens,
+          metadata: OpenAI::Models::metadata?,
+          modalities: ::Array[OpenAI::Models::Realtime::RealtimeResponse::modality],
+          object: OpenAI::Models::Realtime::RealtimeResponse::object,
+          output: ::Array[OpenAI::Models::Realtime::conversation_item],
+          output_audio_format: OpenAI::Models::Realtime::RealtimeResponse::output_audio_format,
+          status: OpenAI::Models::Realtime::RealtimeResponse::status,
+          status_details: OpenAI::Realtime::RealtimeResponseStatus,
+          temperature: Float,
+          usage: OpenAI::Realtime::RealtimeResponseUsage,
+          voice: OpenAI::Models::Realtime::RealtimeResponse::voice
+        }
+
+        type max_output_tokens = Integer | :inf
+
+        module MaxOutputTokens
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::Realtime::RealtimeResponse::max_output_tokens]
+        end
+
+        type modality = :text | :audio
+
+        module Modality
+          extend OpenAI::Internal::Type::Enum
+
+          TEXT: :text
+          AUDIO: :audio
+
+          def self?.values: -> ::Array[OpenAI::Models::Realtime::RealtimeResponse::modality]
+        end
+
+        type object = :"realtime.response"
+
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_RESPONSE: :"realtime.response"
+
+          def self?.values: -> ::Array[OpenAI::Models::Realtime::RealtimeResponse::object]
+        end
+
+        type output_audio_format = :pcm16 | :g711_ulaw | :g711_alaw
+
+        module OutputAudioFormat
+          extend OpenAI::Internal::Type::Enum
+
+          PCM16: :pcm16
+          G711_ULAW: :g711_ulaw
+          G711_ALAW: :g711_alaw
+
+          def self?.values: -> ::Array[OpenAI::Models::Realtime::RealtimeResponse::output_audio_format]
+        end
+
+        type status =
+          :completed | :cancelled | :failed | :incomplete | :in_progress
+
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED: :completed
+          CANCELLED: :cancelled
+          FAILED: :failed
+          INCOMPLETE: :incomplete
+          IN_PROGRESS: :in_progress
+
+          def self?.values: -> ::Array[OpenAI::Models::Realtime::RealtimeResponse::status]
+        end
+
+        type voice =
+          String
+          | :alloy
+          | :ash
+          | :ballad
+          | :coral
+          | :echo
+          | :sage
+          | :shimmer
+          | :verse
+          | :marin
+          | :cedar
+
+        module Voice
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::Realtime::RealtimeResponse::voice]
+
+          ALLOY: :alloy
+          ASH: :ash
+          BALLAD: :ballad
+          CORAL: :coral
+          ECHO: :echo
+          SAGE: :sage
+          SHIMMER: :shimmer
+          VERSE: :verse
+          MARIN: :marin
+          CEDAR: :cedar
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/realtime/realtime_response_status.rbs

@@ -0,0 +1,90 @@
+module OpenAI
+  module Models
+    module Realtime
+      type realtime_response_status =
+        {
+          error: OpenAI::Realtime::RealtimeResponseStatus::Error,
+          reason: OpenAI::Models::Realtime::RealtimeResponseStatus::reason,
+          type: OpenAI::Models::Realtime::RealtimeResponseStatus::type_
+        }
+
+      class RealtimeResponseStatus < OpenAI::Internal::Type::BaseModel
+        attr_reader error: OpenAI::Realtime::RealtimeResponseStatus::Error?
+
+        def error=: (
+          OpenAI::Realtime::RealtimeResponseStatus::Error
+        ) -> OpenAI::Realtime::RealtimeResponseStatus::Error
+
+        attr_reader reason: OpenAI::Models::Realtime::RealtimeResponseStatus::reason?
+
+        def reason=: (
+          OpenAI::Models::Realtime::RealtimeResponseStatus::reason
+        ) -> OpenAI::Models::Realtime::RealtimeResponseStatus::reason
+
+        attr_reader type: OpenAI::Models::Realtime::RealtimeResponseStatus::type_?
+
+        def type=: (
+          OpenAI::Models::Realtime::RealtimeResponseStatus::type_
+        ) -> OpenAI::Models::Realtime::RealtimeResponseStatus::type_
+
+        def initialize: (
+          ?error: OpenAI::Realtime::RealtimeResponseStatus::Error,
+          ?reason: OpenAI::Models::Realtime::RealtimeResponseStatus::reason,
+          ?type: OpenAI::Models::Realtime::RealtimeResponseStatus::type_
+        ) -> void
+
+        def to_hash: -> {
+          error: OpenAI::Realtime::RealtimeResponseStatus::Error,
+          reason: OpenAI::Models::Realtime::RealtimeResponseStatus::reason,
+          type: OpenAI::Models::Realtime::RealtimeResponseStatus::type_
+        }
+
+        type error = { code: String, type: String }
+
+        class Error < OpenAI::Internal::Type::BaseModel
+          attr_reader code: String?
+
+          def code=: (String) -> String
+
+          attr_reader type: String?
+
+          def type=: (String) -> String
+
+          def initialize: (?code: String, ?type: String) -> void
+
+          def to_hash: -> { code: String, type: String }
+        end
+
+        type reason =
+          :turn_detected
+          | :client_cancelled
+          | :max_output_tokens
+          | :content_filter
+
+        module Reason
+          extend OpenAI::Internal::Type::Enum
+
+          TURN_DETECTED: :turn_detected
+          CLIENT_CANCELLED: :client_cancelled
+          MAX_OUTPUT_TOKENS: :max_output_tokens
+          CONTENT_FILTER: :content_filter
+
+          def self?.values: -> ::Array[OpenAI::Models::Realtime::RealtimeResponseStatus::reason]
+        end
+
+        type type_ = :completed | :cancelled | :incomplete | :failed
+
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED: :completed
+          CANCELLED: :cancelled
+          INCOMPLETE: :incomplete
+          FAILED: :failed
+
+          def self?.values: -> ::Array[OpenAI::Models::Realtime::RealtimeResponseStatus::type_]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/realtime/realtime_response_usage.rbs

@@ -0,0 +1,56 @@
+module OpenAI
+  module Models
+    module Realtime
+      type realtime_response_usage =
+        {
+          input_token_details: OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails,
+          input_tokens: Integer,
+          output_token_details: OpenAI::Realtime::RealtimeResponseUsageOutputTokenDetails,
+          output_tokens: Integer,
+          total_tokens: Integer
+        }
+
+      class RealtimeResponseUsage < OpenAI::Internal::Type::BaseModel
+        attr_reader input_token_details: OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails?
+
+        def input_token_details=: (
+          OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails
+        ) -> OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails
+
+        attr_reader input_tokens: Integer?
+
+        def input_tokens=: (Integer) -> Integer
+
+        attr_reader output_token_details: OpenAI::Realtime::RealtimeResponseUsageOutputTokenDetails?
+
+        def output_token_details=: (
+          OpenAI::Realtime::RealtimeResponseUsageOutputTokenDetails
+        ) -> OpenAI::Realtime::RealtimeResponseUsageOutputTokenDetails
+
+        attr_reader output_tokens: Integer?
+
+        def output_tokens=: (Integer) -> Integer
+
+        attr_reader total_tokens: Integer?
+
+        def total_tokens=: (Integer) -> Integer
+
+        def initialize: (
+          ?input_token_details: OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails,
+          ?input_tokens: Integer,
+          ?output_token_details: OpenAI::Realtime::RealtimeResponseUsageOutputTokenDetails,
+          ?output_tokens: Integer,
+          ?total_tokens: Integer
+        ) -> void
+
+        def to_hash: -> {
+          input_token_details: OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails,
+          input_tokens: Integer,
+          output_token_details: OpenAI::Realtime::RealtimeResponseUsageOutputTokenDetails,
+          output_tokens: Integer,
+          total_tokens: Integer
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/realtime/realtime_response_usage_input_token_details.rbs

@@ -0,0 +1,34 @@
+module OpenAI
+  module Models
+    module Realtime
+      type realtime_response_usage_input_token_details =
+        { audio_tokens: Integer, cached_tokens: Integer, text_tokens: Integer }
+
+      class RealtimeResponseUsageInputTokenDetails < OpenAI::Internal::Type::BaseModel
+        attr_reader audio_tokens: Integer?
+
+        def audio_tokens=: (Integer) -> Integer
+
+        attr_reader cached_tokens: Integer?
+
+        def cached_tokens=: (Integer) -> Integer
+
+        attr_reader text_tokens: Integer?
+
+        def text_tokens=: (Integer) -> Integer
+
+        def initialize: (
+          ?audio_tokens: Integer,
+          ?cached_tokens: Integer,
+          ?text_tokens: Integer
+        ) -> void
+
+        def to_hash: -> {
+          audio_tokens: Integer,
+          cached_tokens: Integer,
+          text_tokens: Integer
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/realtime/realtime_response_usage_output_token_details.rbs

@@ -0,0 +1,22 @@
+module OpenAI
+  module Models
+    module Realtime
+      type realtime_response_usage_output_token_details =
+        { audio_tokens: Integer, text_tokens: Integer }
+
+      class RealtimeResponseUsageOutputTokenDetails < OpenAI::Internal::Type::BaseModel
+        attr_reader audio_tokens: Integer?
+
+        def audio_tokens=: (Integer) -> Integer
+
+        attr_reader text_tokens: Integer?
+
+        def text_tokens=: (Integer) -> Integer
+
+        def initialize: (?audio_tokens: Integer, ?text_tokens: Integer) -> void
+
+        def to_hash: -> { audio_tokens: Integer, text_tokens: Integer }
+      end
+    end
+  end
+end

data/sig/openai/models/realtime/realtime_server_event.rbs

@@ -0,0 +1,168 @@
+module OpenAI
+  module Models
+    module Realtime
+      type realtime_server_event =
+        OpenAI::Realtime::ConversationCreatedEvent
+        | OpenAI::Realtime::ConversationItemCreatedEvent
+        | OpenAI::Realtime::ConversationItemDeletedEvent
+        | OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent
+        | OpenAI::Realtime::ConversationItemInputAudioTranscriptionDeltaEvent
+        | OpenAI::Realtime::ConversationItemInputAudioTranscriptionFailedEvent
+        | OpenAI::Realtime::RealtimeServerEvent::ConversationItemRetrieved
+        | OpenAI::Realtime::ConversationItemTruncatedEvent
+        | OpenAI::Realtime::RealtimeErrorEvent
+        | OpenAI::Realtime::InputAudioBufferClearedEvent
+        | OpenAI::Realtime::InputAudioBufferCommittedEvent
+        | OpenAI::Realtime::InputAudioBufferSpeechStartedEvent
+        | OpenAI::Realtime::InputAudioBufferSpeechStoppedEvent
+        | OpenAI::Realtime::RateLimitsUpdatedEvent
+        | OpenAI::Realtime::ResponseAudioDeltaEvent
+        | OpenAI::Realtime::ResponseAudioDoneEvent
+        | OpenAI::Realtime::ResponseAudioTranscriptDeltaEvent
+        | OpenAI::Realtime::ResponseAudioTranscriptDoneEvent
+        | OpenAI::Realtime::ResponseContentPartAddedEvent
+        | OpenAI::Realtime::ResponseContentPartDoneEvent
+        | OpenAI::Realtime::ResponseCreatedEvent
+        | OpenAI::Realtime::ResponseDoneEvent
+        | OpenAI::Realtime::ResponseFunctionCallArgumentsDeltaEvent
+        | OpenAI::Realtime::ResponseFunctionCallArgumentsDoneEvent
+        | OpenAI::Realtime::ResponseOutputItemAddedEvent
+        | OpenAI::Realtime::ResponseOutputItemDoneEvent
+        | OpenAI::Realtime::ResponseTextDeltaEvent
+        | OpenAI::Realtime::ResponseTextDoneEvent
+        | OpenAI::Realtime::SessionCreatedEvent
+        | OpenAI::Realtime::SessionUpdatedEvent
+        | OpenAI::Realtime::TranscriptionSessionUpdatedEvent
+        | OpenAI::Realtime::TranscriptionSessionCreated
+        | OpenAI::Realtime::RealtimeServerEvent::OutputAudioBufferStarted
+        | OpenAI::Realtime::RealtimeServerEvent::OutputAudioBufferStopped
+        | OpenAI::Realtime::RealtimeServerEvent::OutputAudioBufferCleared
+        | OpenAI::Realtime::ConversationItemAdded
+        | OpenAI::Realtime::ConversationItemDone
+        | OpenAI::Realtime::InputAudioBufferTimeoutTriggered
+        | OpenAI::Realtime::ConversationItemInputAudioTranscriptionSegment
+        | OpenAI::Realtime::McpListToolsInProgress
+        | OpenAI::Realtime::McpListToolsCompleted
+        | OpenAI::Realtime::McpListToolsFailed
+        | OpenAI::Realtime::ResponseMcpCallArgumentsDelta
+        | OpenAI::Realtime::ResponseMcpCallArgumentsDone
+        | OpenAI::Realtime::ResponseMcpCallInProgress
+        | OpenAI::Realtime::ResponseMcpCallCompleted
+        | OpenAI::Realtime::ResponseMcpCallFailed
+
+      module RealtimeServerEvent
+        extend OpenAI::Internal::Type::Union
+
+        type conversation_item_retrieved =
+          {
+            event_id: String,
+            item: OpenAI::Models::Realtime::conversation_item,
+            type: :"conversation.item.retrieved"
+          }
+
+        class ConversationItemRetrieved < OpenAI::Internal::Type::BaseModel
+          attr_accessor event_id: String
+
+          attr_accessor item: OpenAI::Models::Realtime::conversation_item
+
+          attr_accessor type: :"conversation.item.retrieved"
+
+          def initialize: (
+            event_id: String,
+            item: OpenAI::Models::Realtime::conversation_item,
+            ?type: :"conversation.item.retrieved"
+          ) -> void
+
+          def to_hash: -> {
+            event_id: String,
+            item: OpenAI::Models::Realtime::conversation_item,
+            type: :"conversation.item.retrieved"
+          }
+        end
+
+        type output_audio_buffer_started =
+          {
+            event_id: String,
+            response_id: String,
+            type: :"output_audio_buffer.started"
+          }
+
+        class OutputAudioBufferStarted < OpenAI::Internal::Type::BaseModel
+          attr_accessor event_id: String
+
+          attr_accessor response_id: String
+
+          attr_accessor type: :"output_audio_buffer.started"
+
+          def initialize: (
+            event_id: String,
+            response_id: String,
+            ?type: :"output_audio_buffer.started"
+          ) -> void
+
+          def to_hash: -> {
+            event_id: String,
+            response_id: String,
+            type: :"output_audio_buffer.started"
+          }
+        end
+
+        type output_audio_buffer_stopped =
+          {
+            event_id: String,
+            response_id: String,
+            type: :"output_audio_buffer.stopped"
+          }
+
+        class OutputAudioBufferStopped < OpenAI::Internal::Type::BaseModel
+          attr_accessor event_id: String
+
+          attr_accessor response_id: String
+
+          attr_accessor type: :"output_audio_buffer.stopped"
+
+          def initialize: (
+            event_id: String,
+            response_id: String,
+            ?type: :"output_audio_buffer.stopped"
+          ) -> void
+
+          def to_hash: -> {
+            event_id: String,
+            response_id: String,
+            type: :"output_audio_buffer.stopped"
+          }
+        end
+
+        type output_audio_buffer_cleared =
+          {
+            event_id: String,
+            response_id: String,
+            type: :"output_audio_buffer.cleared"
+          }
+
+        class OutputAudioBufferCleared < OpenAI::Internal::Type::BaseModel
+          attr_accessor event_id: String
+
+          attr_accessor response_id: String
+
+          attr_accessor type: :"output_audio_buffer.cleared"
+
+          def initialize: (
+            event_id: String,
+            response_id: String,
+            ?type: :"output_audio_buffer.cleared"
+          ) -> void
+
+          def to_hash: -> {
+            event_id: String,
+            response_id: String,
+            type: :"output_audio_buffer.cleared"
+          }
+        end
+
+        def self?.variants: -> ::Array[OpenAI::Models::Realtime::realtime_server_event]
+      end
+    end
+  end
+end