openai 0.22.1 → 0.23.0

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

@@ -0,0 +1,310 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeResponseCreateMcpTool < OpenAI::Internal::Type::BaseModel
+        # @!attribute server_label
+        #   A label for this MCP server, used to identify it in tool calls.
+        #
+        #   @return [String]
+        required :server_label, String
+
+        # @!attribute type
+        #   The type of the MCP tool. Always `mcp`.
+        #
+        #   @return [Symbol, :mcp]
+        required :type, const: :mcp
+
+        # @!attribute allowed_tools
+        #   List of allowed tool names or a filter object.
+        #
+        #   @return [Array<String>, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::AllowedTools::McpToolFilter, nil]
+        optional :allowed_tools,
+                 union: -> { OpenAI::Realtime::RealtimeResponseCreateMcpTool::AllowedTools },
+                 nil?: true
+
+        # @!attribute authorization
+        #   An OAuth access token that can be used with a remote MCP server, either with a
+        #   custom MCP server URL or a service connector. Your application must handle the
+        #   OAuth authorization flow and provide the token here.
+        #
+        #   @return [String, nil]
+        optional :authorization, String
+
+        # @!attribute connector_id
+        #   Identifier for service connectors, like those available in ChatGPT. One of
+        #   `server_url` or `connector_id` must be provided. Learn more about service
+        #   connectors
+        #   [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+        #
+        #   Currently supported `connector_id` values are:
+        #
+        #   - Dropbox: `connector_dropbox`
+        #   - Gmail: `connector_gmail`
+        #   - Google Calendar: `connector_googlecalendar`
+        #   - Google Drive: `connector_googledrive`
+        #   - Microsoft Teams: `connector_microsoftteams`
+        #   - Outlook Calendar: `connector_outlookcalendar`
+        #   - Outlook Email: `connector_outlookemail`
+        #   - SharePoint: `connector_sharepoint`
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::ConnectorID, nil]
+        optional :connector_id, enum: -> { OpenAI::Realtime::RealtimeResponseCreateMcpTool::ConnectorID }
+
+        # @!attribute headers
+        #   Optional HTTP headers to send to the MCP server. Use for authentication or other
+        #   purposes.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :headers, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+        # @!attribute require_approval
+        #   Specify which of the MCP server's tools require approval.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalSetting, nil]
+        optional :require_approval,
+                 union: -> { OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval },
+                 nil?: true
+
+        # @!attribute server_description
+        #   Optional description of the MCP server, used to provide more context.
+        #
+        #   @return [String, nil]
+        optional :server_description, String
+
+        # @!attribute server_url
+        #   The URL for the MCP server. One of `server_url` or `connector_id` must be
+        #   provided.
+        #
+        #   @return [String, nil]
+        optional :server_url, String
+
+        # @!method initialize(server_label:, allowed_tools: nil, authorization: nil, connector_id: nil, headers: nil, require_approval: nil, server_description: nil, server_url: nil, type: :mcp)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool} for more details.
+        #
+        #   Give the model access to additional tools via remote Model Context Protocol
+        #   (MCP) servers.
+        #   [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+        #
+        #   @param server_label [String] A label for this MCP server, used to identify it in tool calls.
+        #
+        #   @param allowed_tools [Array<String>, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::AllowedTools::McpToolFilter, nil] List of allowed tool names or a filter object.
+        #
+        #   @param authorization [String] An OAuth access token that can be used with a remote MCP server, either
+        #
+        #   @param connector_id [Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::ConnectorID] Identifier for service connectors, like those available in ChatGPT. One of
+        #
+        #   @param headers [Hash{Symbol=>String}, nil] Optional HTTP headers to send to the MCP server. Use for authentication
+        #
+        #   @param require_approval [OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalSetting, nil] Specify which of the MCP server's tools require approval.
+        #
+        #   @param server_description [String] Optional description of the MCP server, used to provide more context.
+        #
+        #   @param server_url [String] The URL for the MCP server. One of `server_url` or `connector_id` must be
+        #
+        #   @param type [Symbol, :mcp] The type of the MCP tool. Always `mcp`.
+
+        # List of allowed tool names or a filter object.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool#allowed_tools
+        module AllowedTools
+          extend OpenAI::Internal::Type::Union
+
+          # A string array of allowed tool names
+          variant -> { OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::AllowedTools::StringArray }
+
+          # A filter object to specify which tools are allowed.
+          variant -> { OpenAI::Realtime::RealtimeResponseCreateMcpTool::AllowedTools::McpToolFilter }
+
+          class McpToolFilter < OpenAI::Internal::Type::BaseModel
+            # @!attribute read_only
+            #   Indicates whether or not a tool modifies data or is read-only. If an MCP server
+            #   is
+            #   [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+            #   it will match this filter.
+            #
+            #   @return [Boolean, nil]
+            optional :read_only, OpenAI::Internal::Type::Boolean
+
+            # @!attribute tool_names
+            #   List of allowed tool names.
+            #
+            #   @return [Array<String>, nil]
+            optional :tool_names, OpenAI::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(read_only: nil, tool_names: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::AllowedTools::McpToolFilter}
+            #   for more details.
+            #
+            #   A filter object to specify which tools are allowed.
+            #
+            #   @param read_only [Boolean] Indicates whether or not a tool modifies data or is read-only. If an
+            #
+            #   @param tool_names [Array<String>] List of allowed tool names.
+          end
+
+          # @!method self.variants
+          #   @return [Array(Array<String>, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::AllowedTools::McpToolFilter)]
+
+          # @type [OpenAI::Internal::Type::Converter]
+          StringArray = OpenAI::Internal::Type::ArrayOf[String]
+        end
+
+        # Identifier for service connectors, like those available in ChatGPT. One of
+        # `server_url` or `connector_id` must be provided. Learn more about service
+        # connectors
+        # [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+        #
+        # Currently supported `connector_id` values are:
+        #
+        # - Dropbox: `connector_dropbox`
+        # - Gmail: `connector_gmail`
+        # - Google Calendar: `connector_googlecalendar`
+        # - Google Drive: `connector_googledrive`
+        # - Microsoft Teams: `connector_microsoftteams`
+        # - Outlook Calendar: `connector_outlookcalendar`
+        # - Outlook Email: `connector_outlookemail`
+        # - SharePoint: `connector_sharepoint`
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool#connector_id
+        module ConnectorID
+          extend OpenAI::Internal::Type::Enum
+
+          CONNECTOR_DROPBOX = :connector_dropbox
+          CONNECTOR_GMAIL = :connector_gmail
+          CONNECTOR_GOOGLECALENDAR = :connector_googlecalendar
+          CONNECTOR_GOOGLEDRIVE = :connector_googledrive
+          CONNECTOR_MICROSOFTTEAMS = :connector_microsoftteams
+          CONNECTOR_OUTLOOKCALENDAR = :connector_outlookcalendar
+          CONNECTOR_OUTLOOKEMAIL = :connector_outlookemail
+          CONNECTOR_SHAREPOINT = :connector_sharepoint
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Specify which of the MCP server's tools require approval.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool#require_approval
+        module RequireApproval
+          extend OpenAI::Internal::Type::Union
+
+          # Specify which of the MCP server's tools require approval. Can be
+          # `always`, `never`, or a filter object associated with tools
+          # that require approval.
+          variant -> { OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter }
+
+          # Specify a single approval policy for all tools. One of `always` or
+          # `never`. When set to `always`, all tools will require approval. When
+          # set to `never`, all tools will not require approval.
+          variant enum: -> { OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalSetting }
+
+          class McpToolApprovalFilter < OpenAI::Internal::Type::BaseModel
+            # @!attribute always
+            #   A filter object to specify which tools are allowed.
+            #
+            #   @return [OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Always, nil]
+            optional :always,
+                     -> { OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Always }
+
+            # @!attribute never
+            #   A filter object to specify which tools are allowed.
+            #
+            #   @return [OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Never, nil]
+            optional :never,
+                     -> { OpenAI::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Never }
+
+            # @!method initialize(always: nil, never: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter}
+            #   for more details.
+            #
+            #   Specify which of the MCP server's tools require approval. Can be `always`,
+            #   `never`, or a filter object associated with tools that require approval.
+            #
+            #   @param always [OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Always] A filter object to specify which tools are allowed.
+            #
+            #   @param never [OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Never] A filter object to specify which tools are allowed.
+
+            # @see OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter#always
+            class Always < OpenAI::Internal::Type::BaseModel
+              # @!attribute read_only
+              #   Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              #   is
+              #   [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              #   it will match this filter.
+              #
+              #   @return [Boolean, nil]
+              optional :read_only, OpenAI::Internal::Type::Boolean
+
+              # @!attribute tool_names
+              #   List of allowed tool names.
+              #
+              #   @return [Array<String>, nil]
+              optional :tool_names, OpenAI::Internal::Type::ArrayOf[String]
+
+              # @!method initialize(read_only: nil, tool_names: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Always}
+              #   for more details.
+              #
+              #   A filter object to specify which tools are allowed.
+              #
+              #   @param read_only [Boolean] Indicates whether or not a tool modifies data or is read-only. If an
+              #
+              #   @param tool_names [Array<String>] List of allowed tool names.
+            end
+
+            # @see OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter#never
+            class Never < OpenAI::Internal::Type::BaseModel
+              # @!attribute read_only
+              #   Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              #   is
+              #   [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              #   it will match this filter.
+              #
+              #   @return [Boolean, nil]
+              optional :read_only, OpenAI::Internal::Type::Boolean
+
+              # @!attribute tool_names
+              #   List of allowed tool names.
+              #
+              #   @return [Array<String>, nil]
+              optional :tool_names, OpenAI::Internal::Type::ArrayOf[String]
+
+              # @!method initialize(read_only: nil, tool_names: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter::Never}
+              #   for more details.
+              #
+              #   A filter object to specify which tools are allowed.
+              #
+              #   @param read_only [Boolean] Indicates whether or not a tool modifies data or is read-only. If an
+              #
+              #   @param tool_names [Array<String>] List of allowed tool names.
+            end
+          end
+
+          # Specify a single approval policy for all tools. One of `always` or `never`. When
+          # set to `always`, all tools will require approval. When set to `never`, all tools
+          # will not require approval.
+          module McpToolApprovalSetting
+            extend OpenAI::Internal::Type::Enum
+
+            ALWAYS = :always
+            NEVER = :never
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalSetting)]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeResponseCreateParams < OpenAI::Internal::Type::BaseModel
+        # @!attribute audio
+        #   Configuration for audio input and output.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput, nil]
+        optional :audio, -> { OpenAI::Realtime::RealtimeResponseCreateAudioOutput }
+
+        # @!attribute conversation
+        #   Controls which conversation the response is added to. Currently supports `auto`
+        #   and `none`, with `auto` as the default value. The `auto` value means that the
+        #   contents of the response will be added to the default conversation. Set this to
+        #   `none` to create an out-of-band response which will not add items to default
+        #   conversation.
+        #
+        #   @return [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateParams::Conversation, nil]
+        optional :conversation, union: -> { OpenAI::Realtime::RealtimeResponseCreateParams::Conversation }
+
+        # @!attribute input
+        #   Input items to include in the prompt for the model. Using this field creates a
+        #   new context for this Response instead of using the default conversation. An
+        #   empty array `[]` will clear the context for this Response. Note that this can
+        #   include references to items that previously appeared in the session using their
+        #   id.
+        #
+        #   @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 :input, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Realtime::ConversationItem] }
+
+        # @!attribute instructions
+        #   The default system instructions (i.e. system message) prepended to model calls.
+        #   This field allows the client to guide the model on desired responses. The model
+        #   can be instructed on response content and format, (e.g. "be extremely succinct",
+        #   "act friendly", "here are examples of good responses") and on audio behavior
+        #   (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The
+        #   instructions are not guaranteed to be followed by the model, but they provide
+        #   guidance to the model on the desired behavior. Note that the server sets default
+        #   instructions which will be used if this field is not set and are visible in the
+        #   `session.created` event at the start of the session.
+        #
+        #   @return [String, nil]
+        optional :instructions, String
+
+        # @!attribute max_output_tokens
+        #   Maximum number of output tokens for a single assistant response, inclusive of
+        #   tool calls. Provide an integer between 1 and 4096 to limit output tokens, or
+        #   `inf` for the maximum available tokens for a given model. Defaults to `inf`.
+        #
+        #   @return [Integer, Symbol, :inf, nil]
+        optional :max_output_tokens, union: -> { OpenAI::Realtime::RealtimeResponseCreateParams::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 output_modalities
+        #   The set of modalities the model used to respond, currently the only possible
+        #   values are `[\"audio\"]`, `[\"text\"]`. Audio output always include a text
+        #   transcript. Setting the output to mode `text` will disable audio output from the
+        #   model.
+        #
+        #   @return [Array<Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateParams::OutputModality>, nil]
+        optional :output_modalities,
+                 -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Realtime::RealtimeResponseCreateParams::OutputModality] }
+
+        # @!attribute prompt
+        #   Reference to a prompt template and its variables.
+        #   [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        #
+        #   @return [OpenAI::Models::Responses::ResponsePrompt, nil]
+        optional :prompt, -> { OpenAI::Responses::ResponsePrompt }, nil?: true
+
+        # @!attribute tool_choice
+        #   How the model chooses tools. Provide one of the string modes or force a specific
+        #   function/MCP tool.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, nil]
+        optional :tool_choice, union: -> { OpenAI::Realtime::RealtimeResponseCreateParams::ToolChoice }
+
+        # @!attribute tools
+        #   Tools available to the model.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::Models, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool>, nil]
+        optional :tools,
+                 -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Realtime::RealtimeResponseCreateParams::Tool] }
+
+        # @!method initialize(audio: nil, conversation: nil, input: nil, instructions: nil, max_output_tokens: nil, metadata: nil, output_modalities: nil, prompt: nil, tool_choice: nil, tools: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::RealtimeResponseCreateParams} for more details.
+        #
+        #   Create a new Realtime response with these parameters
+        #
+        #   @param audio [OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput] Configuration for audio input and output.
+        #
+        #   @param conversation [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateParams::Conversation] Controls which conversation the response is added to. Currently supports
+        #
+        #   @param input [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>] Input items to include in the prompt for the model. Using this field
+        #
+        #   @param instructions [String] The default system instructions (i.e. system message) prepended to model calls.
+        #
+        #   @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 output_modalities [Array<Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateParams::OutputModality>] The set of modalities the model used to respond, currently the only possible val
+        #
+        #   @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
+        #
+        #   @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp] How the model chooses tools. Provide one of the string modes or force a specific
+        #
+        #   @param tools [Array<OpenAI::Models::Realtime::Models, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool>] Tools available to the model.
+
+        # Controls which conversation the response is added to. Currently supports `auto`
+        # and `none`, with `auto` as the default value. The `auto` value means that the
+        # contents of the response will be added to the default conversation. Set this to
+        # `none` to create an out-of-band response which will not add items to default
+        # conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponseCreateParams#conversation
+        module Conversation
+          extend OpenAI::Internal::Type::Union
+
+          variant String
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponseCreateParams::Conversation::AUTO }
+
+          variant const: -> { OpenAI::Models::Realtime::RealtimeResponseCreateParams::Conversation::NONE }
+
+          # @!method self.variants
+          #   @return [Array(String, Symbol)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(String, OpenAI::Realtime::RealtimeResponseCreateParams::Conversation::TaggedSymbol) }
+          end
+
+          # @!group
+
+          AUTO = :auto
+          NONE = :none
+
+          # @!endgroup
+        end
+
+        # Maximum number of output tokens for a single assistant response, inclusive of
+        # tool calls. Provide an integer between 1 and 4096 to limit output tokens, or
+        # `inf` for the maximum available tokens for a given model. Defaults to `inf`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponseCreateParams#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 OutputModality
+          extend OpenAI::Internal::Type::Enum
+
+          TEXT = :text
+          AUDIO = :audio
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # How the model chooses tools. Provide one of the string modes or force a specific
+        # function/MCP tool.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeResponseCreateParams#tool_choice
+        module ToolChoice
+          extend OpenAI::Internal::Type::Union
+
+          # Controls which (if any) tool is called by the model.
+          #
+          # `none` means the model will not call any tool and instead generates a message.
+          #
+          # `auto` means the model can pick between generating a message or calling one or
+          # more tools.
+          #
+          # `required` means the model must call one or more tools.
+          variant enum: -> { OpenAI::Responses::ToolChoiceOptions }
+
+          # Use this option to force the model to call a specific function.
+          variant -> { OpenAI::Responses::ToolChoiceFunction }
+
+          # Use this option to force the model to call a specific tool on a remote MCP server.
+          variant -> { OpenAI::Responses::ToolChoiceMcp }
+
+          # @!method self.variants
+          #   @return [Array(Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp)]
+        end
+
+        # Give the model access to additional tools via remote Model Context Protocol
+        # (MCP) servers.
+        # [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+        module Tool
+          extend OpenAI::Internal::Type::Union
+
+          variant -> { OpenAI::Realtime::Models }
+
+          # Give the model access to additional tools via remote Model Context Protocol
+          # (MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+          variant -> { OpenAI::Realtime::RealtimeResponseCreateMcpTool }
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Realtime::Models, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool)]
+        end
+      end
+    end
+  end
+end

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

