openai 0.20.0 → 0.21.0

data/rbi/openai/models/realtime/conversation_created_event.rbi

@@ -0,0 +1,164 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationCreatedEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationCreatedEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The conversation resource.
+        sig do
+          returns(OpenAI::Realtime::ConversationCreatedEvent::Conversation)
+        end
+        attr_reader :conversation
+
+        sig do
+          params(
+            conversation:
+              OpenAI::Realtime::ConversationCreatedEvent::Conversation::OrHash
+          ).void
+        end
+        attr_writer :conversation
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The event type, must be `conversation.created`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when a conversation is created. Emitted right after session creation.
+        sig do
+          params(
+            conversation:
+              OpenAI::Realtime::ConversationCreatedEvent::Conversation::OrHash,
+            event_id: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The conversation resource.
+          conversation:,
+          # The unique ID of the server event.
+          event_id:,
+          # The event type, must be `conversation.created`.
+          type: :"conversation.created"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              conversation:
+                OpenAI::Realtime::ConversationCreatedEvent::Conversation,
+              event_id: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Conversation < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Realtime::ConversationCreatedEvent::Conversation,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the conversation.
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          # The object type, must be `realtime.conversation`.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Realtime::ConversationCreatedEvent::Conversation::Object::OrSymbol
+              )
+            )
+          end
+          attr_reader :object
+
+          sig do
+            params(
+              object:
+                OpenAI::Realtime::ConversationCreatedEvent::Conversation::Object::OrSymbol
+            ).void
+          end
+          attr_writer :object
+
+          # The conversation resource.
+          sig do
+            params(
+              id: String,
+              object:
+                OpenAI::Realtime::ConversationCreatedEvent::Conversation::Object::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The unique ID of the conversation.
+            id: nil,
+            # The object type, must be `realtime.conversation`.
+            object: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                object:
+                  OpenAI::Realtime::ConversationCreatedEvent::Conversation::Object::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The object type, must be `realtime.conversation`.
+          module Object
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Realtime::ConversationCreatedEvent::Conversation::Object
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            REALTIME_CONVERSATION =
+              T.let(
+                :"realtime.conversation",
+                OpenAI::Realtime::ConversationCreatedEvent::Conversation::Object::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Realtime::ConversationCreatedEvent::Conversation::Object::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/conversation_item.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      # A single item within a Realtime conversation.
+      module ConversationItem
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeConversationItemSystemMessage,
+              OpenAI::Realtime::RealtimeConversationItemUserMessage,
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput,
+              OpenAI::Realtime::RealtimeMcpApprovalResponse,
+              OpenAI::Realtime::RealtimeMcpListTools,
+              OpenAI::Realtime::RealtimeMcpToolCall,
+              OpenAI::Realtime::RealtimeMcpApprovalRequest
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::Realtime::ConversationItem::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/conversation_item_added.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemAdded < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationItemAdded,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # A single item within a Realtime conversation.
+        sig do
+          returns(
+            T.any(
+              OpenAI::Realtime::RealtimeConversationItemSystemMessage,
+              OpenAI::Realtime::RealtimeConversationItemUserMessage,
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput,
+              OpenAI::Realtime::RealtimeMcpApprovalResponse,
+              OpenAI::Realtime::RealtimeMcpListTools,
+              OpenAI::Realtime::RealtimeMcpToolCall,
+              OpenAI::Realtime::RealtimeMcpApprovalRequest
+            )
+          )
+        end
+        attr_accessor :item
+
+        # The event type, must be `conversation.item.added`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The ID of the item that precedes this one, if any. This is used to maintain
+        # ordering when items are inserted.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :previous_item_id
+
+        # Returned when a conversation item is added.
+        sig do
+          params(
+            event_id: String,
+            item:
+              T.any(
+                OpenAI::Realtime::RealtimeConversationItemSystemMessage::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemFunctionCall::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput::OrHash,
+                OpenAI::Realtime::RealtimeMcpApprovalResponse::OrHash,
+                OpenAI::Realtime::RealtimeMcpListTools::OrHash,
+                OpenAI::Realtime::RealtimeMcpToolCall::OrHash,
+                OpenAI::Realtime::RealtimeMcpApprovalRequest::OrHash
+              ),
+            previous_item_id: T.nilable(String),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the server event.
+          event_id:,
+          # A single item within a Realtime conversation.
+          item:,
+          # The ID of the item that precedes this one, if any. This is used to maintain
+          # ordering when items are inserted.
+          previous_item_id: nil,
+          # The event type, must be `conversation.item.added`.
+          type: :"conversation.item.added"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              event_id: String,
+              item:
+                T.any(
+                  OpenAI::Realtime::RealtimeConversationItemSystemMessage,
+                  OpenAI::Realtime::RealtimeConversationItemUserMessage,
+                  OpenAI::Realtime::RealtimeConversationItemAssistantMessage,
+                  OpenAI::Realtime::RealtimeConversationItemFunctionCall,
+                  OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput,
+                  OpenAI::Realtime::RealtimeMcpApprovalResponse,
+                  OpenAI::Realtime::RealtimeMcpListTools,
+                  OpenAI::Realtime::RealtimeMcpToolCall,
+                  OpenAI::Realtime::RealtimeMcpApprovalRequest
+                ),
+              type: Symbol,
+              previous_item_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/conversation_item_create_event.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemCreateEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationItemCreateEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # A single item within a Realtime conversation.
+        sig do
+          returns(
+            T.any(
+              OpenAI::Realtime::RealtimeConversationItemSystemMessage,
+              OpenAI::Realtime::RealtimeConversationItemUserMessage,
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput,
+              OpenAI::Realtime::RealtimeMcpApprovalResponse,
+              OpenAI::Realtime::RealtimeMcpListTools,
+              OpenAI::Realtime::RealtimeMcpToolCall,
+              OpenAI::Realtime::RealtimeMcpApprovalRequest
+            )
+          )
+        end
+        attr_accessor :item
+
+        # The event type, must be `conversation.item.create`.
+        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
+
+        # The ID of the preceding item after which the new item will be inserted. If not
+        # set, the new item will be appended to the end of the conversation. If set to
+        # `root`, the new item will be added to the beginning of the conversation. If set
+        # to an existing ID, it allows an item to be inserted mid-conversation. If the ID
+        # cannot be found, an error will be returned and the item will not be added.
+        sig { returns(T.nilable(String)) }
+        attr_reader :previous_item_id
+
+        sig { params(previous_item_id: String).void }
+        attr_writer :previous_item_id
+
+        # Add a new Item to the Conversation's context, including messages, function
+        # calls, and function call responses. This event can be used both to populate a
+        # "history" of the conversation and to add new items mid-stream, but has the
+        # current limitation that it cannot populate assistant audio messages.
+        #
+        # If successful, the server will respond with a `conversation.item.created` event,
+        # otherwise an `error` event will be sent.
+        sig do
+          params(
+            item:
+              T.any(
+                OpenAI::Realtime::RealtimeConversationItemSystemMessage::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemFunctionCall::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput::OrHash,
+                OpenAI::Realtime::RealtimeMcpApprovalResponse::OrHash,
+                OpenAI::Realtime::RealtimeMcpListTools::OrHash,
+                OpenAI::Realtime::RealtimeMcpToolCall::OrHash,
+                OpenAI::Realtime::RealtimeMcpApprovalRequest::OrHash
+              ),
+            event_id: String,
+            previous_item_id: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A single item within a Realtime conversation.
+          item:,
+          # Optional client-generated ID used to identify this event.
+          event_id: nil,
+          # The ID of the preceding item after which the new item will be inserted. If not
+          # set, the new item will be appended to the end of the conversation. If set to
+          # `root`, the new item will be added to the beginning of the conversation. If set
+          # to an existing ID, it allows an item to be inserted mid-conversation. If the ID
+          # cannot be found, an error will be returned and the item will not be added.
+          previous_item_id: nil,
+          # The event type, must be `conversation.item.create`.
+          type: :"conversation.item.create"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              item:
+                T.any(
+                  OpenAI::Realtime::RealtimeConversationItemSystemMessage,
+                  OpenAI::Realtime::RealtimeConversationItemUserMessage,
+                  OpenAI::Realtime::RealtimeConversationItemAssistantMessage,
+                  OpenAI::Realtime::RealtimeConversationItemFunctionCall,
+                  OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput,
+                  OpenAI::Realtime::RealtimeMcpApprovalResponse,
+                  OpenAI::Realtime::RealtimeMcpListTools,
+                  OpenAI::Realtime::RealtimeMcpToolCall,
+                  OpenAI::Realtime::RealtimeMcpApprovalRequest
+                ),
+              type: Symbol,
+              event_id: String,
+              previous_item_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/conversation_item_created_event.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemCreatedEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationItemCreatedEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # A single item within a Realtime conversation.
+        sig do
+          returns(
+            T.any(
+              OpenAI::Realtime::RealtimeConversationItemSystemMessage,
+              OpenAI::Realtime::RealtimeConversationItemUserMessage,
+              OpenAI::Realtime::RealtimeConversationItemAssistantMessage,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCall,
+              OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput,
+              OpenAI::Realtime::RealtimeMcpApprovalResponse,
+              OpenAI::Realtime::RealtimeMcpListTools,
+              OpenAI::Realtime::RealtimeMcpToolCall,
+              OpenAI::Realtime::RealtimeMcpApprovalRequest
+            )
+          )
+        end
+        attr_accessor :item
+
+        # The event type, must be `conversation.item.created`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The ID of the preceding item in the Conversation context, allows the client to
+        # understand the order of the conversation. Can be `null` if the item has no
+        # predecessor.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :previous_item_id
+
+        # Returned when a conversation item is created. There are several scenarios that
+        # produce this event:
+        #
+        # - The server is generating a Response, which if successful will produce either
+        #   one or two Items, which will be of type `message` (role `assistant`) or type
+        #   `function_call`.
+        # - The input audio buffer has been committed, either by the client or the server
+        #   (in `server_vad` mode). The server will take the content of the input audio
+        #   buffer and add it to a new user message Item.
+        # - The client has sent a `conversation.item.create` event to add a new Item to
+        #   the Conversation.
+        sig do
+          params(
+            event_id: String,
+            item:
+              T.any(
+                OpenAI::Realtime::RealtimeConversationItemSystemMessage::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemAssistantMessage::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemFunctionCall::OrHash,
+                OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput::OrHash,
+                OpenAI::Realtime::RealtimeMcpApprovalResponse::OrHash,
+                OpenAI::Realtime::RealtimeMcpListTools::OrHash,
+                OpenAI::Realtime::RealtimeMcpToolCall::OrHash,
+                OpenAI::Realtime::RealtimeMcpApprovalRequest::OrHash
+              ),
+            previous_item_id: T.nilable(String),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the server event.
+          event_id:,
+          # A single item within a Realtime conversation.
+          item:,
+          # The ID of the preceding item in the Conversation context, allows the client to
+          # understand the order of the conversation. Can be `null` if the item has no
+          # predecessor.
+          previous_item_id: nil,
+          # The event type, must be `conversation.item.created`.
+          type: :"conversation.item.created"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              event_id: String,
+              item:
+                T.any(
+                  OpenAI::Realtime::RealtimeConversationItemSystemMessage,
+                  OpenAI::Realtime::RealtimeConversationItemUserMessage,
+                  OpenAI::Realtime::RealtimeConversationItemAssistantMessage,
+                  OpenAI::Realtime::RealtimeConversationItemFunctionCall,
+                  OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput,
+                  OpenAI::Realtime::RealtimeMcpApprovalResponse,
+                  OpenAI::Realtime::RealtimeMcpListTools,
+                  OpenAI::Realtime::RealtimeMcpToolCall,
+                  OpenAI::Realtime::RealtimeMcpApprovalRequest
+                ),
+              type: Symbol,
+              previous_item_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/conversation_item_delete_event.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemDeleteEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationItemDeleteEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The ID of the item to delete.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The event type, must be `conversation.item.delete`.
+        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 remove any item from the conversation history.
+        # The server will respond with a `conversation.item.deleted` 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 delete.
+          item_id:,
+          # Optional client-generated ID used to identify this event.
+          event_id: nil,
+          # The event type, must be `conversation.item.delete`.
+          type: :"conversation.item.delete"
+        )
+        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_deleted_event.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ConversationItemDeletedEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ConversationItemDeletedEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The ID of the item that was deleted.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The event type, must be `conversation.item.deleted`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when an item in the conversation is deleted by the client with a
+        # `conversation.item.delete` event. This event is used to synchronize the server's
+        # understanding of the conversation history with the client's view.
+        sig do
+          params(event_id: String, item_id: String, type: Symbol).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The unique ID of the server event.
+          event_id:,
+          # The ID of the item that was deleted.
+          item_id:,
+          # The event type, must be `conversation.item.deleted`.
+          type: :"conversation.item.deleted"
+        )
+        end
+
+        sig do
+          override.returns({ event_id: String, item_id: String, type: Symbol })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end