openai 0.86.0 → 0.88.0

data/lib/openai/models/conversations/conversation_item.rb

@@ -5,7 +5,7 @@ module OpenAI
     module Conversations
       # A single item within a conversation. The set of possible types are the same as
       # the `output` type of a
-      # [Response object](https://platform.openai.com/docs/api-reference/responses/object#responses/object-output).
+      # [Response object](https://developers.openai.com/api/reference/resources/responses#%28resource%29%20responses%20%3E%20%28model%29%20response%20%3E%20%28schema%29%20%3E%20%28property%29%20output).
       #
       # @see OpenAI::Resources::Conversations::Items#retrieve
       module ConversationItem
@@ -17,24 +17,24 @@ module OpenAI
         variant :message, -> { OpenAI::Conversations::Message }
 
         # 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::ResponseFunctionToolCallItem }
 
         variant :function_call_output, -> { OpenAI::Responses::ResponseFunctionToolCallOutputItem }
 
         # 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 }
 
         # 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 }
 
         # An image generation request made by the model.
         variant :image_generation_call, -> { OpenAI::Conversations::ConversationItem::ImageGenerationCall }
 
         # 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 }
@@ -52,14 +52,14 @@ 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::Conversations::ConversationItem::Program }
 
         variant :program_output, -> { OpenAI::Conversations::ConversationItem::ProgramOutput }
 
-        # 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 }
 
         # A tool call to run code.
@@ -126,20 +126,48 @@ module OpenAI
           #   @return [Symbol, :image_generation_call]
           required :type, const: :image_generation_call
 
-          # @!method initialize(id:, result:, status:, type: :image_generation_call)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall} for more
-          #   details.
+          # @!attribute quality
+          #   The quality of the image generated by the image generation tool call. One of
+          #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           #
+          #   @return [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Quality, nil]
+          optional(
+            :quality,
+            enum: -> { OpenAI::Conversations::ConversationItem::ImageGenerationCall::Quality },
+            nil?: true
+          )
+
+          # @!attribute size
+          #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
+          #   @return [String, Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Size, nil]
+          optional(
+            :size,
+            union: -> { OpenAI::Conversations::ConversationItem::ImageGenerationCall::Size },
+            nil?: true
+          )
+
+          # @!method initialize(id:, result:, status:, quality: 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 result [String, nil] The generated image encoded in base64.
+          #   @param status [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Status]
+          #     The status of the image generation call.
           #
-          #   @param status [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Status] The status of the image generation call.
+          #   @param quality [Symbol, OpenAI::Models::Conversations::ConversationItem::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 size [String, Symbol, OpenAI::Models::Conversations::ConversationItem::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.
           #
@@ -155,6 +183,62 @@ module OpenAI
             # @!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`.
+          #
+          # @see OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall#quality
+          module Quality
+            extend OpenAI::Internal::Type::Enum
+
+            LOW = :low
+            MEDIUM = :medium
+            HIGH = :high
+            XHIGH = :xhigh
+            MAX = :max
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
+          # @see OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall#size
+          module Size
+            extend OpenAI::Internal::Type::Union
+
+            variant String
+
+            variant(
+              const: -> { OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Size::SIZE_1024X1024 }
+            )
+
+            variant(
+              const: -> { OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Size::SIZE_1024X1536 }
+            )
+
+            variant(
+              const: -> { OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Size::SIZE_1536X1024 }
+            )
+
+            # @!method self.variants
+            #   @return [Array(String, Symbol)]
+
+            define_sorbet_constant!(:Variants) do
+              T.type_alias {
+                T.any(String, OpenAI::Conversations::ConversationItem::ImageGenerationCall::Size::TaggedSymbol)
+              }
+            end
+
+            # @!group
+
+            SIZE_1024X1024 = :"1024x1024"
+            SIZE_1024X1536 = :"1024x1536"
+            SIZE_1536X1024 = :"1536x1024"
+
+            # @!endgroup
+          end
         end
 
         class AdditionalTools < OpenAI::Internal::Type::BaseModel
@@ -183,13 +267,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::Conversations::ConversationItem::AdditionalTools::Role] The role that provided the additional tools.
+          #   @param role [Symbol, OpenAI::Models::Conversations::ConversationItem::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.
           #
@@ -243,15 +331,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
@@ -286,15 +379,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::Conversations::ConversationItem::ProgramOutput::Status] The terminal status of the program output item.
+          #   @param status [Symbol, OpenAI::Models::Conversations::ConversationItem::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.
           #
@@ -342,21 +440,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::Conversations::ConversationItem::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::Conversations::ConversationItem::LocalShellCall::Action] Execute a shell command on the server.
+          #   @param action [OpenAI::Models::Conversations::ConversationItem::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::Conversations::ConversationItem::LocalShellCall::Status] The status of the local shell call.
+          #   @param status [Symbol, OpenAI::Models::Conversations::ConversationItem::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::Conversations::ConversationItem::LocalShellCall#action
           class Action < OpenAI::Internal::Type::BaseModel
@@ -399,17 +498,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.
@@ -457,19 +562,19 @@ module OpenAI
           )
 
           # @!method initialize(id:, output:, status: nil, type: :local_shell_call_output)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Conversations::ConversationItem::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::Conversations::ConversationItem::LocalShellCallOutput::Status, nil] The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+          #   @param status [Symbol, OpenAI::Models::Conversations::ConversationItem::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`.
           #
