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/beta/beta_response_item.rbs CHANGED Viewed

@@ -52,22 +52,41 @@ module OpenAI
           }
         class AgentMessage < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the agent message.
           attr_accessor id: String
+          # The sending agent identity.
           attr_accessor author: String
+          # Encrypted content sent between agents.
           attr_accessor content: ::Array[OpenAI::Models::Beta::BetaResponseItem::AgentMessage::content]
+          # The destination agent identity.
           attr_accessor recipient: String
+          # The type of the item. Always `agent_message`.
           attr_accessor type: :agent_message
+          # The agent that produced this item.
           attr_reader agent: OpenAI::Beta::BetaResponseItem::AgentMessage::Agent?
+          # The agent that produced this item.
           def agent=: (
             OpenAI::Beta::BetaResponseItem::AgentMessage::Agent
           ) -> OpenAI::Beta::BetaResponseItem::AgentMessage::Agent
+          # @param id
+          #   The unique ID of the agent message.
+          # @param author
+          #   The sending agent identity.
+          # @param content
+          #   Encrypted content sent between agents.
+          # @param recipient
+          #   The destination agent identity.
+          # @param agent
+          #   The agent that produced this item.
+          # @param type
+          #   The type of the item. Always `agent_message`.
           def initialize: (
             id: String,
             author: String,
@@ -116,10 +135,16 @@ module OpenAI
             type summary_text = { text: String, ?type: :summary_text }
             class SummaryText < OpenAI::Internal::Type::BaseModel
+              # A summary of the reasoning output from the model so far.
               attr_accessor text: String
+              # The type of the object. Always `summary_text`.
               attr_accessor type: :summary_text
+              # @param text
+              #   A summary of the reasoning output from the model so far.
+              # @param type
+              #   The type of the object. Always `summary_text`.
               def initialize: (text: String, ?type: :summary_text) -> void
               def to_hash: -> { text: String, ?type: :summary_text }
@@ -128,10 +153,16 @@ module OpenAI
             type reasoning_text = { text: String, ?type: :reasoning_text }
             class ReasoningText < OpenAI::Internal::Type::BaseModel
+              # The reasoning text from the model.
               attr_accessor text: String
+              # The type of the reasoning text. Always `reasoning_text`.
               attr_accessor type: :reasoning_text
+              # @param text
+              #   The reasoning text from the model.
+              # @param type
+              #   The type of the reasoning text. Always `reasoning_text`.
               def initialize: (text: String, ?type: :reasoning_text) -> void
               def to_hash: -> { text: String, ?type: :reasoning_text }
@@ -147,20 +178,46 @@ module OpenAI
               }
             class ComputerScreenshot < OpenAI::Internal::Type::BaseModel
+              # The detail level of the screenshot image to be sent to the model. One of `high`,
+              # `low`, `auto`, or `original`. Defaults to `auto`.
               attr_accessor detail: OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::detail
+              # The identifier of an uploaded file that contains the screenshot.
               attr_accessor file_id: String?
+              # The URL of the screenshot image.
               attr_accessor image_url: String?
+              # Specifies the event type. For a computer screenshot, this property is always set
+              # to `computer_screenshot`.
               attr_accessor type: :computer_screenshot
+              # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+              # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+              # token block.
               attr_reader prompt_cache_breakpoint: OpenAI::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::PromptCacheBreakpoint?
+              # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+              # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+              # token block.
               def prompt_cache_breakpoint=: (
                 OpenAI::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::PromptCacheBreakpoint
               ) -> OpenAI::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::PromptCacheBreakpoint
