openai 0.20.0 → 0.21.0

data/rbi/openai/models/realtime/realtime_conversation_item_user_message.rbi

@@ -0,0 +1,319 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemUserMessage < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeConversationItemUserMessage,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The content of the message.
+        sig do
+          returns(
+            T::Array[
+              OpenAI::Realtime::RealtimeConversationItemUserMessage::Content
+            ]
+          )
+        end
+        attr_accessor :content
+
+        # The role of the message sender. Always `user`.
+        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::RealtimeConversationItemUserMessage::Object::OrSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object:
+              OpenAI::Realtime::RealtimeConversationItemUserMessage::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::RealtimeConversationItemUserMessage::Status::OrSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status:
+              OpenAI::Realtime::RealtimeConversationItemUserMessage::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        # A user message item in a Realtime conversation.
+        sig do
+          params(
+            content:
+              T::Array[
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::OrHash
+              ],
+            id: String,
+            object:
+              OpenAI::Realtime::RealtimeConversationItemUserMessage::Object::OrSymbol,
+            status:
+              OpenAI::Realtime::RealtimeConversationItemUserMessage::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 `user`.
+          role: :user,
+          # The type of the item. Always `message`.
+          type: :message
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              content:
+                T::Array[
+                  OpenAI::Realtime::RealtimeConversationItemUserMessage::Content
+                ],
+              role: Symbol,
+              type: Symbol,
+              id: String,
+              object:
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Object::OrSymbol,
+              status:
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Status::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Content < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Base64-encoded audio bytes (for `input_audio`).
+          sig { returns(T.nilable(String)) }
+          attr_reader :audio
+
+          sig { params(audio: String).void }
+          attr_writer :audio
+
+          # The text content (for `input_text`).
+          sig { returns(T.nilable(String)) }
+          attr_reader :text
+
+          sig { params(text: String).void }
+          attr_writer :text
+
+          # Transcript of the audio (for `input_audio`).
+          sig { returns(T.nilable(String)) }
+          attr_reader :transcript
+
+          sig { params(transcript: String).void }
+          attr_writer :transcript
+
+          # The content type (`input_text` or `input_audio`).
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type::OrSymbol
+              )
+            )
+          end
+          attr_reader :type
+
+          sig do
+            params(
+              type:
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type::OrSymbol
+            ).void
+          end
+          attr_writer :type
+
+          sig do
+            params(
+              audio: String,
+              text: String,
+              transcript: String,
+              type:
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Base64-encoded audio bytes (for `input_audio`).
+            audio: nil,
+            # The text content (for `input_text`).
+            text: nil,
+            # Transcript of the audio (for `input_audio`).
+            transcript: nil,
+            # The content type (`input_text` or `input_audio`).
+            type: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                audio: String,
+                text: String,
+                transcript: String,
+                type:
+                  OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The content type (`input_text` or `input_audio`).
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INPUT_TEXT =
+              T.let(
+                :input_text,
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type::TaggedSymbol
+              )
+            INPUT_AUDIO =
+              T.let(
+                :input_audio,
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Realtime::RealtimeConversationItemUserMessage::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::RealtimeConversationItemUserMessage::Object
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REALTIME_ITEM =
+            T.let(
+              :"realtime.item",
+              OpenAI::Realtime::RealtimeConversationItemUserMessage::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::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::RealtimeConversationItemUserMessage::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Realtime::RealtimeConversationItemUserMessage::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Realtime::RealtimeConversationItemUserMessage::Status::TaggedSymbol
+            )
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Realtime::RealtimeConversationItemUserMessage::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Realtime::RealtimeConversationItemUserMessage::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/realtime_error.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeError < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Realtime::RealtimeError, OpenAI::Internal::AnyHash)
+          end
+
+        # A human-readable error message.
+        sig { returns(String) }
+        attr_accessor :message
+
+        # The type of error (e.g., "invalid_request_error", "server_error").
+        sig { returns(String) }
+        attr_accessor :type
+
+        # Error code, if any.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :code
+
+        # The event_id of the client event that caused the error, if applicable.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :event_id
+
+        # Parameter related to the error, if any.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :param
+
+        # Details of the error.
+        sig do
+          params(
+            message: String,
+            type: String,
+            code: T.nilable(String),
+            event_id: T.nilable(String),
+            param: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A human-readable error message.
+          message:,
+          # The type of error (e.g., "invalid_request_error", "server_error").
+          type:,
+          # Error code, if any.
+          code: nil,
+          # The event_id of the client event that caused the error, if applicable.
+          event_id: nil,
+          # Parameter related to the error, if any.
+          param: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              message: String,
+              type: String,
+              code: T.nilable(String),
+              event_id: T.nilable(String),
+              param: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/realtime_error_event.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeErrorEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeErrorEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Details of the error.
+        sig { returns(OpenAI::Realtime::RealtimeError) }
+        attr_reader :error
+
+        sig { params(error: OpenAI::Realtime::RealtimeError::OrHash).void }
+        attr_writer :error
+
+        # The unique ID of the server event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # The event type, must be `error`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Returned when an error occurs, which could be a client problem or a server
+        # problem. Most errors are recoverable and the session will stay open, we
+        # recommend to implementors to monitor and log error messages by default.
+        sig do
+          params(
+            error: OpenAI::Realtime::RealtimeError::OrHash,
+            event_id: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Details of the error.
+          error:,
+          # The unique ID of the server event.
+          event_id:,
+          # The event type, must be `error`.
+          type: :error
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              error: OpenAI::Realtime::RealtimeError,
+              event_id: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/realtime_mcp_approval_request.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeMcpApprovalRequest < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeMcpApprovalRequest,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the approval request.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # A JSON string of arguments for the tool.
+        sig { returns(String) }
+        attr_accessor :arguments
+
+        # The name of the tool to run.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The label of the MCP server making the request.
+        sig { returns(String) }
+        attr_accessor :server_label
+
+        # The type of the item. Always `mcp_approval_request`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A Realtime item requesting human approval of a tool invocation.
+        sig do
+          params(
+            id: String,
+            arguments: String,
+            name: String,
+            server_label: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the approval request.
+          id:,
+          # A JSON string of arguments for the tool.
+          arguments:,
+          # The name of the tool to run.
+          name:,
+          # The label of the MCP server making the request.
+          server_label:,
+          # The type of the item. Always `mcp_approval_request`.
+          type: :mcp_approval_request
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              arguments: String,
+              name: String,
+              server_label: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/realtime_mcp_approval_response.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeMcpApprovalResponse < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeMcpApprovalResponse,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the approval response.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The ID of the approval request being answered.
+        sig { returns(String) }
+        attr_accessor :approval_request_id
+
+        # Whether the request was approved.
+        sig { returns(T::Boolean) }
+        attr_accessor :approve
+
+        # The type of the item. Always `mcp_approval_response`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Optional reason for the decision.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reason
+
+        # A Realtime item responding to an MCP approval request.
+        sig do
+          params(
+            id: String,
+            approval_request_id: String,
+            approve: T::Boolean,
+            reason: T.nilable(String),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the approval response.
+          id:,
+          # The ID of the approval request being answered.
+          approval_request_id:,
+          # Whether the request was approved.
+          approve:,
+          # Optional reason for the decision.
+          reason: nil,
+          # The type of the item. Always `mcp_approval_response`.
+          type: :mcp_approval_response
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              approval_request_id: String,
+              approve: T::Boolean,
+              type: Symbol,
+              reason: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end