openai 0.87.0 → 0.89.0

data/lib/openai/models/responses/response_output_item.rb

@@ -13,21 +13,21 @@ module OpenAI
         variant :message, -> { OpenAI::Responses::ResponseOutputMessage }
 
         # The results of a file search tool call. See the
-        # [file search guide](https://platform.openai.com/docs/guides/tools-file-search) for more information.
+        # [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information.
         variant :file_search_call, -> { OpenAI::Responses::ResponseFileSearchToolCall }
 
         # A tool call to run a function. See the
-        # [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information.
+        # [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information.
         variant :function_call, -> { OpenAI::Responses::ResponseFunctionToolCall }
 
         variant :function_call_output, -> { OpenAI::Responses::ResponseFunctionToolCallOutputItem }
 
         # The results of a web search tool call. See the
-        # [web search guide](https://platform.openai.com/docs/guides/tools-web-search) for more information.
+        # [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.
         variant :web_search_call, -> { OpenAI::Responses::ResponseFunctionWebSearch }
 
         # A tool call to a computer use tool. See the
-        # [computer use guide](https://platform.openai.com/docs/guides/tools-computer-use) for more information.
+        # [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information.
         variant :computer_call, -> { OpenAI::Responses::ResponseComputerToolCall }
 
         variant :computer_call_output, -> { OpenAI::Responses::ResponseComputerToolCallOutputItem }
@@ -35,7 +35,7 @@ module OpenAI
         # A description of the chain of thought used by a reasoning model while generating
         # a response. Be sure to include these items in your `input` to the Responses API
         # for subsequent turns of a conversation if you are manually
-        # [managing context](https://platform.openai.com/docs/guides/conversation-state).
+        # [managing context](https://developers.openai.com/api/docs/guides/conversation-state).
         variant :reasoning, -> { OpenAI::Responses::ResponseReasoningItem }
 
         variant :program, -> { OpenAI::Responses::ResponseOutputItem::Program }
@@ -48,7 +48,7 @@ module OpenAI
 
         variant :additional_tools, -> { OpenAI::Responses::ResponseOutputItem::AdditionalTools }
 
-        # A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
+        # A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).
         variant :compaction, -> { OpenAI::Responses::ResponseCompactionItem }
 
         # An image generation request made by the model.
@@ -125,15 +125,20 @@ module OpenAI
           required :type, const: :program
 
           # @!method initialize(id:, call_id:, code:, fingerprint:, type: :program)
-          #   @param id [String] The unique ID of the program item.
+          #   @param id [String]
+          #     The unique ID of the program item.
           #
-          #   @param call_id [String] The stable call ID of the program item.
+          #   @param call_id [String]
+          #     The stable call ID of the program item.
           #
-          #   @param code [String] The JavaScript source executed by programmatic tool calling.
+          #   @param code [String]
+          #     The JavaScript source executed by programmatic tool calling.
           #
-          #   @param fingerprint [String] Opaque program replay fingerprint that must be round-tripped.
+          #   @param fingerprint [String]
+          #     Opaque program replay fingerprint that must be round-tripped.
           #
-          #   @param type [Symbol, :program] The type of the item. Always `program`.
+          #   @param type [Symbol, :program]
+          #     The type of the item. Always `program`.
         end
 
         class ProgramOutput < OpenAI::Internal::Type::BaseModel
@@ -168,15 +173,20 @@ module OpenAI
           required :type, const: :program_output
 
           # @!method initialize(id:, call_id:, result:, status:, type: :program_output)
-          #   @param id [String] The unique ID of the program output item.
+          #   @param id [String]
+          #     The unique ID of the program output item.
           #
-          #   @param call_id [String] The call ID of the program item.
+          #   @param call_id [String]
+          #     The call ID of the program item.
           #
-          #   @param result [String] The result produced by the program item.
+          #   @param result [String]
+          #     The result produced by the program item.
           #
-          #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput::Status] The terminal status of the program output item.
+          #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput::Status]
+          #     The terminal status of the program output item.
           #
-          #   @param type [Symbol, :program_output] The type of the item. Always `program_output`.
+          #   @param type [Symbol, :program_output]
+          #     The type of the item. Always `program_output`.
 
           # The terminal status of the program output item.
           #
@@ -218,13 +228,17 @@ module OpenAI
           required :type, const: :additional_tools
 
           # @!method initialize(id:, role:, tools:, type: :additional_tools)
