openai 0.20.0 → 0.21.0

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

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

@@ -0,0 +1,259 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeResponse < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the response.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute conversation_id
+        #   Which conversation the response is added to, determined by the `conversation`
+        #   field in the `response.create` event. If `auto`, the response will be added to
+        #   the default conversation and the value of `conversation_id` will be an id like
+        #   `conv_1234`. If `none`, the response will not be added to any conversation and
+        #   the value of `conversation_id` will be `null`. If responses are being triggered
+        #   by server VAD, the response will be added to the default conversation, thus the
+        #   `conversation_id` will be an id like `conv_1234`.
+        #
+        #   @return [String, nil]
+        optional :conversation_id, String
+
+        # @!attribute max_output_tokens
+        #   Maximum number of output tokens for a single assistant response, inclusive of
+        #   tool calls, that was used in this response.
+        #
+        #   @return [Integer, Symbol, :inf, nil]
+        optional :max_output_tokens, union: -> { OpenAI::Realtime::RealtimeResponse::MaxOutputTokens }
+
+        # @!attribute metadata
+        #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+        #   for storing additional information about the object in a structured format, and
+        #   querying for objects via API or the dashboard.
+        #
+        #   Keys are strings with a maximum length of 64 characters. Values are strings with
+        #   a maximum length of 512 characters.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+        # @!attribute modalities
+        #   The set of modalities the model used to respond. If there are multiple
+        #   modalities, the model will pick one, for example if `modalities` is
+        #   `["text", "audio"]`, the model could be responding in either text or audio.
+        #
+        #   @return [Array<Symbol, OpenAI::Models::Realtime::RealtimeResponse::Modality>, nil]
+        optional :modalities,
+                 -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Realtime::RealtimeResponse::Modality] }
+
+        # @!attribute object
+        #   The object type, must be `realtime.response`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeResponse::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeResponse::Object }
+
+        # @!attribute output
+        #   The list of output items generated by the response.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest>, nil]
+        optional :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Realtime::ConversationItem] }
+
+        # @!attribute output_audio_format
+        #   The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeResponse::OutputAudioFormat, nil]
+        optional :output_audio_format, enum: -> { OpenAI::Realtime::RealtimeResponse::OutputAudioFormat }
+
+        # @!attribute status
+        #   The final status of the response (`completed`, `cancelled`, `failed`, or
+        #   `incomplete`, `in_progress`).
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeResponse::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeResponse::Status }
+
+        # @!attribute status_details
+        #   Additional details about the status.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeResponseStatus, nil]
+        optional :status_details, -> { OpenAI::Realtime::RealtimeResponseStatus }
+
+        # @!attribute temperature
+        #   Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.
+        #
+        #   @return [Float, nil]
+        optional :temperature, Float
+
+        # @!attribute usage
+        #   Usage statistics for the Response, this will correspond to billing. A Realtime
+        #   API session will maintain a conversation context and append new Items to the
+        #   Conversation, thus output from previous turns (text and audio tokens) will
+        #   become the input for later turns.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeResponseUsage, nil]
+        optional :usage, -> { OpenAI::Realtime::RealtimeResponseUsage }
+
+        # @!attribute voice
+        #   The voice the model used to respond. Current voice options are `alloy`, `ash`,
+        #   `ballad`, `coral`, `echo`, `sage`, `shimmer`, and `verse`.
+        #
+        #   @return [String, Symbol, OpenAI::Models::Realtime::RealtimeResponse::Voice, nil]
+        optional :voice, union: -> { OpenAI::Realtime::RealtimeResponse::Voice }
+
+        # @!method initialize(id: nil, conversation_id: nil, max_output_tokens: nil, metadata: nil, modalities: nil, object: nil, output: nil, output_audio_format: nil, status: nil, status_details: nil, temperature: nil, usage: nil, voice: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::RealtimeResponse} for more details.
+        #
+        #   The response resource.
+        #
+        #   @param id [String] The unique ID of the response.
+        #
+        #   @param conversation_id [String] Which conversation the response is added to, determined by the `conversation`
+        #
+        #   @param max_output_tokens [Integer, Symbol, :inf] Maximum number of output tokens for a single assistant response,
+        #
+        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+        #
+        #   @param modalities [Array<Symbol, OpenAI::Models::Realtime::RealtimeResponse::Modality>] The set of modalities the model used to respond. If there are multiple modalitie
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeResponse::Object] The object type, must be `realtime.response`.
+        #
+        #   @param output [Array<OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest>] The list of output items generated by the response.
+        #
+        #   @param output_audio_format [Symbol, OpenAI::Models::Realtime::RealtimeResponse::OutputAudioFormat] The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeResponse::Status] The final status of the response (`completed`, `cancelled`, `failed`, or
+        #
+        #   @param status_details [OpenAI::Models::Realtime::RealtimeResponseStatus] Additional details about the status.
+        #
+        #   @param temperature [Float] Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.
+        #
+        #   @param usage [OpenAI::Models::Realtime::RealtimeResponseUsage] Usage statistics for the Response, this will correspond to billing. A
+        #
+        #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeResponse::Voice] The voice the model used to respond.
+
+        # Maximum number of output tokens for a single assistant response, inclusive of
+        # tool calls, that was used in this response.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponse#max_output_tokens
+        module MaxOutputTokens
+          extend OpenAI::Internal::Type::Union
+
+          variant Integer
+
+          variant const: :inf
+
+          # @!method self.variants
+          #   @return [Array(Integer, Symbol, :inf)]
+        end
+
+        module Modality
+          extend OpenAI::Internal::Type::Enum
+
+          TEXT = :text
+          AUDIO = :audio
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The object type, must be `realtime.response`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponse#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_RESPONSE = :"realtime.response"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponse#output_audio_format
+        module OutputAudioFormat
+          extend OpenAI::Internal::Type::Enum
+
+          PCM16 = :pcm16
+          G711_ULAW = :g711_ulaw
+          G711_ALAW = :g711_alaw
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The final status of the response (`completed`, `cancelled`, `failed`, or
+        # `incomplete`, `in_progress`).
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponse#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          CANCELLED = :cancelled
+          FAILED = :failed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The voice the model used to respond. Current voice options are `alloy`, `ash`,
+        # `ballad`, `coral`, `echo`, `sage`, `shimmer`, and `verse`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponse#voice
+        module Voice
+          extend OpenAI::Internal::Type::Union
+
+          variant String
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponse::Voice::ALLOY }
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponse::Voice::ASH }
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponse::Voice::BALLAD }
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponse::Voice::CORAL }
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponse::Voice::ECHO }
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponse::Voice::SAGE }
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponse::Voice::SHIMMER }
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponse::Voice::VERSE }
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponse::Voice::MARIN }
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponse::Voice::CEDAR }
+
+          # @!method self.variants
+          #   @return [Array(String, Symbol)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(String, OpenAI::Realtime::RealtimeResponse::Voice::TaggedSymbol) }
+          end
+
+          # @!group
+
+          ALLOY = :alloy
+          ASH = :ash
+          BALLAD = :ballad
+          CORAL = :coral
+          ECHO = :echo
+          SAGE = :sage
+          SHIMMER = :shimmer
+          VERSE = :verse
+          MARIN = :marin
+          CEDAR = :cedar
+
+          # @!endgroup
+        end
+      end
+    end
+  end
+end