@@ -36,7 +36,7 @@ module OpenAI
         #
         #   @param error [OpenAI::Models::Realtime::RealtimeResponseStatus::Error] A description of the error that caused the response to fail,
         #
-        #   @param reason [Symbol, OpenAI::Models::Realtime::RealtimeResponseStatus::Reason] The reason the Response did not complete. For a `cancelled` Response,
+        #   @param reason [Symbol, OpenAI::Models::Realtime::RealtimeResponseStatus::Reason] The reason the Response did not complete. For a `cancelled` Response, one of `t
         #
         #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeResponseStatus::Type] The type of error that caused the response to fail, corresponding
 

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

@@ -5,7 +5,10 @@ module OpenAI
     module Realtime
       class RealtimeResponseUsage < OpenAI::Internal::Type::BaseModel
         # @!attribute input_token_details
-        #   Details about the input tokens used in the Response.
+        #   Details about the input tokens used in the Response. Cached tokens are tokens
+        #   from previous turns in the conversation that are included as context for the
+        #   current response. Cached tokens here are counted as a subset of input tokens,
+        #   meaning input tokens will include cached and uncached tokens.
         #
         #   @return [OpenAI::Models::Realtime::RealtimeResponseUsageInputTokenDetails, nil]
         optional :input_token_details, -> { OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails }
@@ -46,7 +49,7 @@ module OpenAI
         #   Conversation, thus output from previous turns (text and audio tokens) will
         #   become the input for later turns.
         #
-        #   @param input_token_details [OpenAI::Models::Realtime::RealtimeResponseUsageInputTokenDetails] Details about the input tokens used in the Response.
+        #   @param input_token_details [OpenAI::Models::Realtime::RealtimeResponseUsageInputTokenDetails] Details about the input tokens used in the Response. Cached tokens are tokens fr
         #
         #   @param input_tokens [Integer] The number of input tokens used in the Response, including text and
         #

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

@@ -5,31 +5,81 @@ module OpenAI
     module Realtime
       class RealtimeResponseUsageInputTokenDetails < OpenAI::Internal::Type::BaseModel
         # @!attribute audio_tokens
-        #   The number of audio tokens used in the Response.
+        #   The number of audio tokens used as input for the Response.
         #
         #   @return [Integer, nil]
         optional :audio_tokens, Integer
 
         # @!attribute cached_tokens
-        #   The number of cached tokens used in the Response.
+        #   The number of cached tokens used as input for the Response.
         #
         #   @return [Integer, nil]
         optional :cached_tokens, Integer
 
+        # @!attribute cached_tokens_details
+        #   Details about the cached tokens used as input for the Response.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeResponseUsageInputTokenDetails::CachedTokensDetails, nil]
+        optional :cached_tokens_details,
+                 -> { OpenAI::Realtime::RealtimeResponseUsageInputTokenDetails::CachedTokensDetails }
+
+        # @!attribute image_tokens
+        #   The number of image tokens used as input for the Response.
+        #
+        #   @return [Integer, nil]
+        optional :image_tokens, Integer
+
         # @!attribute text_tokens