-          #   @param id [String] The unique ID of the additional tools item.
+          #   @param id [String]
+          #     The unique ID of the additional tools item.
           #
-          #   @param role [Symbol, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools::Role] The role that provided the additional tools.
+          #   @param role [Symbol, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools::Role]
+          #     The role that provided the additional tools.
           #
-          #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] The additional tool definitions made available at this item.
+          #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ProgrammaticToolCalling, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
+          #     The additional tool definitions made available at this item.
           #
-          #   @param type [Symbol, :additional_tools] The type of the item. Always `additional_tools`.
+          #   @param type [Symbol, :additional_tools]
+          #     The type of the item. Always `additional_tools`.
 
           # The role that provided the additional tools.
           #
@@ -271,6 +285,36 @@ module OpenAI
           #   @return [Symbol, :image_generation_call]
           required :type, const: :image_generation_call
 
+          # @!attribute action
+          #   The action used for image generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Action, nil]
+          optional(
+            :action,
+            enum: -> { OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Action },
+            nil?: true
+          )
+
+          # @!attribute background
+          #   The background setting used for generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Background, nil]
+          optional(
+            :background,
+            enum: -> { OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Background },
+            nil?: true
+          )
+
+          # @!attribute output_format
+          #   The output format used for generation.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat, nil]
+          optional(
+            :output_format,
+            enum: -> { OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat },
+            nil?: true
+          )
+
           # @!attribute quality
           #   The quality of the image generated by the image generation tool call. One of
           #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
@@ -282,6 +326,12 @@ module OpenAI
             nil?: true
           )
 
+          # @!attribute revised_prompt
+          #   The prompt that was used after any model prompt rewriting.
+          #
+          #   @return [String, nil]
+          optional :revised_prompt, String, nil?: true
+
           # @!attribute size
           #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
@@ -294,24 +344,39 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(id:, result:, status:, quality: nil, size: nil, type: :image_generation_call)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall} for more
-          #   details.
-          #
+          # @!method initialize(id:, result:, status:, action: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
           #   An image generation request made by the model.
           #
-          #   @param id [String] The unique ID of the image generation call.
+          #   @param id [String]
+          #     The unique ID of the image generation call.
+          #
+          #   @param result [String, nil]
+          #     The generated image encoded in base64.
+          #
+          #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Status]
+          #     The status of the image generation call.
           #
-          #   @param result [String, nil] The generated image encoded in base64.
+          #   @param action [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Action, nil]
+          #     The action used for image generation.
           #
-          #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Status] The status of the image generation call.
+          #   @param background [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Background, nil]
+          #     The background setting used for generation.
           #
-          #   @param quality [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Quality, nil] The quality of the image generated by the image generation tool call. One of `lo
+          #   @param output_format [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::OutputFormat, nil]
+          #     The output format used for generation.
           #
-          #   @param size [String, Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Size, nil] The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #   @param quality [Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Quality, nil]
+          #     The quality of the image generated by the image generation tool call. One of
+          #     `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #
-          #   @param type [Symbol, :image_generation_call] The type of the image generation call. Always `image_generation_call`.
+          #   @param revised_prompt [String, nil]
+          #     The prompt that was used after any model prompt rewriting.
+          #
+          #   @param size [String, Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Size, nil]
+          #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
+          #   @param type [Symbol, :image_generation_call]
+          #     The type of the image generation call. Always `image_generation_call`.
 
           # The status of the image generation call.
           #
@@ -328,6 +393,48 @@ module OpenAI
             #   @return [Array<Symbol>]
           end
 
+          # The action used for image generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall#action
+          module Action
+            extend OpenAI::Internal::Type::Enum
+
+            GENERATE = :generate
+            EDIT = :edit
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The background setting used for generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall#background
+          module Background
+            extend OpenAI::Internal::Type::Enum
+
+            TRANSPARENT = :transparent
+            OPAQUE = :opaque
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The output format used for generation.
+          #
+          # @see OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall#output_format
+          module OutputFormat
+            extend OpenAI::Internal::Type::Enum
+
+            PNG = :png
+            WEBP = :webp
+            JPEG = :jpeg
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # The quality of the image generated by the image generation tool call. One of
           # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #
@@ -417,21 +524,22 @@ module OpenAI
           required :type, const: :local_shell_call
 
           # @!method initialize(id:, action:, call_id:, status:, type: :local_shell_call)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall} for more
