RubyGems - openai - Versions diffs - 0.92.0 → 0.93.0 - Mend

openai 0.92.0 → 0.93.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1311) hide show

data/sig/openai/models/responses/response_input_item.rbs CHANGED Viewed

@@ -48,22 +48,41 @@ module OpenAI
           }
         class Message < OpenAI::Internal::Type::BaseModel
+          # A list of one or many input items to the model, containing different content
+          # types.
           attr_accessor content: OpenAI::Models::Responses::response_input_message_content_list
+          # The role of the message input. One of `user`, `system`, or `developer`.
           attr_accessor role: OpenAI::Models::Responses::ResponseInputItem::Message::role
+          # The status of item. One of `in_progress`, `completed`, or `incomplete`.
+          # Populated when items are returned via API.
           attr_reader status: OpenAI::Models::Responses::ResponseInputItem::Message::status?
+          # The status of item. One of `in_progress`, `completed`, or `incomplete`.
+          # Populated when items are returned via API.
           def status=: (
             OpenAI::Models::Responses::ResponseInputItem::Message::status
           ) -> OpenAI::Models::Responses::ResponseInputItem::Message::status
+          # The type of the message input. Always set to `message`.
           attr_reader type: OpenAI::Models::Responses::ResponseInputItem::Message::type_?
+          # The type of the message input. Always set to `message`.
           def type=: (
             OpenAI::Models::Responses::ResponseInputItem::Message::type_
           ) -> OpenAI::Models::Responses::ResponseInputItem::Message::type_
+          # @param content
+          #   A list of one or many input items to the model, containing different content
+          #   types.
+          # @param role
+          #   The role of the message input. One of `user`, `system`, or `developer`.
+          # @param status
+          #   The status of item. One of `in_progress`, `completed`, or `incomplete`.
+          #   Populated when items are returned via API.
+          # @param type
+          #   The type of the message input. Always set to `message`.
           def initialize: (
             content: OpenAI::Models::Responses::response_input_message_content_list,
             role: OpenAI::Models::Responses::ResponseInputItem::Message::role,
@@ -124,18 +143,40 @@ module OpenAI
           }
         class ComputerCallOutput < OpenAI::Internal::Type::BaseModel
+          # The ID of the computer tool call that produced the output.
           attr_accessor call_id: String
+          # A computer screenshot image used with the computer use tool.
           attr_accessor output: OpenAI::Responses::ResponseComputerToolCallOutputScreenshot
+          # The type of the computer tool call output. Always `computer_call_output`.
           attr_accessor type: :computer_call_output
+          # The ID of the computer tool call output.
           attr_accessor id: String?
+          # The safety checks reported by the API that have been acknowledged by the
+          # developer.
           attr_accessor acknowledged_safety_checks: ::Array[OpenAI::Responses::ResponseInputItem::ComputerCallOutput::AcknowledgedSafetyCheck]?