+              # @param detail
+              #   The detail level of the screenshot image to be sent to the model. One of `high`,
+              #   `low`, `auto`, or `original`. Defaults to `auto`.
+              # @param file_id
+              #   The identifier of an uploaded file that contains the screenshot.
+              # @param image_url
+              #   The URL of the screenshot image.
+              # @param prompt_cache_breakpoint
+              #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+              #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+              #   token block.
+              # @param type
+              #   Specifies the event type. For a computer screenshot, this property is always set
+              #   to `computer_screenshot`.
               def initialize: (
                 detail: OpenAI::Models::Beta::BetaResponseItem::AgentMessage::Content::ComputerScreenshot::detail,
                 file_id: String?,
@@ -193,8 +250,11 @@ module OpenAI
               type prompt_cache_breakpoint = { ?mode: :explicit }
               class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+                # The breakpoint mode. Always `explicit`.
                 attr_accessor mode: :explicit
+                # @param mode
+                #   The breakpoint mode. Always `explicit`.
                 def initialize: (?mode: :explicit) -> void
                 def to_hash: -> { ?mode: :explicit }
@@ -205,10 +265,16 @@ module OpenAI
               { encrypted_content: String, ?type: :encrypted_content }
             class EncryptedContent < OpenAI::Internal::Type::BaseModel
+              # Opaque encrypted content.
               attr_accessor encrypted_content: String
+              # The type of the input item. Always `encrypted_content`.
               attr_accessor type: :encrypted_content
+              # @param encrypted_content
+              #   Opaque encrypted content.
+              # @param type
+              #   The type of the input item. Always `encrypted_content`.
               def initialize: (
                 encrypted_content: String,
                 ?type: :encrypted_content
@@ -226,8 +292,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -245,22 +314,41 @@ module OpenAI
           }
         class MultiAgentCall < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the multi-agent call item.
           attr_accessor id: String
+          # The multi-agent action to execute.
           attr_accessor action: OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall::action
+          # The JSON string of arguments generated for the action.
           attr_accessor arguments: String
+          # The unique ID linking this call to its output.
           attr_accessor call_id: String
+          # The type of the multi-agent call. Always `multi_agent_call`.
           attr_accessor type: :multi_agent_call
+          # The agent that produced this item.
           attr_reader agent: OpenAI::Beta::BetaResponseItem::MultiAgentCall::Agent?
+          # The agent that produced this item.
           def agent=: (
             OpenAI::Beta::BetaResponseItem::MultiAgentCall::Agent
           ) -> OpenAI::Beta::BetaResponseItem::MultiAgentCall::Agent
+          # @param id
+          #   The unique ID of the multi-agent call item.
+          # @param action
+          #   The multi-agent action to execute.
+          # @param arguments
+          #   The JSON string of arguments generated for the action.
+          # @param call_id
+          #   The unique ID linking this call to its output.
+          # @param agent
+          #   The agent that produced this item.
+          # @param type
+          #   The type of the multi-agent call. Always `multi_agent_call`.
           def initialize: (
             id: String,
             action: OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall::action,
@@ -303,8 +391,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -322,22 +413,41 @@ module OpenAI
           }
         class MultiAgentCallOutput < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the multi-agent call output item.
           attr_accessor id: String
+          # The multi-agent action that produced this result.
           attr_accessor action: OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput::action
+          # The unique ID of the multi-agent call.
           attr_accessor call_id: String
+          # Text output returned by the multi-agent action.
           attr_accessor output: ::Array[OpenAI::Beta::BetaResponseOutputText]
+          # The type of the multi-agent result. Always `multi_agent_call_output`.
           attr_accessor type: :multi_agent_call_output
+          # The agent that produced this item.
           attr_reader agent: OpenAI::Beta::BetaResponseItem::MultiAgentCallOutput::Agent?
+          # The agent that produced this item.
           def agent=: (
             OpenAI::Beta::BetaResponseItem::MultiAgentCallOutput::Agent
           ) -> OpenAI::Beta::BetaResponseItem::MultiAgentCallOutput::Agent
+          # @param id
+          #   The unique ID of the multi-agent call output item.
+          # @param action
+          #   The multi-agent action that produced this result.
+          # @param call_id
+          #   The unique ID of the multi-agent call.
+          # @param output
+          #   Text output returned by the multi-agent action.
+          # @param agent
+          #   The agent that produced this item.
+          # @param type
+          #   The type of the multi-agent result. Always `multi_agent_call_output`.
           def initialize: (
             id: String,
             action: OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput::action,
@@ -380,8 +490,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -398,20 +511,36 @@ module OpenAI
           }
         class AdditionalTools < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the additional tools item.
           attr_accessor id: String
+          # The role that provided the additional tools.
           attr_accessor role: OpenAI::Models::Beta::BetaResponseItem::AdditionalTools::role
+          # The additional tool definitions made available at this item.
           attr_accessor tools: ::Array[OpenAI::Models::Beta::beta_tool]
+          # The type of the item. Always `additional_tools`.
           attr_accessor type: :additional_tools
+          # The agent that produced this item.
           attr_reader agent: OpenAI::Beta::BetaResponseItem::AdditionalTools::Agent?
+          # The agent that produced this item.
           def agent=: (
             OpenAI::Beta::BetaResponseItem::AdditionalTools::Agent
           ) -> OpenAI::Beta::BetaResponseItem::AdditionalTools::Agent
+          # @param id
+          #   The unique ID of the additional tools item.
+          # @param role
+          #   The role that provided the additional tools.
+          # @param tools
+          #   The additional tool definitions made available at this item.
+          # @param agent
+          #   The agent that produced this item.
+          # @param type
+          #   The type of the item. Always `additional_tools`.
           def initialize: (
             id: String,
             role: OpenAI::Models::Beta::BetaResponseItem::AdditionalTools::role,
@@ -456,8 +585,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -475,22 +607,41 @@ module OpenAI
           }
         class Program < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the 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 type of the item. Always `program`.
           attr_accessor type: :program
+          # The agent that produced this item.
           attr_reader agent: OpenAI::Beta::BetaResponseItem::Program::Agent?
+          # The agent that produced this item.
           def agent=: (
             OpenAI::Beta::BetaResponseItem::Program::Agent
           ) -> OpenAI::Beta::BetaResponseItem::Program::Agent
+          # @param id
+          #   The unique ID of the 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 agent
+          #   The agent that produced this item.
+          # @param type
+          #   The type of the item. Always `program`.
           def initialize: (
             id: String,
             call_id: String,
@@ -512,8 +663,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -531,22 +685,41 @@ module OpenAI
           }
         class ProgramOutput < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the 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 item.
           attr_accessor status: OpenAI::Models::Beta::BetaResponseItem::ProgramOutput::status
+          # The type of the item. Always `program_output`.
           attr_accessor type: :program_output
+          # The agent that produced this item.
           attr_reader agent: OpenAI::Beta::BetaResponseItem::ProgramOutput::Agent?
+          # The agent that produced this item.
           def agent=: (
             OpenAI::Beta::BetaResponseItem::ProgramOutput::Agent
           ) -> OpenAI::Beta::BetaResponseItem::ProgramOutput::Agent
+          # @param id
+          #   The unique ID of the 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 item.
+          # @param agent
+          #   The agent that produced this item.
+          # @param type
+          #   The type of the item. Always `program_output`.
           def initialize: (
             id: String,
             call_id: String,
@@ -579,8 +752,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -603,28 +779,63 @@ 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::Beta::BetaResponseItem::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::Beta::BetaResponseItem::ImageGenerationCall::action?
+          # The agent that produced this item.
           attr_accessor agent: OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Agent?
+          # The background setting used for generation.
           attr_accessor background: OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::background?
+          # The output format used for generation.
           attr_accessor output_format: OpenAI::Models::Beta::BetaResponseItem::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::Beta::BetaResponseItem::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::Beta::BetaResponseItem::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 agent
+          #   The agent that produced this item.
+          # @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?,
@@ -681,8 +892,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -751,18 +965,36 @@ 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::Beta::BetaResponseItem::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::Beta::BetaResponseItem::LocalShellCall::status
+          # The type of the local shell call. Always `local_shell_call`.
           attr_accessor type: :local_shell_call
+          # The agent that produced this item.
           attr_accessor agent: OpenAI::Beta::BetaResponseItem::LocalShellCall::Agent?
+          # @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 agent
+          #   The agent that produced this item.
+          # @param type
+          #   The type of the local shell call. Always `local_shell_call`.
           def initialize: (
             id: String,
             action: OpenAI::Beta::BetaResponseItem::LocalShellCall::Action,
@@ -792,18 +1024,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],
@@ -838,8 +1088,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -856,16 +1109,31 @@ 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 agent that produced this item.
           attr_accessor agent: OpenAI::Beta::BetaResponseItem::LocalShellCallOutput::Agent?
+          # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
           attr_accessor status: OpenAI::Models::Beta::BetaResponseItem::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 agent
+          #   The agent that produced this item.
+          # @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,
@@ -885,8 +1153,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -916,18 +1187,36 @@ 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::Beta::BetaResponseItem::McpListTools::Tool]
+          # The type of the item. Always `mcp_list_tools`.
           attr_accessor type: :mcp_list_tools
+          # The agent that produced this item.
           attr_accessor agent: OpenAI::Beta::BetaResponseItem::McpListTools::Agent?
+          # 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 agent
+          #   The agent that produced this item.
+          # @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,
@@ -955,14 +1244,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,
@@ -981,8 +1282,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -1000,18 +1304,36 @@ 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
+          # The agent that produced this item.
           attr_accessor agent: OpenAI::Beta::BetaResponseItem::McpApprovalRequest::Agent?
+          # @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 agent
+          #   The agent that produced this item.
+          # @param type
+          #   The type of the item. Always `mcp_approval_request`.
           def initialize: (
             id: String,
             arguments: String,
@@ -1033,8 +1355,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -1052,18 +1377,36 @@ module OpenAI
           }
         class McpApprovalResponse < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the approval response
           attr_accessor id: String
+          # 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 agent that produced this item.
           attr_accessor agent: OpenAI::Beta::BetaResponseItem::McpApprovalResponse::Agent?
+          # Optional reason for the decision.
           attr_accessor reason: String?
+          # @param id
+          #   The unique ID of the approval response
+          # @param approval_request_id
+          #   The ID of the approval request being answered.
+          # @param approve
+          #   Whether the request was approved.
+          # @param agent
+          #   The agent that produced this item.
+          # @param reason
+          #   Optional reason for the decision.
+          # @param type
+          #   The type of the item. Always `mcp_approval_response`.
           def initialize: (
             id: String,
             approval_request_id: String,
@@ -1085,8 +1428,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }
@@ -1108,30 +1454,68 @@ 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
+          # The agent that produced this item.
           attr_accessor agent: OpenAI::Beta::BetaResponseItem::McpCall::Agent?
+          # 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::Beta::beta_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::Beta::BetaResponseItem::McpCall::status?
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
           def status=: (
             OpenAI::Models::Beta::BetaResponseItem::McpCall::status
           ) -> OpenAI::Models::Beta::BetaResponseItem::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 agent
+          #   The agent that produced this item.
+          # @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,
@@ -1161,8 +1545,11 @@ module OpenAI
           type agent = { agent_name: String }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # The canonical name of the agent that produced this item.
             attr_accessor agent_name: String
+            # @param agent_name
+            #   The canonical name of the agent that produced this item.
             def initialize: (agent_name: String) -> void
             def to_hash: -> { agent_name: String }