-          #   details.
-          #
           #   A tool call to run a command on the local shell.
           #
-          #   @param id [String] The unique ID of the local shell call.
+          #   @param id [String]
+          #     The unique ID of the local shell call.
           #
-          #   @param action [OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall::Action] Execute a shell command on the server.
+          #   @param action [OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall::Action]
+          #     Execute a shell command on the server.
           #
-          #   @param call_id [String] The unique ID of the local shell tool call generated by the model.
+          #   @param call_id [String]
+          #     The unique ID of the local shell tool call generated by the model.
           #
-          #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall::Status] The status of the local shell call.
+          #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall::Status]
+          #     The status of the local shell call.
           #
-          #   @param type [Symbol, :local_shell_call] The type of the local shell call. Always `local_shell_call`.
+          #   @param type [Symbol, :local_shell_call]
+          #     The type of the local shell call. Always `local_shell_call`.
 
           # @see OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall#action
           class Action < OpenAI::Internal::Type::BaseModel
@@ -474,17 +582,23 @@ module OpenAI
             # @!method initialize(command:, env:, timeout_ms: nil, user: nil, working_directory: nil, type: :exec)
             #   Execute a shell command on the server.
             #
-            #   @param command [Array<String>] The command to run.
+            #   @param command [Array<String>]
+            #     The command to run.
             #
-            #   @param env [Hash{Symbol=>String}] Environment variables to set for the command.
+            #   @param env [Hash{Symbol=>String}]
+            #     Environment variables to set for the command.
             #
-            #   @param timeout_ms [Integer, nil] Optional timeout in milliseconds for the command.
+            #   @param timeout_ms [Integer, nil]
+            #     Optional timeout in milliseconds for the command.
             #
-            #   @param user [String, nil] Optional user to run the command as.
+            #   @param user [String, nil]
+            #     Optional user to run the command as.
             #
-            #   @param working_directory [String, nil] Optional working directory to run the command in.
+            #   @param working_directory [String, nil]
+            #     Optional working directory to run the command in.
             #
-            #   @param type [Symbol, :exec] The type of the local shell action. Always `exec`.
+            #   @param type [Symbol, :exec]
+            #     The type of the local shell action. Always `exec`.
           end
 
           # The status of the local shell call.
@@ -532,19 +646,19 @@ module OpenAI
           )
 
           # @!method initialize(id:, output:, status: nil, type: :local_shell_call_output)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput} for more
-          #   details.
-          #
           #   The output of a local shell tool call.
           #
-          #   @param id [String] The unique ID of the local shell tool call generated by the model.
+          #   @param id [String]
+          #     The unique ID of the local shell tool call generated by the model.
           #
-          #   @param output [String] A JSON string of the output of the local shell tool call.
+          #   @param output [String]
+          #     A JSON string of the output of the local shell tool call.
           #
-          #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput::Status, nil] The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+          #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput::Status, nil]
+          #     The status of the item. One of `in_progress`, `completed`, or `incomplete`.
           #
-          #   @param type [Symbol, :local_shell_call_output] The type of the local shell tool call output. Always `local_shell_call_output`.
+          #   @param type [Symbol, :local_shell_call_output]
+          #     The type of the local shell tool call output. Always `local_shell_call_output`.
 
           # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
           #
@@ -620,28 +734,37 @@ module OpenAI
           optional :status, enum: -> { OpenAI::Responses::ResponseOutputItem::McpCall::Status }
 
           # @!method initialize(id:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseOutputItem::McpCall} for more details.
-          #
           #   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] Unique identifier for the MCP tool call approval request.
+          #   @param approval_request_id [String, nil]
+          #     Unique identifier for the MCP tool call approval request. Include this value in
+          #     a subsequent `mcp_approval_response` input to approve or reject the
+          #     corresponding tool call.
           #
-          #   @param error [OpenAI::Models::Responses::McpToolCallError::McpProtocolError, OpenAI::Models::Responses::McpToolCallError::McpToolExecutionError, OpenAI::Models::Responses::McpToolCallError::HTTPError, nil] The error from the tool call, if any.
+          #   @param error [OpenAI::Models::Responses::McpToolCallError::McpProtocolError, OpenAI::Models::Responses::McpToolCallError::McpToolExecutionError, OpenAI::Models::Responses::McpToolCallError::HTTPError, 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 status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::McpCall::Status] The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `c
+          #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::McpCall::Status]
+          #     The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          #     `calling`, or `failed`.
           #
