openai 0.86.0 → 0.88.0

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

@@ -55,21 +55,29 @@ module OpenAI
         # @!method initialize(id:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, type: :mcp_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 id [String]
+        #     The unique ID of the tool call.
         #
-        #   @param arguments [String] A JSON string of the arguments passed to the tool.
+        #   @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 name [String]
+        #     The name of the tool that was run.
         #
-        #   @param server_label [String] The label of the MCP server running the tool.
+        #   @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 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 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 output [String, nil]
+        #     The output from the tool call.
         #
-        #   @param type [Symbol, :mcp_call] The type of the item. Always `mcp_call`.
+        #   @param type [Symbol, :mcp_call]
+        #     The type of the item. Always `mcp_call`.
 
         # The error from the tool call, if any.
         #

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

@@ -12,12 +12,11 @@ module OpenAI
         optional :effort, enum: -> { OpenAI::Realtime::RealtimeReasoningEffort }
 
         # @!method initialize(effort: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeReasoning} for more details.
-        #
         #   Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.
         #
-        #   @param effort [Symbol, OpenAI::Models::Realtime::RealtimeReasoningEffort] Constrains effort on reasoning for reasoning-capable Realtime models such as
+        #   @param effort [Symbol, OpenAI::Models::Realtime::RealtimeReasoningEffort]
+        #     Constrains effort on reasoning for reasoning-capable Realtime models such as
+        #     `gpt-realtime-2`.
       end
     end
   end

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

@@ -92,32 +92,58 @@ module OpenAI
         optional :usage, -> { OpenAI::Realtime::RealtimeResponseUsage }
 
         # @!method initialize(id: nil, audio: nil, conversation_id: nil, max_output_tokens: nil, metadata: nil, object: nil, output: nil, output_modalities: nil, status: nil, status_details: nil, usage: 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, will look like `resp_1234`.
+        #   @param id [String]
+        #     The unique ID of the response, will look like `resp_1234`.
+        #
+        #   @param audio [OpenAI::Models::Realtime::RealtimeResponse::Audio]
+        #     Configuration for audio output.
         #
-        #   @param audio [OpenAI::Models::Realtime::RealtimeResponse::Audio] Configuration for audio output.
+        #   @param conversation_id [String]
+        #     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
+        #     automatically by VAD the response will be added to the default conversation
         #
-        #   @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, inclusive of
+        #     tool calls, that was used in this response.
         #
-        #   @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 useful
+        #     for storing additional information about the object in a structured format, and
+        #     querying for objects via API or the dashboard.
         #
-        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+        #     Keys are strings with a maximum length of 64 characters. Values are strings with
+        #     a maximum length of 512 characters.
         #
-        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeResponse::Object] The object type, must be `realtime.response`.
+        #   @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 [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_modalities [Array<Symbol, OpenAI::Models::Realtime::RealtimeResponse::OutputModality>] The set of modalities the model used to respond, currently the only possible val
+        #   @param output_modalities [Array<Symbol, OpenAI::Models::Realtime::RealtimeResponse::OutputModality>]
+        #     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.
         #
-        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeResponse::Status] The final status of the response (`completed`, `cancelled`, `failed`, or
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeResponse::Status]
+        #     The final status of the response (`completed`, `cancelled`, `failed`, or
+        #     `incomplete`, `in_progress`).
         #
-        #   @param status_details [OpenAI::Models::Realtime::RealtimeResponseStatus] Additional details about the status.
+        #   @param status_details [OpenAI::Models::Realtime::RealtimeResponseStatus]
+        #     Additional details about the status.
         #
-        #   @param usage [OpenAI::Models::Realtime::RealtimeResponseUsage] Usage statistics for the Response, this will correspond to billing. A
+        #   @param usage [OpenAI::Models::Realtime::RealtimeResponseUsage]
+        #     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.
 
         # @see OpenAI::Models::Realtime::RealtimeResponse#audio
         class Audio < OpenAI::Internal::Type::BaseModel
@@ -149,12 +175,14 @@ module OpenAI
             optional :voice, union: -> { OpenAI::Realtime::RealtimeResponse::Audio::Output::Voice }
 
             # @!method initialize(format_: nil, voice: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::RealtimeResponse::Audio::Output} for more details.
-            #
-            #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA] The format of the output audio.
+            #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA]
+            #     The format of the output audio.
             #