@@ -521,22 +626,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::Conversations::ConversationItem::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::Conversations::ConversationItem::McpListTools::Tool>] The tools available on the server.
+          #   @param tools [Array<OpenAI::Models::Conversations::ConversationItem::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.
@@ -563,19 +668,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::Conversations::ConversationItem::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
 
@@ -611,21 +716,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::Conversations::ConversationItem::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
@@ -660,21 +766,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::Conversations::ConversationItem::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
 
         class McpCall < OpenAI::Internal::Type::BaseModel
@@ -736,28 +843,37 @@ module OpenAI
           optional :status, enum: -> { OpenAI::Conversations::ConversationItem::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::Conversations::ConversationItem::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::Conversations::ConversationItem::McpCall::Status] The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `c
+          #   @param status [Symbol, OpenAI::Models::Conversations::ConversationItem::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`.

data/lib/openai/models/conversations/conversation_item_list.rb

@@ -38,15 +38,20 @@ module OpenAI
         # @!method initialize(data:, first_id:, has_more:, last_id:, object: :list)
         #   A list of Conversation items.
         #
-        #   @param data [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Conversations::ConversationItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Conversations::ConversationItem::Program, OpenAI::Models::Conversations::ConversationItem::ProgramOutput, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>] A list of conversation items.
+        #   @param data [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Conversations::ConversationItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Conversations::ConversationItem::Program, OpenAI::Models::Conversations::ConversationItem::ProgramOutput, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
+        #     A list of conversation items.
         #
-        #   @param first_id [String] The ID of the first item in the list.
+        #   @param first_id [String]
+        #     The ID of the first item in the list.
         #
-        #   @param has_more [Boolean] Whether there are more items available.
+        #   @param has_more [Boolean]
+        #     Whether there are more items available.
         #
-        #   @param last_id [String] The ID of the last item in the list.
+        #   @param last_id [String]
+        #     The ID of the last item in the list.
         #
-        #   @param object [Symbol, :list] The type of object returned, must be `list`.
+        #   @param object [Symbol, :list]
+        #     The type of object returned, must be `list`.
       end
     end
 

data/lib/openai/models/conversations/conversation_update_params.rb

@@ -25,12 +25,15 @@ module OpenAI
         required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
 
         # @!method initialize(conversation_id:, metadata:, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Conversations::ConversationUpdateParams} for more details.
-        #
         #   @param conversation_id [String]
         #
-        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+        #   @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.
+        #
+        #     Keys are strings with a maximum length of 64 characters. Values are strings with
+        #     a maximum length of 512 characters.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/openai/models/conversations/item_create_params.rb

@@ -21,21 +21,22 @@ module OpenAI
 
         # @!attribute include
         #   Additional fields to include in the response. See the `include` parameter for
-        #   [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include)
+        #   [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
         #   for more information.
         #
         #   @return [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
         optional :include, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Responses::ResponseIncludable] }
 
         # @!method initialize(conversation_id:, items:, include: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Conversations::ItemCreateParams} for more details.
-        #
         #   @param conversation_id [String]
         #
-        #   @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>] The items to add to the conversation. You may add up to 20 items at a time.
+        #   @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>]
+        #     The items to add to the conversation. You may add up to 20 items at a time.
         #
-        #   @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
+        #   @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>]
+        #     Additional fields to include in the response. See the `include` parameter for
+        #     [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29)
+        #     for more information.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/openai/models/conversations/item_list_params.rb

@@ -59,18 +59,40 @@ module OpenAI
         optional :order, enum: -> { OpenAI::Conversations::ItemListParams::Order }
 
         # @!method initialize(conversation_id:, after: nil, include: nil, limit: nil, order: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Conversations::ItemListParams} for more details.
-        #
         #   @param conversation_id [String]
         #
-        #   @param after [String] An item ID to list items after, used in pagination.
+        #   @param after [String]
+        #     An item ID to list items after, used in pagination.
+        #
+        #   @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>]
+        #     Specify additional output data to include in the model response. Currently
+        #     supported values are:
+        #
+        #     - `web_search_call.action.sources`: Include the sources of the web search tool
+        #       call.
+        #     - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+        #       in code interpreter tool call items.
+        #     - `computer_call_output.output.image_url`: Include image urls from the computer
+        #       call output.
+        #     - `file_search_call.results`: Include the search results of the file search tool
+        #       call.
+        #     - `message.input_image.image_url`: Include image urls from the input message.
+        #     - `message.output_text.logprobs`: Include logprobs with assistant messages.
+        #     - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+        #       tokens in reasoning item outputs. This enables reasoning items to be used in
+        #       multi-turn conversations when using the Responses API statelessly (like when
+        #       the `store` parameter is set to `false`, or when an organization is enrolled
+        #       in the zero data retention program).
         #
-        #   @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Specify additional output data to include in the model response. Currently suppo
+        #   @param limit [Integer]
+        #     A limit on the number of objects to be returned. Limit can range between 1 and
+        #     100, and the default is 20.
         #
-        #   @param limit [Integer] A limit on the number of objects to be returned. Limit can range between
+        #   @param order [Symbol, OpenAI::Models::Conversations::ItemListParams::Order]
+        #     The order to return the input items in. Default is `desc`.
         #
-        #   @param order [Symbol, OpenAI::Models::Conversations::ItemListParams::Order] The order to return the input items in. Default is `desc`.
+        #     - `asc`: Return the input items in ascending order.
+        #     - `desc`: Return the input items in descending order.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]