-          #   @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 status of the tool call. One of `in_progress`, `completed`, `incomplete`,
           # `calling`, or `failed`.
@@ -696,21 +819,22 @@ module OpenAI
           optional :error, String, nil?: true
 
           # @!method initialize(id:, server_label:, tools:, error: nil, type: :mcp_list_tools)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseOutputItem::McpListTools} for more details.
-          #
           #   A list of tools available on an MCP server.
           #
-          #   @param id [String] The unique ID of the list.
+          #   @param id [String]
+          #     The unique ID of the list.
           #
-          #   @param server_label [String] The label of the MCP server.
+          #   @param server_label [String]
+          #     The label of the MCP server.
           #
-          #   @param tools [Array<OpenAI::Models::Responses::ResponseOutputItem::McpListTools::Tool>] The tools available on the server.
+          #   @param tools [Array<OpenAI::Models::Responses::ResponseOutputItem::McpListTools::Tool>]
+          #     The tools available on the server.
           #
-          #   @param error [String, nil] Error message if the server could not list tools.
+          #   @param error [String, nil]
+          #     Error message if the server could not list tools.
           #
-          #   @param type [Symbol, :mcp_list_tools] The type of the item. Always `mcp_list_tools`.
-
+          #   @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.
@@ -737,19 +861,19 @@ module OpenAI
             optional :description, String, nil?: true
 
             # @!method initialize(input_schema:, name:, annotations: nil, description: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Responses::ResponseOutputItem::McpListTools::Tool} for more
-            #   details.
-            #
             #   A tool available on an MCP server.
             #
-            #   @param input_schema [Object] The JSON schema describing the tool's input.
+            #   @param input_schema [Object]
+            #     The JSON schema describing the tool's input.
             #
-            #   @param name [String] The name of the tool.
+            #   @param name [String]
+            #     The name of the tool.
             #
-            #   @param annotations [Object, nil] Additional annotations about the tool.
+            #   @param annotations [Object, nil]
+            #     Additional annotations about the tool.
             #
-            #   @param description [String, nil] The description of the tool.
+            #   @param description [String, nil]
+            #     The description of the tool.
           end
         end
 
@@ -785,21 +909,22 @@ module OpenAI
           required :type, const: :mcp_approval_request
 
           # @!method initialize(id:, arguments:, name:, server_label:, type: :mcp_approval_request)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest} for more
-          #   details.
-          #
           #   A request for human approval of a tool invocation.
           #
-          #   @param id [String] The unique ID of the approval request.
+          #   @param id [String]
+          #     The unique ID of the approval request.
           #
-          #   @param arguments [String] A JSON string of arguments for the tool.
+          #   @param arguments [String]
+          #     A JSON string of arguments for the tool.
           #
-          #   @param name [String] The name of the tool to run.
+          #   @param name [String]
+          #     The name of the tool to run.
           #
-          #   @param server_label [String] The label of the MCP server making the request.
+          #   @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`.
+          #   @param type [Symbol, :mcp_approval_request]
+          #     The type of the item. Always `mcp_approval_request`.
         end
 
         class McpApprovalResponse < OpenAI::Internal::Type::BaseModel
@@ -834,21 +959,22 @@ module OpenAI
           optional :reason, String, nil?: true
 
           # @!method initialize(id:, approval_request_id:, approve:, reason: nil, type: :mcp_approval_response)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse} for more
-          #   details.
-          #
           #   A response to an MCP approval request.
           #
-          #   @param id [String] The unique ID of the approval response
+          #   @param id [String]
+          #     The unique ID of the approval response
           #
-          #   @param approval_request_id [String] The ID of the approval request being answered.
+          #   @param approval_request_id [String]
+          #     The ID of the approval request being answered.
           #
-          #   @param approve [Boolean] Whether the request was approved.
+          #   @param approve [Boolean]
+          #     Whether the request was approved.
           #
-          #   @param reason [String, nil] Optional reason for the decision.
+          #   @param reason [String, nil]
+          #     Optional reason for the decision.
           #
-          #   @param type [Symbol, :mcp_approval_response] The type of the item. Always `mcp_approval_response`.
+          #   @param type [Symbol, :mcp_approval_response]
+          #     The type of the item. Always `mcp_approval_response`.
         end
 
         # @!method self.variants