-        #   The number of text tokens used in the Response.
+        #   The number of text tokens used as input for the Response.
         #
         #   @return [Integer, nil]
         optional :text_tokens, Integer
 
-        # @!method initialize(audio_tokens: nil, cached_tokens: nil, text_tokens: nil)
-        #   Details about the input tokens used in the Response.
+        # @!method initialize(audio_tokens: nil, cached_tokens: nil, cached_tokens_details: nil, image_tokens: nil, text_tokens: nil)
+        #   Details about the input tokens used in the Response. Cached tokens are tokens
+        #   from previous turns in the conversation that are included as context for the
+        #   current response. Cached tokens here are counted as a subset of input tokens,
+        #   meaning input tokens will include cached and uncached tokens.
+        #
+        #   @param audio_tokens [Integer] The number of audio tokens used as input for the Response.
         #
-        #   @param audio_tokens [Integer] The number of audio tokens used in the Response.
+        #   @param cached_tokens [Integer] The number of cached tokens used as input for the Response.
         #
-        #   @param cached_tokens [Integer] The number of cached tokens used in the Response.
+        #   @param cached_tokens_details [OpenAI::Models::Realtime::RealtimeResponseUsageInputTokenDetails::CachedTokensDetails] Details about the cached tokens used as input for the Response.
         #