-            #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeResponse::Audio::Output::Voice] The voice the model uses to respond. Voice cannot be changed during the
+            #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeResponse::Audio::Output::Voice]
+            #     The voice the model uses to respond. Voice cannot be changed during the session
+            #     once the model has responded with audio at least once. Current voice options are
+            #     `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`,
+            #     and `cedar`. We recommend `marin` and `cedar` for best quality.
 
             # The voice the model uses to respond. Voice cannot be changed during the session
             # once the model has responded with audio at least once. Current voice options are

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

@@ -34,13 +34,16 @@ module OpenAI
           optional :voice, union: -> { OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice }
 
           # @!method initialize(format_: nil, voice: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output} for more
-          #   details.
+          #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA]
+          #     The format of the output audio.
           #
-          #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA] The format of the output audio.
-          #
-          #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice] The voice the model uses to respond. Supported built-in voices are
+          #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice]
+          #     The voice the model uses to respond. Supported built-in voices are `alloy`,
+          #     `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
+          #     `cedar`. You may also provide a custom voice object with an `id`, for example
+          #     `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+          #     model has responded with audio at least once. We recommend `marin` and `cedar`
+          #     for best quality.
 
           # The voice the model uses to respond. Supported built-in voices are `alloy`,
           # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
@@ -88,7 +91,8 @@ module OpenAI
               # @!method initialize(id:)
               #   Custom voice reference.
               #
-              #   @param id [String] The custom voice ID, e.g. `voice_1234`.
+              #   @param id [String]
+              #     The custom voice ID, e.g. `voice_1234`.
             end
 
             # @!method self.variants

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

@@ -50,7 +50,7 @@ module OpenAI
         #   Identifier for service connectors, like those available in ChatGPT. One of
         #   `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
         #   service connectors
-        #   [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+        #   [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
         #
         #   Currently supported `connector_id` values are:
         #
@@ -110,37 +110,64 @@ module OpenAI
         optional :tunnel_id, String
 
         # @!method initialize(server_label:, allowed_callers: nil, allowed_tools: nil, authorization: nil, connector_id: nil, defer_loading: nil, headers: nil, require_approval: nil, server_description: nil, server_url: nil, tunnel_id: 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).
+        #   [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
         #
-        #   @param server_label [String] A label for this MCP server, used to identify it in tool calls.
+        #   @param server_label [String]
+        #     A label for this MCP server, used to identify it in tool calls.
         #
-        #   @param allowed_callers [Array<Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::AllowedCaller>, nil] The tool invocation context(s).
+        #   @param allowed_callers [Array<Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::AllowedCaller>, nil]
+        #     The tool invocation context(s).
         #
-        #   @param allowed_tools [Array<String>, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::AllowedTools::McpToolFilter, nil] List of allowed tool names or a filter object.
+        #   @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 authorization [String]
+        #     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.
         #
-        #   @param connector_id [Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::ConnectorID] Identifier for service connectors, like those available in ChatGPT. One of
+        #   @param connector_id [Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::ConnectorID]
+        #     Identifier for service connectors, like those available in ChatGPT. One of
+        #     `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
+        #     service connectors
+        #     [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
         #
-        #   @param defer_loading [Boolean] Whether this MCP tool is deferred and discovered via tool search.
+        #     Currently supported `connector_id` values are:
         #
-        #   @param headers [Hash{Symbol=>String}, nil] Optional HTTP headers to send to the MCP server. Use for authentication
+        #     - 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`
         #
-        #   @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 defer_loading [Boolean]
+        #     Whether this MCP tool is deferred and discovered via tool search.
         #
-        #   @param server_description [String] Optional description of the MCP server, used to provide more context.
+        #   @param headers [Hash{Symbol=>String}, nil]
+        #     Optional HTTP headers to send to the MCP server. Use for authentication or other
+        #     purposes.
         #
-        #   @param server_url [String] The URL for the MCP server. One of `server_url`, `connector_id`, or
+        #   @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 tunnel_id [String] The Secure MCP Tunnel ID to use instead of a direct server URL. One of
+        #   @param server_description [String]
+        #     Optional description of the MCP server, used to provide more context.
         #
