openai 0.20.0 → 0.21.0

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

@@ -0,0 +1,37 @@
+module OpenAI
+  module Models
+    module Realtime
+      type conversation_item_done =
+        {
+          event_id: String,
+          item: OpenAI::Models::Realtime::conversation_item,
+          type: :"conversation.item.done",
+          previous_item_id: String?
+        }
+
+      class ConversationItemDone < OpenAI::Internal::Type::BaseModel
+        attr_accessor event_id: String
+
+        attr_accessor item: OpenAI::Models::Realtime::conversation_item
+
+        attr_accessor type: :"conversation.item.done"
+
+        attr_accessor previous_item_id: String?
+
+        def initialize: (
+          event_id: String,
+          item: OpenAI::Models::Realtime::conversation_item,
+          ?previous_item_id: String?,
+          ?type: :"conversation.item.done"
+        ) -> void
+
+        def to_hash: -> {
+          event_id: String,
+          item: OpenAI::Models::Realtime::conversation_item,
+          type: :"conversation.item.done",
+          previous_item_id: String?
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,136 @@
+module OpenAI
+  module Models
+    module Realtime
+      type conversation_item_input_audio_transcription_completed_event =
+        {
+          content_index: Integer,
+          event_id: String,
+          item_id: String,
+          transcript: String,
+          type: :"conversation.item.input_audio_transcription.completed",
+          usage: OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::usage,
+          logprobs: ::Array[OpenAI::Realtime::LogProbProperties]?
+        }
+
+      class ConversationItemInputAudioTranscriptionCompletedEvent < OpenAI::Internal::Type::BaseModel
+        attr_accessor content_index: Integer
+
+        attr_accessor event_id: String
+
+        attr_accessor item_id: String
+
+        attr_accessor transcript: String
+
+        attr_accessor type: :"conversation.item.input_audio_transcription.completed"
+
+        attr_accessor usage: OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::usage
+
+        attr_accessor logprobs: ::Array[OpenAI::Realtime::LogProbProperties]?
+
+        def initialize: (
+          content_index: Integer,
+          event_id: String,
+          item_id: String,
+          transcript: String,
+          usage: OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::usage,
+          ?logprobs: ::Array[OpenAI::Realtime::LogProbProperties]?,
+          ?type: :"conversation.item.input_audio_transcription.completed"
+        ) -> void
+
+        def to_hash: -> {
+          content_index: Integer,
+          event_id: String,
+          item_id: String,
+          transcript: String,
+          type: :"conversation.item.input_audio_transcription.completed",
+          usage: OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::usage,
+          logprobs: ::Array[OpenAI::Realtime::LogProbProperties]?
+        }
+
+        type usage =
+          OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens
+          | OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageDuration
+
+        module Usage
+          extend OpenAI::Internal::Type::Union
+
+          type transcript_text_usage_tokens =
+            {
+              input_tokens: Integer,
+              output_tokens: Integer,
+              total_tokens: Integer,
+              type: :tokens,
+              input_token_details: OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails
+            }
+
+          class TranscriptTextUsageTokens < OpenAI::Internal::Type::BaseModel
+            attr_accessor input_tokens: Integer
+
+            attr_accessor output_tokens: Integer
+
+            attr_accessor total_tokens: Integer
+
+            attr_accessor type: :tokens
+
+            attr_reader input_token_details: OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails?
+
+            def input_token_details=: (
+              OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails
+            ) -> OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails
+
+            def initialize: (
+              input_tokens: Integer,
+              output_tokens: Integer,
+              total_tokens: Integer,
+              ?input_token_details: OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails,
+              ?type: :tokens
+            ) -> void
+
+            def to_hash: -> {
+              input_tokens: Integer,
+              output_tokens: Integer,
+              total_tokens: Integer,
+              type: :tokens,
+              input_token_details: OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails
+            }
+
+            type input_token_details =
+              { audio_tokens: Integer, text_tokens: Integer }
+
+            class InputTokenDetails < 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
+
+          type transcript_text_usage_duration =
+            { seconds: Float, type: :duration }
+
+          class TranscriptTextUsageDuration < OpenAI::Internal::Type::BaseModel
+            attr_accessor seconds: Float
+
+            attr_accessor type: :duration
+
+            def initialize: (seconds: Float, ?type: :duration) -> void
+
+            def to_hash: -> { seconds: Float, type: :duration }
+          end
+
+          def self?.variants: -> ::Array[OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::usage]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module OpenAI
+  module Models
+    module Realtime
+      type conversation_item_input_audio_transcription_delta_event =
+        {
+          event_id: String,
+          item_id: String,
+          type: :"conversation.item.input_audio_transcription.delta",
+          content_index: Integer,
+          delta: String,
+          logprobs: ::Array[OpenAI::Realtime::LogProbProperties]?
+        }
+
+      class ConversationItemInputAudioTranscriptionDeltaEvent < OpenAI::Internal::Type::BaseModel
+        attr_accessor event_id: String
+
+        attr_accessor item_id: String
+
+        attr_accessor type: :"conversation.item.input_audio_transcription.delta"
+
+        attr_reader content_index: Integer?
+
+        def content_index=: (Integer) -> Integer
+
+        attr_reader delta: String?
+
+        def delta=: (String) -> String
+
+        attr_accessor logprobs: ::Array[OpenAI::Realtime::LogProbProperties]?
+
+        def initialize: (
+          event_id: String,
+          item_id: String,
+          ?content_index: Integer,
+          ?delta: String,
+          ?logprobs: ::Array[OpenAI::Realtime::LogProbProperties]?,
+          ?type: :"conversation.item.input_audio_transcription.delta"
+        ) -> void
+
+        def to_hash: -> {
+          event_id: String,
+          item_id: String,
+          type: :"conversation.item.input_audio_transcription.delta",
+          content_index: Integer,
+          delta: String,
+          logprobs: ::Array[OpenAI::Realtime::LogProbProperties]?
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module OpenAI
+  module Models
+    module Realtime
+      type conversation_item_input_audio_transcription_failed_event =
+        {
+          content_index: Integer,
+          error: OpenAI::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error,
+          event_id: String,
+          item_id: String,
+          type: :"conversation.item.input_audio_transcription.failed"
+        }
+
+      class ConversationItemInputAudioTranscriptionFailedEvent < OpenAI::Internal::Type::BaseModel
+        attr_accessor content_index: Integer
+
+        attr_accessor error: OpenAI::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error
+
+        attr_accessor event_id: String
+
+        attr_accessor item_id: String
+
+        attr_accessor type: :"conversation.item.input_audio_transcription.failed"
+
+        def initialize: (
+          content_index: Integer,
+          error: OpenAI::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error,
+          event_id: String,
+          item_id: String,
+          ?type: :"conversation.item.input_audio_transcription.failed"
+        ) -> void
+
+        def to_hash: -> {
+          content_index: Integer,
+          error: OpenAI::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error,
+          event_id: String,
+          item_id: String,
+          type: :"conversation.item.input_audio_transcription.failed"
+        }
+
+        type error =
+          { code: String, message: String, param: String, type: String }
+
+        class Error < OpenAI::Internal::Type::BaseModel
+          attr_reader code: String?
+
+          def code=: (String) -> String
+
+          attr_reader message: String?
+
+          def message=: (String) -> String
+
+          attr_reader param: String?
+
+          def param=: (String) -> String
+
+          attr_reader type: String?
+
+          def type=: (String) -> String
+
+          def initialize: (
+            ?code: String,
+            ?message: String,
+            ?param: String,
+            ?type: String
+          ) -> void
+
+          def to_hash: -> {
+            code: String,
+            message: String,
+            param: String,
+            type: String
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module OpenAI
+  module Models
+    module Realtime
+      type conversation_item_input_audio_transcription_segment =
+        {
+          id: String,
+          content_index: Integer,
+          end_: Float,
+          event_id: String,
+          item_id: String,
+          speaker: String,
+          start: Float,
+          text: String,
+          type: :"conversation.item.input_audio_transcription.segment"
+        }
+
+      class ConversationItemInputAudioTranscriptionSegment < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor content_index: Integer
+
+        attr_accessor end_: Float
+
+        attr_accessor event_id: String
+
+        attr_accessor item_id: String
+
+        attr_accessor speaker: String
+
+        attr_accessor start: Float
+
+        attr_accessor text: String
+
+        attr_accessor type: :"conversation.item.input_audio_transcription.segment"
+
+        def initialize: (
+          id: String,
+          content_index: Integer,
+          end_: Float,
+          event_id: String,
+          item_id: String,
+          speaker: String,
+          start: Float,
+          text: String,
+          ?type: :"conversation.item.input_audio_transcription.segment"
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          content_index: Integer,
+          end_: Float,
+          event_id: String,
+          item_id: String,
+          speaker: String,
+          start: Float,
+          text: String,
+          type: :"conversation.item.input_audio_transcription.segment"
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module OpenAI
+  module Models
+    module Realtime
+      type conversation_item_retrieve_event =
+        {
+          item_id: String,
+          type: :"conversation.item.retrieve",
+          event_id: String
+        }
+
+      class ConversationItemRetrieveEvent < OpenAI::Internal::Type::BaseModel
+        attr_accessor item_id: String
+
+        attr_accessor type: :"conversation.item.retrieve"
+
+        attr_reader event_id: String?
+
+        def event_id=: (String) -> String
+
+        def initialize: (
+          item_id: String,
+          ?event_id: String,
+          ?type: :"conversation.item.retrieve"
+        ) -> void
+
+        def to_hash: -> {
+          item_id: String,
+          type: :"conversation.item.retrieve",
+          event_id: String
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module OpenAI
+  module Models
+    module Realtime
+      type conversation_item_truncate_event =
+        {
+          audio_end_ms: Integer,
+          content_index: Integer,
+          item_id: String,
+          type: :"conversation.item.truncate",
+          event_id: String
+        }
+
+      class ConversationItemTruncateEvent < OpenAI::Internal::Type::BaseModel
+        attr_accessor audio_end_ms: Integer
+
+        attr_accessor content_index: Integer
+
+        attr_accessor item_id: String
+
+        attr_accessor type: :"conversation.item.truncate"
+
+        attr_reader event_id: String?
+
+        def event_id=: (String) -> String
+
+        def initialize: (
+          audio_end_ms: Integer,
+          content_index: Integer,
+          item_id: String,
+          ?event_id: String,
+          ?type: :"conversation.item.truncate"
+        ) -> void
+
+        def to_hash: -> {
+          audio_end_ms: Integer,
+          content_index: Integer,
+          item_id: String,
+          type: :"conversation.item.truncate",
+          event_id: String
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module OpenAI
+  module Models
+    module Realtime
+      type conversation_item_truncated_event =
+        {
+          audio_end_ms: Integer,
+          content_index: Integer,
+          event_id: String,
+          item_id: String,
+          type: :"conversation.item.truncated"
+        }
+
+      class ConversationItemTruncatedEvent < OpenAI::Internal::Type::BaseModel
+        attr_accessor audio_end_ms: Integer
+
+        attr_accessor content_index: Integer
+
+        attr_accessor event_id: String
+
+        attr_accessor item_id: String
+
+        attr_accessor type: :"conversation.item.truncated"
+
+        def initialize: (
+          audio_end_ms: Integer,
+          content_index: Integer,
+          event_id: String,
+          item_id: String,
+          ?type: :"conversation.item.truncated"
+        ) -> void
+
+        def to_hash: -> {
+          audio_end_ms: Integer,
+          content_index: Integer,
+          event_id: String,
+          item_id: String,
+          type: :"conversation.item.truncated"
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,207 @@
+module OpenAI
+  module Models
+    module Realtime
+      type conversation_item_with_reference =
+        {
+          id: String,
+          arguments: String,
+          call_id: String,
+          content: ::Array[OpenAI::Realtime::ConversationItemWithReference::Content],
+          name: String,
+          object: OpenAI::Models::Realtime::ConversationItemWithReference::object,
+          output: String,
+          role: OpenAI::Models::Realtime::ConversationItemWithReference::role,
+          status: OpenAI::Models::Realtime::ConversationItemWithReference::status,
+          type: OpenAI::Models::Realtime::ConversationItemWithReference::type_
+        }
+
+      class ConversationItemWithReference < OpenAI::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader arguments: String?
+
+        def arguments=: (String) -> String
+
+        attr_reader call_id: String?
+
+        def call_id=: (String) -> String
+
+        attr_reader content: ::Array[OpenAI::Realtime::ConversationItemWithReference::Content]?
+
+        def content=: (
+          ::Array[OpenAI::Realtime::ConversationItemWithReference::Content]
+        ) -> ::Array[OpenAI::Realtime::ConversationItemWithReference::Content]
+
+        attr_reader name: String?
+
+        def name=: (String) -> String
+
+        attr_reader object: OpenAI::Models::Realtime::ConversationItemWithReference::object?
+
+        def object=: (
+          OpenAI::Models::Realtime::ConversationItemWithReference::object
+        ) -> OpenAI::Models::Realtime::ConversationItemWithReference::object
+
+        attr_reader output: String?
+
+        def output=: (String) -> String
+
+        attr_reader role: OpenAI::Models::Realtime::ConversationItemWithReference::role?
+
+        def role=: (
+          OpenAI::Models::Realtime::ConversationItemWithReference::role
+        ) -> OpenAI::Models::Realtime::ConversationItemWithReference::role
+
+        attr_reader status: OpenAI::Models::Realtime::ConversationItemWithReference::status?
+
+        def status=: (
+          OpenAI::Models::Realtime::ConversationItemWithReference::status
+        ) -> OpenAI::Models::Realtime::ConversationItemWithReference::status
+
+        attr_reader type: OpenAI::Models::Realtime::ConversationItemWithReference::type_?
+
+        def type=: (
+          OpenAI::Models::Realtime::ConversationItemWithReference::type_
+        ) -> OpenAI::Models::Realtime::ConversationItemWithReference::type_
+
+        def initialize: (
+          ?id: String,
+          ?arguments: String,
+          ?call_id: String,
+          ?content: ::Array[OpenAI::Realtime::ConversationItemWithReference::Content],
+          ?name: String,
+          ?object: OpenAI::Models::Realtime::ConversationItemWithReference::object,
+          ?output: String,
+          ?role: OpenAI::Models::Realtime::ConversationItemWithReference::role,
+          ?status: OpenAI::Models::Realtime::ConversationItemWithReference::status,
+          ?type: OpenAI::Models::Realtime::ConversationItemWithReference::type_
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          arguments: String,
+          call_id: String,
+          content: ::Array[OpenAI::Realtime::ConversationItemWithReference::Content],
+          name: String,
+          object: OpenAI::Models::Realtime::ConversationItemWithReference::object,
+          output: String,
+          role: OpenAI::Models::Realtime::ConversationItemWithReference::role,
+          status: OpenAI::Models::Realtime::ConversationItemWithReference::status,
+          type: OpenAI::Models::Realtime::ConversationItemWithReference::type_
+        }
+
+        type content =
+          {
+            id: String,
+            audio: String,
+            text: String,
+            transcript: String,
+            type: OpenAI::Models::Realtime::ConversationItemWithReference::Content::type_
+          }
+
+        class Content < OpenAI::Internal::Type::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          attr_reader audio: String?
+
+          def audio=: (String) -> String
+
+          attr_reader text: String?
+
+          def text=: (String) -> String
+
+          attr_reader transcript: String?
+
+          def transcript=: (String) -> String
+
+          attr_reader type: OpenAI::Models::Realtime::ConversationItemWithReference::Content::type_?
+
+          def type=: (
+            OpenAI::Models::Realtime::ConversationItemWithReference::Content::type_
+          ) -> OpenAI::Models::Realtime::ConversationItemWithReference::Content::type_
+
+          def initialize: (
+            ?id: String,
+            ?audio: String,
+            ?text: String,
+            ?transcript: String,
+            ?type: OpenAI::Models::Realtime::ConversationItemWithReference::Content::type_
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            audio: String,
+            text: String,
+            transcript: String,
+            type: OpenAI::Models::Realtime::ConversationItemWithReference::Content::type_
+          }
+
+          type type_ = :input_text | :input_audio | :item_reference | :text
+
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            INPUT_TEXT: :input_text
+            INPUT_AUDIO: :input_audio
+            ITEM_REFERENCE: :item_reference
+            TEXT: :text
+
+            def self?.values: -> ::Array[OpenAI::Models::Realtime::ConversationItemWithReference::Content::type_]
+          end
+        end
+
+        type object = :"realtime.item"
+
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM: :"realtime.item"
+
+          def self?.values: -> ::Array[OpenAI::Models::Realtime::ConversationItemWithReference::object]
+        end
+
+        type role = :user | :assistant | :system
+
+        module Role
+          extend OpenAI::Internal::Type::Enum
+
+          USER: :user
+          ASSISTANT: :assistant
+          SYSTEM: :system
+
+          def self?.values: -> ::Array[OpenAI::Models::Realtime::ConversationItemWithReference::role]
+        end
+
+        type status = :completed | :incomplete | :in_progress
+
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED: :completed
+          INCOMPLETE: :incomplete
+          IN_PROGRESS: :in_progress
+
+          def self?.values: -> ::Array[OpenAI::Models::Realtime::ConversationItemWithReference::status]
+        end
+
+        type type_ =
+          :message | :function_call | :function_call_output | :item_reference
+
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          MESSAGE: :message
+          FUNCTION_CALL: :function_call
+          FUNCTION_CALL_OUTPUT: :function_call_output
+          ITEM_REFERENCE: :item_reference
+
+          def self?.values: -> ::Array[OpenAI::Models::Realtime::ConversationItemWithReference::type_]
+        end
+      end
+    end
+  end
+end