data/lib/openai/models/responses/response_output_item_added_event.rb

@@ -32,18 +32,22 @@ module OpenAI
         required :type, const: :"response.output_item.added"
 
         # @!method initialize(item:, output_index:, sequence_number:, type: :"response.output_item.added")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseOutputItemAddedEvent} for more details.
-        #
         #   Emitted when a new output item is added.
         #
-        #   @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem] The output item that was added. For reasoning items, `encrypted_content`
+        #   @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem]
+        #     The output item that was added. For reasoning items, `encrypted_content` may be
+        #     incomplete while the item is in progress. Use the reasoning item from the
+        #     corresponding `response.output_item.done` event when passing it as input to a
+        #     subsequent request.
         #
-        #   @param output_index [Integer] The index of the output item that was added.
+        #   @param output_index [Integer]
+        #     The index of the output item that was added.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param type [Symbol, :"response.output_item.added"] The type of the event. Always `response.output_item.added`.
+        #   @param type [Symbol, :"response.output_item.added"]
+        #     The type of the event. Always `response.output_item.added`.
       end
     end
   end

data/lib/openai/models/responses/response_output_item_done_event.rb

@@ -29,18 +29,19 @@ module OpenAI
         required :type, const: :"response.output_item.done"
 
         # @!method initialize(item:, output_index:, sequence_number:, type: :"response.output_item.done")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseOutputItemDoneEvent} for more details.
-        #
         #   Emitted when an output item is marked done.
         #
-        #   @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem] The output item that was marked done.
+        #   @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem]
+        #     The output item that was marked done.
         #
-        #   @param output_index [Integer] The index of the output item that was marked done.
+        #   @param output_index [Integer]
+        #     The index of the output item that was marked done.
         #
-        #   @param sequence_number [Integer] The sequence number of this event.
+        #   @param sequence_number [Integer]
+        #     The sequence number of this event.
         #
-        #   @param type [Symbol, :"response.output_item.done"] The type of the event. Always `response.output_item.done`.
+        #   @param type [Symbol, :"response.output_item.done"]
+        #     The type of the event. Always `response.output_item.done`.
       end
     end
   end

data/lib/openai/models/responses/response_output_message.rb

@@ -48,22 +48,29 @@ module OpenAI
         optional :phase, enum: -> { OpenAI::Responses::ResponseOutputMessage::Phase }, nil?: true
 
         # @!method initialize(id:, content:, status:, phase: nil, role: :assistant, type: :message)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseOutputMessage} for more details.
-        #
         #   An output message from the model.
         #
-        #   @param id [String] The unique ID of the output message.
+        #   @param id [String]
+        #     The unique ID of the output message.
         #
-        #   @param content [Array<OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal>] The content of the output message.
+        #   @param content [Array<OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal>]
+        #     The content of the output message.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Status] The status of the message input. One of `in_progress`, `completed`, or
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Status]
+        #     The status of the message input. One of `in_progress`, `completed`, or
+        #     `incomplete`. Populated when input items are returned via API.
         #
-        #   @param phase [Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Phase, nil] Labels an `assistant` message as intermediate commentary (`commentary`) or the f
+        #   @param phase [Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Phase, nil]
+        #     Labels an `assistant` message as intermediate commentary (`commentary`) or the
+        #     final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
+        #     sending follow-up requests, preserve and resend phase on all assistant messages
+        #     — dropping it can degrade performance. Not used for user messages.
         #
-        #   @param role [Symbol, :assistant] The role of the output message. Always `assistant`.
+        #   @param role [Symbol, :assistant]
+        #     The role of the output message. Always `assistant`.
         #
-        #   @param type [Symbol, :message] The type of the output message. Always `message`.
+        #   @param type [Symbol, :message]
+        #     The type of the output message. Always `message`.
 
         # A text output from the model.
         module Content

data/lib/openai/models/responses/response_output_refusal.rb

@@ -19,9 +19,11 @@ module OpenAI
         # @!method initialize(refusal:, type: :refusal)
         #   A refusal from the model.
         #
-        #   @param refusal [String] The refusal explanation from the model.
+        #   @param refusal [String]
+        #     The refusal explanation from the model.
         #
-        #   @param type [Symbol, :refusal] The type of the refusal. Always `refusal`.
+        #   @param type [Symbol, :refusal]
+        #     The type of the refusal. Always `refusal`.
       end
     end
   end