-        #   @param type [Symbol, :mcp] The type of the MCP tool. Always `mcp`.
-
+        #   @param server_url [String]
+        #     The URL for the MCP server. One of `server_url`, `connector_id`, or `tunnel_id`
+        #     must be provided.
+        #
+        #   @param tunnel_id [String]
+        #     The Secure MCP Tunnel ID to use instead of a direct server URL. One of
+        #     `server_url`, `connector_id`, or `tunnel_id` must be provided.
+        #
+        #   @param type [Symbol, :mcp]
+        #     The type of the MCP tool. Always `mcp`.
         module AllowedCaller
           extend OpenAI::Internal::Type::Enum
 
@@ -180,15 +207,16 @@ module OpenAI
             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 read_only [Boolean]
+            #     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.
             #
-            #   @param tool_names [Array<String>] List of allowed tool names.
+            #   @param tool_names [Array<String>]
+            #     List of allowed tool names.
           end
 
           # @!method self.variants
@@ -201,7 +229,7 @@ module OpenAI
         # Identifier for service connectors, like those available in ChatGPT. One of
         # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
         # service connectors
-        # [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+        # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
         #
         # Currently supported `connector_id` values are:
         #
@@ -267,16 +295,14 @@ module OpenAI
             )
 
             # @!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 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.
+            #   @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
@@ -296,15 +322,16 @@ module OpenAI
               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 read_only [Boolean]
+              #     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.
               #
-              #   @param tool_names [Array<String>] List of allowed tool names.
+              #   @param tool_names [Array<String>]
+              #     List of allowed tool names.
             end
 
             # @see OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool::RequireApproval::McpToolApprovalFilter#never
@@ -325,15 +352,16 @@ module OpenAI
               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 read_only [Boolean]
+              #     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.
               #
-              #   @param tool_names [Array<String>] List of allowed tool names.
+              #   @param tool_names [Array<String>]
+              #     List of allowed tool names.
             end
           end
 

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

@@ -84,7 +84,7 @@ module OpenAI
 
         # @!attribute prompt
         #   Reference to a prompt template and its variables.
-        #   [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        #   [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
         #
         #   @return [OpenAI::Models::Responses::ResponsePrompt, nil]
         optional :prompt, -> { OpenAI::Responses::ResponsePrompt }, nil?: true
@@ -112,34 +112,72 @@ module OpenAI
         )
 
         # @!method initialize(audio: nil, conversation: nil, input: nil, instructions: nil, max_output_tokens: nil, metadata: nil, output_modalities: nil, parallel_tool_calls: nil, prompt: nil, reasoning: 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 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 `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.
         #
-        #   @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 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.
         #
-        #   @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.
+        #     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.
         #
-        #   @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, 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`.
         #
-        #   @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 useful
+        #     for storing additional information about the object in a structured format, and
+        #     querying for objects via API or the dashboard.
         #
-        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+        #     Keys are strings with a maximum length of 64 characters. Values are strings with
+        #     a maximum length of 512 characters.
         #
-        #   @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 output_modalities [Array<Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateParams::OutputModality>]
+        #     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.
         #
-        #   @param parallel_tool_calls [Boolean] Whether the model may call multiple tools in parallel. Only supported by
+        #   @param parallel_tool_calls [Boolean]
+        #     Whether the model may call multiple tools in parallel. Only supported by
+        #     reasoning Realtime models such as `gpt-realtime-2`.
         #
-        #   @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
+        #   @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil]
+        #     Reference to a prompt template and its variables.
+        #     [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
         #
-        #   @param reasoning [OpenAI::Models::Realtime::RealtimeReasoning] Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.
+        #   @param reasoning [OpenAI::Models::Realtime::RealtimeReasoning]
+        #     Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.
         #
-        #   @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 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
+        #     function/MCP tool.
         #
-        #   @param tools [Array<OpenAI::Models::Realtime::RealtimeFunctionTool, OpenAI::Models::Realtime::RealtimeResponseCreateMcpTool>] Tools available to the model.
+        #   @param tools [Array<OpenAI::Models::Realtime::RealtimeFunctionTool, 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
@@ -227,14 +265,14 @@ module OpenAI
 
         # 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).
+        # [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
         module Tool
           extend OpenAI::Internal::Type::Union
 
           variant -> { OpenAI::Realtime::RealtimeFunctionTool }
 
           # 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).
+          # (MCP) servers. [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
           variant -> { OpenAI::Realtime::RealtimeResponseCreateMcpTool }
 
           # @!method self.variants

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

@@ -29,16 +29,22 @@ module OpenAI
         optional :type, enum: -> { OpenAI::Realtime::RealtimeResponseStatus::Type }
 
         # @!method initialize(error: nil, reason: nil, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeResponseStatus} for more details.