-        #   @param text_tokens [Integer] The number of text tokens used in the Response.
+        #   @param image_tokens [Integer] The number of image tokens used as input for the Response.
+        #
+        #   @param text_tokens [Integer] The number of text tokens used as input for the Response.
+
+        # @see OpenAI::Models::Realtime::RealtimeResponseUsageInputTokenDetails#cached_tokens_details
+        class CachedTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute audio_tokens
+          #   The number of cached audio tokens used as input for the Response.
+          #
+          #   @return [Integer, nil]
+          optional :audio_tokens, Integer
+
+          # @!attribute image_tokens
+          #   The number of cached image tokens used as input for the Response.
+          #
+          #   @return [Integer, nil]
+          optional :image_tokens, Integer
+
+          # @!attribute text_tokens
+          #   The number of cached text tokens used as input for the Response.
+          #
+          #   @return [Integer, nil]
+          optional :text_tokens, Integer
+
+          # @!method initialize(audio_tokens: nil, image_tokens: nil, text_tokens: nil)
+          #   Details about the cached tokens used as input for the Response.
+          #
+          #   @param audio_tokens [Integer] The number of cached audio tokens used as input for the Response.
+          #
+          #   @param image_tokens [Integer] The number of cached image tokens used as input for the Response.
+          #
+          #   @param text_tokens [Integer] The number of cached text tokens used as input for the Response.
+        end
       end
     end
   end