+          # The status of the message input. One of `in_progress`, `completed`, or
+          # `incomplete`. Populated when input items are returned via API.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput::status?
+          # @param call_id
+          #   The ID of the computer tool call that produced the output.
+          # @param output
+          #   A computer screenshot image used with the computer use tool.
+          # @param id
+          #   The ID of the computer tool call output.
+          # @param acknowledged_safety_checks
+          #   The safety checks reported by the API that have been acknowledged by the
+          #   developer.
+          # @param status
+          #   The status of the message input. One of `in_progress`, `completed`, or
+          #   `incomplete`. Populated when input items are returned via API.
+          # @param type
+          #   The type of the computer tool call output. Always `computer_call_output`.
           def initialize: (
             call_id: String,
             output: OpenAI::Responses::ResponseComputerToolCallOutputScreenshot,
@@ -158,12 +199,21 @@ module OpenAI
             { id: String, ?code: String?, ?message: String? }
           class AcknowledgedSafetyCheck < OpenAI::Internal::Type::BaseModel
+            # The ID of the pending safety check.
             attr_accessor id: String
+            # The type of the pending safety check.
             attr_accessor code: String?
+            # Details about the pending safety check.
             attr_accessor message: String?
+            # @param id
+            #   The ID of the pending safety check.
+            # @param code
+            #   The type of the pending safety check.
+            # @param message
+            #   Details about the pending safety check.
             def initialize: (
               id: String,
               ?code: String?,
@@ -199,22 +249,50 @@ module OpenAI
           }
         class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
+          # Text, image, or file output of the function tool call.
           attr_accessor output: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::output
+          # The type of the function tool call output. Always `function_call_output`.
           attr_accessor type: :function_call_output
+          # The unique ID of the function tool call output. Populated when this item is
+          # returned via API.
           attr_accessor id: String?
+          # The unique ID of the function tool call generated by the model.
           attr_accessor call_id: String?
+          # The execution context that produced this tool call.
           attr_accessor caller_: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::caller_?
+          # The name of the tool that produced the output.
           attr_accessor name: String?
+          # The namespace of the tool that produced the output.
           attr_accessor namespace: String?
+          # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+          # Populated when items are returned via API.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::status?
+          # @param output
+          #   Text, image, or file output of the function tool call.
+          # @param id
+          #   The unique ID of the function tool call output. Populated when this item is
+          #   returned via API.
+          # @param call_id
+          #   The unique ID of the function tool call generated by the model.
+          # @param caller_
+          #   The execution context that produced this tool call.
+          # @param name
+          #   The name of the tool that produced the output.
+          # @param namespace
+          #   The namespace of the tool that produced the output.
+          # @param status
+          #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+          #   Populated when items are returned via API.
+          # @param type
+          #   The type of the function tool call output. Always `function_call_output`.
           def initialize: (
             output: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::output,
             ?id: String?,
@@ -257,8 +335,11 @@ module OpenAI
             type direct = { ?type: :direct }
             class Direct < OpenAI::Internal::Type::BaseModel
+              # The caller type. Always `direct`.
               attr_accessor type: :direct
+              # @param type
+              #   The caller type. Always `direct`.
               def initialize: (?type: :direct) -> void
               def to_hash: -> { ?type: :direct }
@@ -267,10 +348,16 @@ module OpenAI
             type program = { caller_id: String, ?type: :program }
             class Program < OpenAI::Internal::Type::BaseModel
+              # The call ID of the program item that produced this tool call.
               attr_accessor caller_id: String
+              # The caller type. Always `program`.
               attr_accessor type: :program
+              # @param caller_id
+              #   The call ID of the program item that produced this tool call.
+              # @param type
+              #   The caller type. Always `program`.
               def initialize: (caller_id: String, ?type: :program) -> void
               def to_hash: -> { caller_id: String, ?type: :program }
@@ -303,22 +390,41 @@ module OpenAI
           }
         class ToolSearchCall < OpenAI::Internal::Type::BaseModel
+          # The arguments supplied to the tool search call.
           attr_accessor arguments: top
+          # The item type. Always `tool_search_call`.
           attr_accessor type: :tool_search_call
+          # The unique ID of this tool search call.
           attr_accessor id: String?
+          # The unique ID of the tool search call generated by the model.
           attr_accessor call_id: String?
+          # Whether tool search was executed by the server or by the client.
           attr_reader execution: OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::execution?
+          # Whether tool search was executed by the server or by the client.
           def execution=: (
             OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::execution
           ) -> OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::execution
+          # The status of the tool search call.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::status?
+          # @param arguments
+          #   The arguments supplied to the tool search call.
+          # @param id
+          #   The unique ID of this tool search call.
+          # @param call_id
+          #   The unique ID of the tool search call generated by the model.
+          # @param execution
+          #   Whether tool search was executed by the server or by the client.
+          # @param status
+          #   The status of the tool search call.
+          # @param type
+          #   The item type. Always `tool_search_call`.
           def initialize: (
             arguments: top,
             ?id: String?,
@@ -370,14 +476,26 @@ module OpenAI
           }
         class AdditionalTools < OpenAI::Internal::Type::BaseModel
+          # The role that provided the additional tools. Only `developer` is supported.
           attr_accessor role: :developer
+          # A list of additional tools made available at this item.
           attr_accessor tools: ::Array[OpenAI::Models::Responses::tool]
+          # The item type. Always `additional_tools`.
           attr_accessor type: :additional_tools
+          # The unique ID of this additional tools item.
           attr_accessor id: String?
+          # @param tools
+          #   A list of additional tools made available at this item.
+          # @param id
+          #   The unique ID of this additional tools item.
+          # @param role
+          #   The role that provided the additional tools. Only `developer` is supported.
+          # @param type
+          #   The item type. Always `additional_tools`.
           def initialize: (
             tools: ::Array[OpenAI::Models::Responses::tool],
             ?id: String?,
@@ -408,26 +526,58 @@ module OpenAI
           }
         class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the image generation call.
           attr_accessor id: String
+          # The generated image encoded in base64.
           attr_accessor result: String?
+          # The status of the image generation call.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::status
+          # The type of the image generation call. Always `image_generation_call`.
           attr_accessor type: :image_generation_call
+          # The action used for image generation.
           attr_accessor action: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::action?
+          # The background setting used for generation.
           attr_accessor background: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::background?
+          # The output format used for generation.
           attr_accessor output_format: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::output_format?
+          # The quality of the image generated by the image generation tool call. One of
+          # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
           attr_accessor quality: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::quality?
+          # The prompt that was used after any model prompt rewriting.
           attr_accessor revised_prompt: String?
+          # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           attr_accessor size: OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::size?
+          # @param id
+          #   The unique ID of the image generation call.
+          # @param result
+          #   The generated image encoded in base64.
+          # @param status
+          #   The status of the image generation call.
+          # @param action
+          #   The action used for image generation.
+          # @param background
+          #   The background setting used for generation.
+          # @param output_format
+          #   The output format used for generation.
+          # @param quality
+          #   The quality of the image generated by the image generation tool call. One of
+          #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+          # @param revised_prompt
+          #   The prompt that was used after any model prompt rewriting.
+          # @param size
+          #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          # @param type
+          #   The type of the image generation call. Always `image_generation_call`.
           def initialize: (
             id: String,
             result: String?,
@@ -541,16 +691,31 @@ module OpenAI
           }
         class LocalShellCall < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the local shell call.
           attr_accessor id: String
+          # Execute a shell command on the server.
           attr_accessor action: OpenAI::Responses::ResponseInputItem::LocalShellCall::Action
+          # The unique ID of the local shell tool call generated by the model.
           attr_accessor call_id: String
+          # The status of the local shell call.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::LocalShellCall::status
+          # The type of the local shell call. Always `local_shell_call`.
           attr_accessor type: :local_shell_call
+          # @param id
+          #   The unique ID of the local shell call.
+          # @param action
+          #   Execute a shell command on the server.
+          # @param call_id
+          #   The unique ID of the local shell tool call generated by the model.
+          # @param status
+          #   The status of the local shell call.
+          # @param type
+          #   The type of the local shell call. Always `local_shell_call`.
           def initialize: (
             id: String,
             action: OpenAI::Responses::ResponseInputItem::LocalShellCall::Action,
@@ -578,18 +743,36 @@ module OpenAI
             }
           class Action < OpenAI::Internal::Type::BaseModel
+            # The command to run.
             attr_accessor command: ::Array[String]
+            # Environment variables to set for the command.
             attr_accessor env: ::Hash[Symbol, String]
+            # The type of the local shell action. Always `exec`.
             attr_accessor type: :exec
+            # Optional timeout in milliseconds for the command.
             attr_accessor timeout_ms: Integer?
+            # Optional user to run the command as.
             attr_accessor user: String?
+            # Optional working directory to run the command in.
             attr_accessor working_directory: String?
+            # @param command
+            #   The command to run.
+            # @param env
+            #   Environment variables to set for the command.
+            # @param timeout_ms
+            #   Optional timeout in milliseconds for the command.
+            # @param user
+            #   Optional user to run the command as.
+            # @param working_directory
+            #   Optional working directory to run the command in.
+            # @param type
+            #   The type of the local shell action. Always `exec`.
             def initialize: (
               command: ::Array[String],
               env: ::Hash[Symbol, String],
@@ -631,14 +814,26 @@ module OpenAI
           }
         class LocalShellCallOutput < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the local shell tool call generated by the model.
           attr_accessor id: String
+          # A JSON string of the output of the local shell tool call.
           attr_accessor output: String
+          # The type of the local shell tool call output. Always `local_shell_call_output`.
           attr_accessor type: :local_shell_call_output
+          # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput::status?
+          # @param id
+          #   The unique ID of the local shell tool call generated by the model.
+          # @param output
+          #   A JSON string of the output of the local shell tool call.
+          # @param status
+          #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+          # @param type
+          #   The type of the local shell tool call output. Always `local_shell_call_output`.
           def initialize: (
             id: String,
             output: String,
@@ -678,20 +873,45 @@ module OpenAI
           }
         class ShellCall < OpenAI::Internal::Type::BaseModel
+          # The shell commands and limits that describe how to run the tool call.
           attr_accessor action: OpenAI::Responses::ResponseInputItem::ShellCall::Action
+          # The unique ID of the shell tool call generated by the model.
           attr_accessor call_id: String
+          # The type of the item. Always `shell_call`.
           attr_accessor type: :shell_call
+          # The unique ID of the shell tool call. Populated when this item is returned via
+          # API.
           attr_accessor id: String?
+          # The execution context that produced this tool call.
           attr_accessor caller_: OpenAI::Models::Responses::ResponseInputItem::ShellCall::caller_?
+          # The environment to execute the shell commands in.
           attr_accessor environment: OpenAI::Models::Responses::ResponseInputItem::ShellCall::environment?
+          # The status of the shell call. One of `in_progress`, `completed`, or
+          # `incomplete`.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::ShellCall::status?
+          # @param action
+          #   The shell commands and limits that describe how to run the tool call.
+          # @param call_id
+          #   The unique ID of the shell tool call generated by the model.
+          # @param id
+          #   The unique ID of the shell tool call. Populated when this item is returned via
+          #   API.
+          # @param caller_
+          #   The execution context that produced this tool call.
+          # @param environment
+          #   The environment to execute the shell commands in.
+          # @param status
+          #   The status of the shell call. One of `in_progress`, `completed`, or
+          #   `incomplete`.
+          # @param type
+          #   The type of the item. Always `shell_call`.
           def initialize: (
             action: OpenAI::Responses::ResponseInputItem::ShellCall::Action,
             call_id: String,
@@ -720,12 +940,23 @@ module OpenAI
             }
           class Action < OpenAI::Internal::Type::BaseModel
+            # Ordered shell commands for the execution environment to run.
             attr_accessor commands: ::Array[String]
+            # Maximum number of UTF-8 characters to capture from combined stdout and stderr
+            # output.
             attr_accessor max_output_length: Integer?
+            # Maximum wall-clock time in milliseconds to allow the shell commands to run.
             attr_accessor timeout_ms: Integer?
+            # @param commands
+            #   Ordered shell commands for the execution environment to run.
+            # @param max_output_length
+            #   Maximum number of UTF-8 characters to capture from combined stdout and stderr
+            #   output.
+            # @param timeout_ms
+            #   Maximum wall-clock time in milliseconds to allow the shell commands to run.
             def initialize: (
               commands: ::Array[String],
               ?max_output_length: Integer?,
@@ -749,8 +980,11 @@ module OpenAI
             type direct = { ?type: :direct }
             class Direct < OpenAI::Internal::Type::BaseModel
+              # The caller type. Always `direct`.
               attr_accessor type: :direct
+              # @param type
+              #   The caller type. Always `direct`.
               def initialize: (?type: :direct) -> void
               def to_hash: -> { ?type: :direct }
@@ -759,10 +993,16 @@ module OpenAI
             type program = { caller_id: String, ?type: :program }
             class Program < OpenAI::Internal::Type::BaseModel
+              # The call ID of the program item that produced this tool call.
               attr_accessor caller_id: String
+              # The caller type. Always `program`.
               attr_accessor type: :program
+              # @param caller_id
+              #   The call ID of the program item that produced this tool call.
+              # @param type
+              #   The caller type. Always `program`.
               def initialize: (caller_id: String, ?type: :program) -> void
               def to_hash: -> { caller_id: String, ?type: :program }
@@ -806,20 +1046,47 @@ module OpenAI
           }
         class ShellCallOutput < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the shell tool call generated by the model.
           attr_accessor call_id: String
+          # Captured chunks of stdout and stderr output, along with their associated
+          # outcomes.
           attr_accessor output: ::Array[OpenAI::Responses::ResponseFunctionShellCallOutputContent]
+          # The type of the item. Always `shell_call_output`.
           attr_accessor type: :shell_call_output
+          # The unique ID of the shell tool call output. Populated when this item is
+          # returned via API.
           attr_accessor id: String?
+          # The execution context that produced this tool call.
           attr_accessor caller_: OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput::caller_?
+          # The maximum number of UTF-8 characters captured for this shell call's combined
+          # output.
           attr_accessor max_output_length: Integer?
+          # The status of the shell call output.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput::status?
+          # @param call_id
+          #   The unique ID of the shell tool call generated by the model.
+          # @param output
+          #   Captured chunks of stdout and stderr output, along with their associated
+          #   outcomes.
+          # @param id
+          #   The unique ID of the shell tool call output. Populated when this item is
+          #   returned via API.
+          # @param caller_
+          #   The execution context that produced this tool call.
+          # @param max_output_length
+          #   The maximum number of UTF-8 characters captured for this shell call's combined
+          #   output.
+          # @param status
+          #   The status of the shell call output.
+          # @param type
+          #   The type of the item. Always `shell_call_output`.
           def initialize: (
             call_id: String,
             output: ::Array[OpenAI::Responses::ResponseFunctionShellCallOutputContent],
@@ -850,8 +1117,11 @@ module OpenAI
             type direct = { ?type: :direct }
             class Direct < OpenAI::Internal::Type::BaseModel
+              # The caller type. Always `direct`.
               attr_accessor type: :direct
+              # @param type
+              #   The caller type. Always `direct`.
               def initialize: (?type: :direct) -> void
               def to_hash: -> { ?type: :direct }
@@ -860,10 +1130,16 @@ module OpenAI
             type program = { caller_id: String, ?type: :program }
             class Program < OpenAI::Internal::Type::BaseModel
+              # The call ID of the program item that produced this tool call.
               attr_accessor caller_id: String
+              # The caller type. Always `program`.
               attr_accessor type: :program
+              # @param caller_id
+              #   The call ID of the program item that produced this tool call.
+              # @param type
+              #   The caller type. Always `program`.
               def initialize: (caller_id: String, ?type: :program) -> void
               def to_hash: -> { caller_id: String, ?type: :program }
@@ -896,18 +1172,40 @@ module OpenAI
           }
         class ApplyPatchCall < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the apply patch tool call generated by the model.
           attr_accessor call_id: String
+          # The specific create, delete, or update instruction for the apply_patch tool
+          # call.
           attr_accessor operation: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::operation
+          # The status of the apply patch tool call. One of `in_progress` or `completed`.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::status
+          # The type of the item. Always `apply_patch_call`.
           attr_accessor type: :apply_patch_call
+          # The unique ID of the apply patch tool call. Populated when this item is returned
+          # via API.
           attr_accessor id: String?
+          # The execution context that produced this tool call.
           attr_accessor caller_: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::caller_?
+          # @param call_id
+          #   The unique ID of the apply patch tool call generated by the model.
+          # @param operation
+          #   The specific create, delete, or update instruction for the apply_patch tool
+          #   call.
+          # @param status
+          #   The status of the apply patch tool call. One of `in_progress` or `completed`.
+          # @param id
+          #   The unique ID of the apply patch tool call. Populated when this item is returned
+          #   via API.
+          # @param caller_
+          #   The execution context that produced this tool call.
+          # @param type
+          #   The type of the item. Always `apply_patch_call`.
           def initialize: (
             call_id: String,
             operation: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall::operation,
@@ -938,12 +1236,21 @@ module OpenAI
               { diff: String, path: String, ?type: :create_file }
             class CreateFile < OpenAI::Internal::Type::BaseModel
+              # Unified diff content to apply when creating the file.
               attr_accessor diff: String
+              # Path of the file to create relative to the workspace root.
               attr_accessor path: String
+              # The operation type. Always `create_file`.
               attr_accessor type: :create_file
+              # @param diff
+              #   Unified diff content to apply when creating the file.
+              # @param path
+              #   Path of the file to create relative to the workspace root.
+              # @param type
+              #   The operation type. Always `create_file`.
               def initialize: (
                 diff: String,
                 path: String,
@@ -960,10 +1267,16 @@ module OpenAI
             type delete_file = { path: String, ?type: :delete_file }
             class DeleteFile < OpenAI::Internal::Type::BaseModel
+              # Path of the file to delete relative to the workspace root.
               attr_accessor path: String
+              # The operation type. Always `delete_file`.
               attr_accessor type: :delete_file
+              # @param path
+              #   Path of the file to delete relative to the workspace root.
+              # @param type
+              #   The operation type. Always `delete_file`.
               def initialize: (path: String, ?type: :delete_file) -> void
               def to_hash: -> { path: String, ?type: :delete_file }
@@ -973,12 +1286,21 @@ module OpenAI
               { diff: String, path: String, ?type: :update_file }
             class UpdateFile < OpenAI::Internal::Type::BaseModel
+              # Unified diff content to apply to the existing file.
               attr_accessor diff: String
+              # Path of the file to update relative to the workspace root.
               attr_accessor path: String
+              # The operation type. Always `update_file`.
               attr_accessor type: :update_file
+              # @param diff
+              #   Unified diff content to apply to the existing file.
+              # @param path
+              #   Path of the file to update relative to the workspace root.
+              # @param type
+              #   The operation type. Always `update_file`.
               def initialize: (
                 diff: String,
                 path: String,
@@ -1016,8 +1338,11 @@ module OpenAI
             type direct = { ?type: :direct }
             class Direct < OpenAI::Internal::Type::BaseModel
+              # The caller type. Always `direct`.
               attr_accessor type: :direct
+              # @param type
+              #   The caller type. Always `direct`.
               def initialize: (?type: :direct) -> void
               def to_hash: -> { ?type: :direct }
@@ -1026,10 +1351,16 @@ module OpenAI
             type program = { caller_id: String, ?type: :program }
             class Program < OpenAI::Internal::Type::BaseModel
+              # The call ID of the program item that produced this tool call.
               attr_accessor caller_id: String
+              # The caller type. Always `program`.
               attr_accessor type: :program
+              # @param caller_id
+              #   The call ID of the program item that produced this tool call.
+              # @param type
+              #   The caller type. Always `program`.
               def initialize: (caller_id: String, ?type: :program) -> void
               def to_hash: -> { caller_id: String, ?type: :program }
@@ -1050,18 +1381,40 @@ module OpenAI
           }
         class ApplyPatchCallOutput < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the apply patch tool call generated by the model.
           attr_accessor call_id: String
+          # The status of the apply patch tool call output. One of `completed` or `failed`.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::status
+          # The type of the item. Always `apply_patch_call_output`.
           attr_accessor type: :apply_patch_call_output
+          # The unique ID of the apply patch tool call output. Populated when this item is
+          # returned via API.
           attr_accessor id: String?
+          # The execution context that produced this tool call.
           attr_accessor caller_: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::caller_?
+          # Optional human-readable log text from the apply patch tool (e.g., patch results
+          # or errors).
           attr_accessor output: String?
+          # @param call_id
+          #   The unique ID of the apply patch tool call generated by the model.
+          # @param status
+          #   The status of the apply patch tool call output. One of `completed` or `failed`.
+          # @param id
+          #   The unique ID of the apply patch tool call output. Populated when this item is
+          #   returned via API.
+          # @param caller_
+          #   The execution context that produced this tool call.
+          # @param output
+          #   Optional human-readable log text from the apply patch tool (e.g., patch results
+          #   or errors).
+          # @param type
+          #   The type of the item. Always `apply_patch_call_output`.
           def initialize: (
             call_id: String,
             status: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::status,
@@ -1101,8 +1454,11 @@ module OpenAI
             type direct = { ?type: :direct }
             class Direct < OpenAI::Internal::Type::BaseModel
+              # The caller type. Always `direct`.
               attr_accessor type: :direct
+              # @param type
+              #   The caller type. Always `direct`.
               def initialize: (?type: :direct) -> void
               def to_hash: -> { ?type: :direct }
@@ -1111,10 +1467,16 @@ module OpenAI
             type program = { caller_id: String, ?type: :program }
             class Program < OpenAI::Internal::Type::BaseModel
+              # The call ID of the program item that produced this tool call.
               attr_accessor caller_id: String
+              # The caller type. Always `program`.
               attr_accessor type: :program
+              # @param caller_id
+              #   The call ID of the program item that produced this tool call.
+              # @param type
+              #   The caller type. Always `program`.
               def initialize: (caller_id: String, ?type: :program) -> void
               def to_hash: -> { caller_id: String, ?type: :program }
@@ -1134,16 +1496,31 @@ module OpenAI
           }
         class McpListTools < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the list.
           attr_accessor id: String
+          # The label of the MCP server.
           attr_accessor server_label: String
+          # The tools available on the server.
           attr_accessor tools: ::Array[OpenAI::Responses::ResponseInputItem::McpListTools::Tool]
+          # The type of the item. Always `mcp_list_tools`.
           attr_accessor type: :mcp_list_tools
+          # Error message if the server could not list tools.
           attr_accessor error: String?
+          # @param id
+          #   The unique ID of the list.
+          # @param server_label
+          #   The label of the MCP server.
+          # @param tools
+          #   The tools available on the server.
+          # @param error
+          #   Error message if the server could not list tools.
+          # @param type
+          #   The type of the item. Always `mcp_list_tools`.
           def initialize: (
             id: String,
             server_label: String,
@@ -1169,14 +1546,26 @@ module OpenAI
             }
           class Tool < OpenAI::Internal::Type::BaseModel
+            # The JSON schema describing the tool's input.
             attr_accessor input_schema: top
+            # The name of the tool.
             attr_accessor name: String
+            # Additional annotations about the tool.
             attr_accessor annotations: top?
+            # The description of the tool.
             attr_accessor description: String?
+            # @param input_schema
+            #   The JSON schema describing the tool's input.
+            # @param name
+            #   The name of the tool.
+            # @param annotations
+            #   Additional annotations about the tool.
+            # @param description
+            #   The description of the tool.
             def initialize: (
               input_schema: top,
               name: String,
@@ -1203,16 +1592,31 @@ module OpenAI
           }
         class McpApprovalRequest < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the approval request.
           attr_accessor id: String
+          # A JSON string of arguments for the tool.
           attr_accessor arguments: String
+          # The name of the tool to run.
           attr_accessor name: String
+          # The label of the MCP server making the request.
           attr_accessor server_label: String
+          # The type of the item. Always `mcp_approval_request`.
           attr_accessor type: :mcp_approval_request
+          # @param id
+          #   The unique ID of the approval request.
+          # @param arguments
+          #   A JSON string of arguments for the tool.
+          # @param name
+          #   The name of the tool to run.
+          # @param server_label
+          #   The label of the MCP server making the request.
+          # @param type
+          #   The type of the item. Always `mcp_approval_request`.
           def initialize: (
             id: String,
             arguments: String,
@@ -1240,16 +1644,31 @@ module OpenAI
           }
         class McpApprovalResponse < OpenAI::Internal::Type::BaseModel
+          # The ID of the approval request being answered.
           attr_accessor approval_request_id: String
+          # Whether the request was approved.
           attr_accessor approve: bool
+          # The type of the item. Always `mcp_approval_response`.
           attr_accessor type: :mcp_approval_response
+          # The unique ID of the approval response
           attr_accessor id: String?
+          # Optional reason for the decision.
           attr_accessor reason: String?
+          # @param approval_request_id
+          #   The ID of the approval request being answered.
+          # @param approve
+          #   Whether the request was approved.
+          # @param id
+          #   The unique ID of the approval response
+          # @param reason
+          #   Optional reason for the decision.
+          # @param type
+          #   The type of the item. Always `mcp_approval_response`.
           def initialize: (
             approval_request_id: String,
             approve: bool,
@@ -1281,28 +1700,63 @@ module OpenAI
           }
         class McpCall < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the tool call.
           attr_accessor id: String
+          # A JSON string of the arguments passed to the tool.
           attr_accessor arguments: String
+          # The name of the tool that was run.
           attr_accessor name: String
+          # The label of the MCP server running the tool.
           attr_accessor server_label: String
+          # The type of the item. Always `mcp_call`.
           attr_accessor type: :mcp_call
+          # 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.
           attr_accessor approval_request_id: String?
+          # The error from the tool call, if any.
           attr_accessor error: OpenAI::Models::Responses::mcp_tool_call_error?
+          # The output from the tool call.
           attr_accessor output: String?
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
           attr_reader status: OpenAI::Models::Responses::ResponseInputItem::McpCall::status?
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
           def status=: (
             OpenAI::Models::Responses::ResponseInputItem::McpCall::status
           ) -> OpenAI::Models::Responses::ResponseInputItem::McpCall::status
+          # @param id
+          #   The unique ID of the tool call.
+          # @param arguments
+          #   A JSON string of the arguments passed to the tool.
+          # @param name
+          #   The name of the tool that was run.
+          # @param server_label
+          #   The label of the MCP server running the tool.
+          # @param approval_request_id
+          #   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
+          #   The error from the tool call, if any.
+          # @param output
+          #   The output from the tool call.
+          # @param status
+          #   The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          #   `calling`, or `failed`.
+          # @param type
+          #   The type of the item. Always `mcp_call`.
           def initialize: (
             id: String,
             arguments: String,
@@ -1346,8 +1800,11 @@ module OpenAI
         type compaction_trigger = { ?type: :compaction_trigger }
         class CompactionTrigger < OpenAI::Internal::Type::BaseModel
+          # The type of the item. Always `compaction_trigger`.
           attr_accessor type: :compaction_trigger
+          # @param type
+          #   The type of the item. Always `compaction_trigger`.
           def initialize: (?type: :compaction_trigger) -> void
           def to_hash: -> { ?type: :compaction_trigger }
@@ -1360,10 +1817,16 @@ module OpenAI
           }
         class ItemReference < OpenAI::Internal::Type::BaseModel
+          # The ID of the item to reference.
           attr_accessor id: String
+          # The type of item to reference. Always `item_reference`.
           attr_accessor type: OpenAI::Models::Responses::ResponseInputItem::ItemReference::type_?
+          # @param id
+          #   The ID of the item to reference.
+          # @param type
+          #   The type of item to reference. Always `item_reference`.
           def initialize: (
             id: String,
             ?type: OpenAI::Models::Responses::ResponseInputItem::ItemReference::type_?
@@ -1395,16 +1858,31 @@ module OpenAI
           }
         class Program < OpenAI::Internal::Type::BaseModel
+          # The unique ID of this program item.
           attr_accessor id: String
+          # The stable call ID of the program item.
           attr_accessor call_id: String
+          # The JavaScript source executed by programmatic tool calling.
           attr_accessor code: String
+          # Opaque program replay fingerprint that must be round-tripped.
           attr_accessor fingerprint: String
+          # The item type. Always `program`.
           attr_accessor type: :program
+          # @param id
+          #   The unique ID of this program item.
+          # @param call_id
+          #   The stable call ID of the program item.
+          # @param code
+          #   The JavaScript source executed by programmatic tool calling.
+          # @param fingerprint
+          #   Opaque program replay fingerprint that must be round-tripped.
+          # @param type
+          #   The item type. Always `program`.
           def initialize: (
             id: String,
             call_id: String,
@@ -1432,16 +1910,31 @@ module OpenAI
           }
         class ProgramOutput < OpenAI::Internal::Type::BaseModel
+          # The unique ID of this program output item.
           attr_accessor id: String
+          # The call ID of the program item.
           attr_accessor call_id: String
+          # The result produced by the program item.
           attr_accessor result: String
+          # The terminal status of the program output.
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::ProgramOutput::status
+          # The item type. Always `program_output`.
           attr_accessor type: :program_output
+          # @param id
+          #   The unique ID of this program output item.
+          # @param call_id
+          #   The call ID of the program item.
+          # @param result
+          #   The result produced by the program item.
+          # @param status
+          #   The terminal status of the program output.
+          # @param type
+          #   The item type. Always `program_output`.
           def initialize: (
             id: String,
             call_id: String,