-        #
         #   Additional details about the status.
         #
-        #   @param error [OpenAI::Models::Realtime::RealtimeResponseStatus::Error] A description of the error that caused the response to fail,
+        #   @param error [OpenAI::Models::Realtime::RealtimeResponseStatus::Error]
+        #     A description of the error that caused the response to fail, populated when the
+        #     `status` is `failed`.
         #
-        #   @param reason [Symbol, OpenAI::Models::Realtime::RealtimeResponseStatus::Reason] The reason the Response did not complete. For a `cancelled` Response, one of `t
+        #   @param reason [Symbol, OpenAI::Models::Realtime::RealtimeResponseStatus::Reason]
+        #     The reason the Response did not complete. For a `cancelled` Response, one of
+        #     `turn_detected` (the server VAD detected a new start of speech) or
+        #     `client_cancelled` (the client sent a cancel event). For an `incomplete`
+        #     Response, one of `max_output_tokens` or `content_filter` (the server-side safety
+        #     filter activated and cut off the response).
         #
-        #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeResponseStatus::Type] The type of error that caused the response to fail, corresponding
+        #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeResponseStatus::Type]
+        #     The type of error that caused the response to fail, corresponding with the
+        #     `status` field (`completed`, `cancelled`, `incomplete`, `failed`).
 
         # @see OpenAI::Models::Realtime::RealtimeResponseStatus#error
         class Error < OpenAI::Internal::Type::BaseModel
@@ -58,9 +64,11 @@ module OpenAI
           #   A description of the error that caused the response to fail, populated when the
           #   `status` is `failed`.
           #
-          #   @param code [String] Error code, if any.
+          #   @param code [String]
+          #     Error code, if any.
           #
-          #   @param type [String] The type of error.
+          #   @param type [String]
+          #     The type of error.
         end
 
         # The reason the Response did not complete. For a `cancelled` Response, one of

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

@@ -41,23 +41,31 @@ module OpenAI
         optional :total_tokens, Integer
 
         # @!method initialize(input_token_details: nil, input_tokens: nil, output_token_details: nil, output_tokens: nil, total_tokens: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeResponseUsage} for more details.
-        #
         #   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.
         #
-        #   @param input_token_details [OpenAI::Models::Realtime::RealtimeResponseUsageInputTokenDetails] Details about the input tokens used in the Response. Cached tokens are tokens fr
+        #   @param input_token_details [OpenAI::Models::Realtime::RealtimeResponseUsageInputTokenDetails]
+        #     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 input_tokens [Integer] The number of input tokens used in the Response, including text and
+        #   @param input_tokens [Integer]
+        #     The number of input tokens used in the Response, including text and audio
+        #     tokens.
         #
-        #   @param output_token_details [OpenAI::Models::Realtime::RealtimeResponseUsageOutputTokenDetails] Details about the output tokens used in the Response.
+        #   @param output_token_details [OpenAI::Models::Realtime::RealtimeResponseUsageOutputTokenDetails]
+        #     Details about the output tokens used in the Response.
         #
-        #   @param output_tokens [Integer] The number of output tokens sent in the Response, including text and
+        #   @param output_tokens [Integer]
+        #     The number of output tokens sent in the Response, including text and audio
+        #     tokens.
         #
-        #   @param total_tokens [Integer] The total number of tokens in the Response including input and output
+        #   @param total_tokens [Integer]
+        #     The total number of tokens in the Response including input and output text and
+        #     audio tokens.
       end
     end
   end

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

@@ -43,15 +43,20 @@ module OpenAI
         #   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 as input for 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 as input for the Response.
         #
-        #   @param cached_tokens_details [OpenAI::Models::Realtime::RealtimeResponseUsageInputTokenDetails::CachedTokensDetails] Details about the cached tokens used as input for the Response.
+        #   @param cached_tokens_details [OpenAI::Models::Realtime::RealtimeResponseUsageInputTokenDetails::CachedTokensDetails]
+        #     Details about the cached tokens used as input for the Response.
         #
-        #   @param image_tokens [Integer] The number of image tokens used as input for 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.
+        #   @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
@@ -76,11 +81,14 @@ module OpenAI
           # @!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 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 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.
+          #   @param text_tokens [Integer]
+          #     The number of cached text tokens used as input for the Response.
         end
       end
     end