openai 0.20.0 → 0.21.0

data/rbi/openai/models/realtime/response_output_item_added_event.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseOutputItemAddedEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ResponseOutputItemAddedEvent,
+              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 index of the output item in the Response.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The ID of the Response to which the item belongs.
+        sig { returns(String) }
+        attr_accessor :response_id
+
+        # The event type, must be `response.output_item.added`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when a new Item is created during Response generation.
+        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
+              ),
+            output_index: Integer,
+            response_id: 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 index of the output item in the Response.
+          output_index:,
+          # The ID of the Response to which the item belongs.
+          response_id:,
+          # The event type, must be `response.output_item.added`.
+          type: :"response.output_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
+                ),
+              output_index: Integer,
+              response_id: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/response_output_item_done_event.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseOutputItemDoneEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ResponseOutputItemDoneEvent,
+              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 index of the output item in the Response.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The ID of the Response to which the item belongs.
+        sig { returns(String) }
+        attr_accessor :response_id
+
+        # The event type, must be `response.output_item.done`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when an Item is done streaming. Also emitted when a Response is
+        # interrupted, incomplete, or cancelled.
+        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
+              ),
+            output_index: Integer,
+            response_id: 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 index of the output item in the Response.
+          output_index:,
+          # The ID of the Response to which the item belongs.
+          response_id:,
+          # The event type, must be `response.output_item.done`.
+          type: :"response.output_item.done"
+        )
+        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
+                ),
+              output_index: Integer,
+              response_id: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/response_text_delta_event.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ResponseTextDeltaEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The index of the content part in the item's content array.
+        sig { returns(Integer) }
+        attr_accessor :content_index
+
+        # The text 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_text.delta`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when the text value of an "output_text" content part 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 text 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_text.delta`.
+          type: :"response.output_text.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_text_done_event.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::ResponseTextDoneEvent,
+              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 text content.
+        sig { returns(String) }
+        attr_accessor :text
+
+        # The event type, must be `response.output_text.done`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when the text value of an "output_text" content part 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,
+            text: 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 text content.
+          text:,
+          # The event type, must be `response.output_text.done`.
+          type: :"response.output_text.done"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              content_index: Integer,
+              event_id: String,
+              item_id: String,
+              output_index: Integer,
+              response_id: String,
+              text: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/session_created_event.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class SessionCreatedEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::SessionCreatedEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # Realtime session object.
+        sig { returns(OpenAI::Realtime::RealtimeSession) }
+        attr_reader :session
+
+        sig { params(session: OpenAI::Realtime::RealtimeSession::OrHash).void }
+        attr_writer :session
+
+        # The event type, must be `session.created`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when a Session is created. Emitted automatically when a new connection
+        # is established as the first server event. This event will contain the default
+        # Session configuration.
+        sig do
+          params(
+            event_id: String,
+            session: OpenAI::Realtime::RealtimeSession::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the server event.
+          event_id:,
+          # Realtime session object.
+          session:,
+          # The event type, must be `session.created`.
+          type: :"session.created"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              event_id: String,
+              session: OpenAI::Realtime::RealtimeSession,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/session_update_event.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class SessionUpdateEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::SessionUpdateEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Realtime session object configuration.
+        sig { returns(OpenAI::Realtime::RealtimeSessionCreateRequest) }
+        attr_reader :session
+
+        sig do
+          params(
+            session: OpenAI::Realtime::RealtimeSessionCreateRequest::OrHash
+          ).void
+        end
+        attr_writer :session
+
+        # The event type, must be `session.update`.
+        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 to update the session’s default configuration. The client may
+        # send this event at any time to update any field, except for `voice`. However,
+        # note that once a session has been initialized with a particular `model`, it
+        # can’t be changed to another model using `session.update`.
+        #
+        # When the server receives a `session.update`, it will respond with a
+        # `session.updated` event showing the full, effective configuration. Only the
+        # fields that are present are updated. To clear a field like `instructions`, pass
+        # an empty string.
+        sig do
+          params(
+            session: OpenAI::Realtime::RealtimeSessionCreateRequest::OrHash,
+            event_id: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Realtime session object configuration.
+          session:,
+          # Optional client-generated ID used to identify this event.
+          event_id: nil,
+          # The event type, must be `session.update`.
+          type: :"session.update"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              session: OpenAI::Realtime::RealtimeSessionCreateRequest,
+              type: Symbol,
+              event_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/session_updated_event.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class SessionUpdatedEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::SessionUpdatedEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # Realtime session object.
+        sig { returns(OpenAI::Realtime::RealtimeSession) }
+        attr_reader :session
+
+        sig { params(session: OpenAI::Realtime::RealtimeSession::OrHash).void }
+        attr_writer :session
+
+        # The event type, must be `session.updated`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when a session is updated with a `session.update` event, unless there
+        # is an error.
+        sig do
+          params(
+            event_id: String,
+            session: OpenAI::Realtime::RealtimeSession::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the server event.
+          event_id:,
+          # Realtime session object.
+          session:,
+          # The event type, must be `session.updated`.
+          type: :"session.updated"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              event_id: String,
+              session: OpenAI::Realtime::RealtimeSession,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end