openai 0.20.0 → 0.21.0

data/rbi/openai/models/realtime/realtime_client_event.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      # A realtime client event.
+      module RealtimeClientEvent
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationItemCreateEvent,
+              OpenAI::Realtime::ConversationItemDeleteEvent,
+              OpenAI::Realtime::ConversationItemRetrieveEvent,
+              OpenAI::Realtime::ConversationItemTruncateEvent,
+              OpenAI::Realtime::InputAudioBufferAppendEvent,
+              OpenAI::Realtime::InputAudioBufferClearEvent,
+              OpenAI::Realtime::OutputAudioBufferClearEvent,
+              OpenAI::Realtime::InputAudioBufferCommitEvent,
+              OpenAI::Realtime::ResponseCancelEvent,
+              OpenAI::Realtime::ResponseCreateEvent,
+              OpenAI::Realtime::SessionUpdateEvent,
+              OpenAI::Realtime::TranscriptionSessionUpdate
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::Realtime::RealtimeClientEvent::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/realtime_client_secret_config.rbi

@@ -0,0 +1,147 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeClientSecretConfig < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeClientSecretConfig,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Configuration for the ephemeral token expiration.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter
+            )
+          )
+        end
+        attr_reader :expires_after
+
+        sig do
+          params(
+            expires_after:
+              OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter::OrHash
+          ).void
+        end
+        attr_writer :expires_after
+
+        # Configuration options for the generated client secret.
+        sig do
+          params(
+            expires_after:
+              OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Configuration for the ephemeral token expiration.
+          expires_after: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              expires_after:
+                OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The anchor point for the ephemeral token expiration. Only `created_at` is
+          # currently supported.
+          sig do
+            returns(
+              OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter::Anchor::OrSymbol
+            )
+          end
+          attr_accessor :anchor
+
+          # The number of seconds from the anchor point to the expiration. Select a value
+          # between `10` and `7200`.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :seconds
+
+          sig { params(seconds: Integer).void }
+          attr_writer :seconds
+
+          # Configuration for the ephemeral token expiration.
+          sig do
+            params(
+              anchor:
+                OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter::Anchor::OrSymbol,
+              seconds: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The anchor point for the ephemeral token expiration. Only `created_at` is
+            # currently supported.
+            anchor:,
+            # The number of seconds from the anchor point to the expiration. Select a value
+            # between `10` and `7200`.
+            seconds: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                anchor:
+                  OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter::Anchor::OrSymbol,
+                seconds: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The anchor point for the ephemeral token expiration. Only `created_at` is
+          # currently supported.
+          module Anchor
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter::Anchor
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CREATED_AT =
+              T.let(
+                :created_at,
+                OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter::Anchor::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter::Anchor::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/realtime_conversation_item_assistant_message.rbi

@@ -0,0 +1,292 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemAssistantMessage < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The content of the message.
+        sig do
+          returns(
+            T::Array[
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content
+            ]
+          )
+        end
+        attr_accessor :content
+
+        # The role of the message sender. Always `assistant`.
+        sig { returns(Symbol) }
+        attr_accessor :role
+
+        # The type of the item. Always `message`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The unique ID of the item.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Object::OrSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object:
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # The status of the item. Has no effect on the conversation.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status::OrSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status:
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        # An assistant message item in a Realtime conversation.
+        sig do
+          params(
+            content:
+              T::Array[
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::OrHash
+              ],
+            id: String,
+            object:
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Object::OrSymbol,
+            status:
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status::OrSymbol,
+            role: Symbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The content of the message.
+          content:,
+          # The unique ID of the item.
+          id: nil,
+          # Identifier for the API object being returned - always `realtime.item`.
+          object: nil,
+          # The status of the item. Has no effect on the conversation.
+          status: nil,
+          # The role of the message sender. Always `assistant`.
+          role: :assistant,
+          # The type of the item. Always `message`.
+          type: :message
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              content:
+                T::Array[
+                  OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content
+                ],
+              role: Symbol,
+              type: Symbol,
+              id: String,
+              object:
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Object::OrSymbol,
+              status:
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Content < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The text content.
+          sig { returns(T.nilable(String)) }
+          attr_reader :text
+
+          sig { params(text: String).void }
+          attr_writer :text
+
+          # The content type. Always `text` for assistant messages.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type::OrSymbol
+              )
+            )
+          end
+          attr_reader :type
+
+          sig do
+            params(
+              type:
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type::OrSymbol
+            ).void
+          end
+          attr_writer :type
+
+          sig do
+            params(
+              text: String,
+              type:
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The text content.
+            text: nil,
+            # The content type. Always `text` for assistant messages.
+            type: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                text: String,
+                type:
+                  OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The content type. Always `text` for assistant messages.
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            TEXT =
+              T.let(
+                :text,
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Object
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REALTIME_ITEM =
+            T.let(
+              :"realtime.item",
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status::TaggedSymbol
+            )
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/realtime_conversation_item_function_call.rbi

@@ -0,0 +1,199 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemFunctionCall < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The arguments of the function call.
+        sig { returns(String) }
+        attr_accessor :arguments
+
+        # The name of the function being called.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The type of the item. Always `function_call`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The unique ID of the item.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The ID of the function call.
+        sig { returns(T.nilable(String)) }
+        attr_reader :call_id
+
+        sig { params(call_id: String).void }
+        attr_writer :call_id
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall::Object::OrSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object:
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # The status of the item. Has no effect on the conversation.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status::OrSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status:
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        # A function call item in a Realtime conversation.
+        sig do
+          params(
+            arguments: String,
+            name: String,
+            id: String,
+            call_id: String,
+            object:
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall::Object::OrSymbol,
+            status:
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status::OrSymbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The arguments of the function call.
+          arguments:,
+          # The name of the function being called.
+          name:,
+          # The unique ID of the item.
+          id: nil,
+          # The ID of the function call.
+          call_id: nil,
+          # Identifier for the API object being returned - always `realtime.item`.
+          object: nil,
+          # The status of the item. Has no effect on the conversation.
+          status: nil,
+          # The type of the item. Always `function_call`.
+          type: :function_call
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              arguments: String,
+              name: String,
+              type: Symbol,
+              id: String,
+              call_id: String,
+              object:
+                OpenAI::Realtime::RealtimeConversationItemFunctionCall::Object::OrSymbol,
+              status:
+                OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Realtime::RealtimeConversationItemFunctionCall::Object
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REALTIME_ITEM =
+            T.let(
+              :"realtime.item",
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Realtime::RealtimeConversationItemFunctionCall::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status::TaggedSymbol
+            )
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end