openai 0.19.0 → 0.21.0

data/lib/openai/models/realtime/realtime_conversation_item_user_message.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemUserMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The content of the message.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content>]
+        required :content,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::RealtimeConversationItemUserMessage::Content] }
+
+        # @!attribute role
+        #   The role of the message sender. Always `user`.
+        #
+        #   @return [Symbol, :user]
+        required :role, const: :user
+
+        # @!attribute type
+        #   The type of the item. Always `message`.
+        #
+        #   @return [Symbol, :message]
+        required :type, const: :message
+
+        # @!attribute id
+        #   The unique ID of the item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Object }
+
+        # @!attribute status
+        #   The status of the item. Has no effect on the conversation.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Status }
+
+        # @!method initialize(content:, id: nil, object: nil, status: nil, role: :user, type: :message)
+        #   A user message item in a Realtime conversation.
+        #
+        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content>] The content of the message.
+        #
+        #   @param id [String] The unique ID of the item.
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Object] Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Status] The status of the item. Has no effect on the conversation.
+        #
+        #   @param role [Symbol, :user] The role of the message sender. Always `user`.
+        #
+        #   @param type [Symbol, :message] The type of the item. Always `message`.
+
+        class Content < OpenAI::Internal::Type::BaseModel
+          # @!attribute audio
+          #   Base64-encoded audio bytes (for `input_audio`).
+          #
+          #   @return [String, nil]
+          optional :audio, String
+
+          # @!attribute text
+          #   The text content (for `input_text`).
+          #
+          #   @return [String, nil]
+          optional :text, String
+
+          # @!attribute transcript
+          #   Transcript of the audio (for `input_audio`).
+          #
+          #   @return [String, nil]
+          optional :transcript, String
+
+          # @!attribute type
+          #   The content type (`input_text` or `input_audio`).
+          #
+          #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Type, nil]
+          optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type }
+
+          # @!method initialize(audio: nil, text: nil, transcript: nil, type: nil)
+          #   @param audio [String] Base64-encoded audio bytes (for `input_audio`).
+          #
+          #   @param text [String] The text content (for `input_text`).
+          #
+          #   @param transcript [String] Transcript of the audio (for `input_audio`).
+          #
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Type] The content type (`input_text` or `input_audio`).
+
+          # The content type (`input_text` or `input_audio`).
+          #
+          # @see OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            INPUT_TEXT = :input_text
+            INPUT_AUDIO = :input_audio
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemUserMessage#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM = :"realtime.item"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemUserMessage#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_error.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeError < OpenAI::Internal::Type::BaseModel
+        # @!attribute message
+        #   A human-readable error message.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute type
+        #   The type of error (e.g., "invalid_request_error", "server_error").
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!attribute code
+        #   Error code, if any.
+        #
+        #   @return [String, nil]
+        optional :code, String, nil?: true
+
+        # @!attribute event_id
+        #   The event_id of the client event that caused the error, if applicable.
+        #
+        #   @return [String, nil]
+        optional :event_id, String, nil?: true
+
+        # @!attribute param
+        #   Parameter related to the error, if any.
+        #
+        #   @return [String, nil]
+        optional :param, String, nil?: true
+
+        # @!method initialize(message:, type:, code: nil, event_id: nil, param: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::RealtimeError} for more details.
+        #
+        #   Details of the error.
+        #
+        #   @param message [String] A human-readable error message.
+        #
+        #   @param type [String] The type of error (e.g., "invalid_request_error", "server_error").
+        #
+        #   @param code [String, nil] Error code, if any.
+        #
+        #   @param event_id [String, nil] The event_id of the client event that caused the error, if applicable.
+        #
+        #   @param param [String, nil] Parameter related to the error, if any.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_error_event.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeErrorEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute error
+        #   Details of the error.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeError]
+        required :error, -> { OpenAI::Realtime::RealtimeError }
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute type
+        #   The event type, must be `error`.
+        #
+        #   @return [Symbol, :error]
+        required :type, const: :error
+
+        # @!method initialize(error:, event_id:, type: :error)
+        #   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.
+        #
+        #   @param error [OpenAI::Models::Realtime::RealtimeError] Details of the error.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param type [Symbol, :error] The event type, must be `error`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_mcp_approval_request.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeMcpApprovalRequest < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the approval request.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute arguments
+        #   A JSON string of arguments for the tool.
+        #
+        #   @return [String]
+        required :arguments, String
+
+        # @!attribute name
+        #   The name of the tool to run.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute server_label
+        #   The label of the MCP server making the request.
+        #
+        #   @return [String]
+        required :server_label, String
+
+        # @!attribute type
+        #   The type of the item. Always `mcp_approval_request`.
+        #
+        #   @return [Symbol, :mcp_approval_request]
+        required :type, const: :mcp_approval_request
+
+        # @!method initialize(id:, arguments:, name:, server_label:, type: :mcp_approval_request)
+        #   A Realtime item requesting human approval of a tool invocation.
+        #
+        #   @param id [String] The unique ID of the approval request.
+        #
+        #   @param arguments [String] A JSON string of arguments for the tool.
+        #
+        #   @param name [String] The name of the tool to run.
+        #
+        #   @param server_label [String] The label of the MCP server making the request.
+        #
+        #   @param type [Symbol, :mcp_approval_request] The type of the item. Always `mcp_approval_request`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_mcp_approval_response.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeMcpApprovalResponse < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the approval response.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute approval_request_id
+        #   The ID of the approval request being answered.
+        #
+        #   @return [String]
+        required :approval_request_id, String
+
+        # @!attribute approve
+        #   Whether the request was approved.
+        #
+        #   @return [Boolean]
+        required :approve, OpenAI::Internal::Type::Boolean
+
+        # @!attribute type
+        #   The type of the item. Always `mcp_approval_response`.
+        #
+        #   @return [Symbol, :mcp_approval_response]
+        required :type, const: :mcp_approval_response
+
+        # @!attribute reason
+        #   Optional reason for the decision.
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!method initialize(id:, approval_request_id:, approve:, reason: nil, type: :mcp_approval_response)
+        #   A Realtime item responding to an MCP approval request.
+        #
+        #   @param id [String] The unique ID of the approval response.
+        #
+        #   @param approval_request_id [String] The ID of the approval request being answered.
+        #
+        #   @param approve [Boolean] Whether the request was approved.
+        #
+        #   @param reason [String, nil] Optional reason for the decision.
+        #
+        #   @param type [Symbol, :mcp_approval_response] The type of the item. Always `mcp_approval_response`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_mcp_list_tools.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeMcpListTools < OpenAI::Internal::Type::BaseModel
+        # @!attribute server_label
+        #   The label of the MCP server.
+        #
+        #   @return [String]
+        required :server_label, String
+
+        # @!attribute tools
+        #   The tools available on the server.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::RealtimeMcpListTools::Tool>]
+        required :tools, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::RealtimeMcpListTools::Tool] }
+
+        # @!attribute type
+        #   The type of the item. Always `mcp_list_tools`.
+        #
+        #   @return [Symbol, :mcp_list_tools]
+        required :type, const: :mcp_list_tools
+
+        # @!attribute id
+        #   The unique ID of the list.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!method initialize(server_label:, tools:, id: nil, type: :mcp_list_tools)
+        #   A Realtime item listing tools available on an MCP server.
+        #
+        #   @param server_label [String] The label of the MCP server.
+        #
+        #   @param tools [Array<OpenAI::Models::Realtime::RealtimeMcpListTools::Tool>] The tools available on the server.
+        #
+        #   @param id [String] The unique ID of the list.
+        #
+        #   @param type [Symbol, :mcp_list_tools] The type of the item. Always `mcp_list_tools`.
+
+        class Tool < OpenAI::Internal::Type::BaseModel
+          # @!attribute input_schema
+          #   The JSON schema describing the tool's input.
+          #
+          #   @return [Object]
+          required :input_schema, OpenAI::Internal::Type::Unknown
+
+          # @!attribute name
+          #   The name of the tool.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute annotations
+          #   Additional annotations about the tool.
+          #
+          #   @return [Object, nil]
+          optional :annotations, OpenAI::Internal::Type::Unknown, nil?: true
+
+          # @!attribute description
+          #   The description of the tool.
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!method initialize(input_schema:, name:, annotations: nil, description: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Realtime::RealtimeMcpListTools::Tool} for more details.
+          #
+          #   A tool available on an MCP server.
+          #
+          #   @param input_schema [Object] The JSON schema describing the tool's input.
+          #
+          #   @param name [String] The name of the tool.
+          #
+          #   @param annotations [Object, nil] Additional annotations about the tool.
+          #
+          #   @param description [String, nil] The description of the tool.
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_mcp_protocol_error.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeMcpProtocolError < OpenAI::Internal::Type::BaseModel
+        # @!attribute code
+        #
+        #   @return [Integer]
+        required :code, Integer
+
+        # @!attribute message
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :protocol_error]
+        required :type, const: :protocol_error
+
+        # @!method initialize(code:, message:, type: :protocol_error)
+        #   @param code [Integer]
+        #   @param message [String]
+        #   @param type [Symbol, :protocol_error]
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_mcp_tool_call.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeMcpToolCall < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the tool call.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute arguments
+        #   A JSON string of the arguments passed to the tool.
+        #
+        #   @return [String]
+        required :arguments, String
+
+        # @!attribute name
+        #   The name of the tool that was run.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute server_label
+        #   The label of the MCP server running the tool.
+        #
+        #   @return [String]
+        required :server_label, String
+
+        # @!attribute type
+        #   The type of the item. Always `mcp_tool_call`.
+        #
+        #   @return [Symbol, :mcp_tool_call]
+        required :type, const: :mcp_tool_call
+
+        # @!attribute approval_request_id
+        #   The ID of an associated approval request, if any.
+        #
+        #   @return [String, nil]
+        optional :approval_request_id, String, nil?: true
+
+        # @!attribute error
+        #   The error from the tool call, if any.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeMcpProtocolError, OpenAI::Models::Realtime::RealtimeMcpToolExecutionError, OpenAI::Models::Realtime::RealtimeMcphttpError, nil]
+        optional :error, union: -> { OpenAI::Realtime::RealtimeMcpToolCall::Error }, nil?: true
+
+        # @!attribute output
+        #   The output from the tool call.
+        #
+        #   @return [String, nil]
+        optional :output, String, nil?: true
+
+        # @!method initialize(id:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, type: :mcp_tool_call)
+        #   A Realtime item representing an invocation of a tool on an MCP server.
+        #
+        #   @param id [String] The unique ID of the tool call.
+        #
+        #   @param arguments [String] A JSON string of the arguments passed to the tool.
+        #
+        #   @param name [String] The name of the tool that was run.
+        #
+        #   @param server_label [String] The label of the MCP server running the tool.
+        #
+        #   @param approval_request_id [String, nil] The ID of an associated approval request, if any.
+        #
+        #   @param error [OpenAI::Models::Realtime::RealtimeMcpProtocolError, OpenAI::Models::Realtime::RealtimeMcpToolExecutionError, OpenAI::Models::Realtime::RealtimeMcphttpError, nil] The error from the tool call, if any.
+        #
+        #   @param output [String, nil] The output from the tool call.
+        #
+        #   @param type [Symbol, :mcp_tool_call] The type of the item. Always `mcp_tool_call`.
+
+        # The error from the tool call, if any.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeMcpToolCall#error
+        module Error
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          variant :protocol_error, -> { OpenAI::Realtime::RealtimeMcpProtocolError }
+
+          variant :tool_execution_error, -> { OpenAI::Realtime::RealtimeMcpToolExecutionError }
+
+          variant :http_error, -> { OpenAI::Realtime::RealtimeMcphttpError }
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Realtime::RealtimeMcpProtocolError, OpenAI::Models::Realtime::RealtimeMcpToolExecutionError, OpenAI::Models::Realtime::RealtimeMcphttpError)]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_mcp_tool_execution_error.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeMcpToolExecutionError < OpenAI::Internal::Type::BaseModel
+        # @!attribute message
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :tool_execution_error]
+        required :type, const: :tool_execution_error
+
+        # @!method initialize(message:, type: :tool_execution_error)
+        #   @param message [String]
+        #   @param type [Symbol, :tool_execution_error]
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_mcphttp_error.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeMcphttpError < OpenAI::Internal::Type::BaseModel
+        # @!attribute code
+        #
+        #   @return [Integer]
+        required :code, Integer
+
+        # @!attribute message
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :http_error]
+        required :type, const: :http_error
+
+        # @!method initialize(code:, message:, type: :http_error)
+        #   @param code [Integer]
+        #   @param message [String]
+        #   @param type [Symbol, :http_error]
+      end
+    end
+  end
+end