openai 0.91.0 → 0.93.0

data/sig/openai/models/beta/agent_mcp_call_item.rbs

@@ -15,24 +15,51 @@ module OpenAI
         }
 
       class AgentMcpCallItem < OpenAI::Internal::Type::BaseModel
+        # The ID of the MCP call item.
         attr_accessor id: String
 
+        # The arguments passed to the MCP tool.
         attr_accessor arguments: top
 
+        # The error returned by the MCP tool, if any.
         attr_accessor error: top
 
+        # The name of the MCP tool.
         attr_accessor name: String
 
+        # The output returned by the MCP tool, if any.
         attr_accessor output: top
 
+        # The label of the MCP server.
         attr_accessor server_label: String
 
+        # The status of the MCP tool call.
         attr_accessor status: OpenAI::Models::Beta::agent_function_call_status
 
+        # The ID of the turn that contains this item.
         attr_accessor turn_id: String
 
+        # The item type. Always `mcp_call`.
         attr_accessor type: :mcp_call
 
+        # @param id
+        #   The ID of the MCP call item.
+        # @param arguments
+        #   The arguments passed to the MCP tool.
+        # @param error
+        #   The error returned by the MCP tool, if any.
+        # @param name
+        #   The name of the MCP tool.
+        # @param output
+        #   The output returned by the MCP tool, if any.
+        # @param server_label
+        #   The label of the MCP server.
+        # @param status
+        #   The status of the MCP tool call.
+        # @param turn_id
+        #   The ID of the turn that contains this item.
+        # @param type
+        #   The item type. Always `mcp_call`.
         def initialize: (
           id: String,
           arguments: top,

data/sig/openai/models/beta/agent_output_command_execution_output_delta_event.rbs

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class AgentOutputCommandExecutionOutputDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The output text that was appended.
         attr_accessor delta: String
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the command execution item.
         attr_accessor item_id: String
 
+        # The index of the item in the turn output.
         attr_accessor output_index: Integer
 
+        # The ID of the session associated with the event.
         attr_accessor session_id: String
 
+        # The ID of the turn associated with the event, when applicable.
         attr_accessor turn_id: String?
 
+        # The type of the object. Always `agent.output.command_execution_output.delta`.
         attr_accessor type: :"agent.output.command_execution_output.delta"
 
+        # @param delta
+        #   The output text that was appended.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item_id
+        #   The ID of the command execution item.
+        # @param output_index
+        #   The index of the item in the turn output.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param type
+        #   The type of the object. Always `agent.output.command_execution_output.delta`.
         def initialize: (
           delta: String,
           event_id: String,

data/sig/openai/models/beta/agent_reasoning.rbs

@@ -8,10 +8,18 @@ module OpenAI
         }
 
       class AgentReasoning < OpenAI::Internal::Type::BaseModel
+        # The requested reasoning effort, or `null` when the model selects its own
+        # default.
         attr_accessor effort: OpenAI::Models::Beta::AgentReasoning::effort?
 
+        # The requested reasoning summary format, or `null` when summaries are disabled.
         attr_accessor summary: OpenAI::Models::Beta::AgentReasoning::summary?
 
+        # @param effort
+        #   The requested reasoning effort, or `null` when the model selects its own
+        #   default.
+        # @param summary
+        #   The requested reasoning summary format, or `null` when summaries are disabled.
         def initialize: (
           effort: OpenAI::Models::Beta::AgentReasoning::effort?,
           summary: OpenAI::Models::Beta::AgentReasoning::summary?

data/sig/openai/models/beta/agent_reasoning_item.rbs

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class AgentReasoningItem < OpenAI::Internal::Type::BaseModel
+        # The ID of the reasoning item.
         attr_accessor id: String
 
+        # The status of the reasoning item.
         attr_accessor status: OpenAI::Models::Beta::agent_output_item_status?
 
+        # The reasoning summaries produced by the agent.
         attr_accessor summary: ::Array[OpenAI::Beta::SummaryText]
 
+        # The ID of the turn that contains this item.
         attr_accessor turn_id: String
 
+        # The item type. Always `reasoning`.
         attr_accessor type: :reasoning
 
+        # @param id
+        #   The ID of the reasoning item.
+        # @param status
+        #   The status of the reasoning item.
+        # @param summary
+        #   The reasoning summaries produced by the agent.
+        # @param turn_id
+        #   The ID of the turn that contains this item.
+        # @param type
+        #   The item type. Always `reasoning`.
         def initialize: (
           id: String,
           status: OpenAI::Models::Beta::agent_output_item_status?,

data/sig/openai/models/beta/agent_reasoning_param.rbs

@@ -8,10 +8,18 @@ module OpenAI
         }
 
       class AgentReasoningParam < OpenAI::Internal::Type::BaseModel
+        # The amount of reasoning effort the model should use. Omission lets the model
+        # select it.
         attr_accessor effort: OpenAI::Models::Beta::AgentReasoningParam::effort?
 
+        # Controls whether the response includes a reasoning summary.
         attr_accessor summary: OpenAI::Models::Beta::AgentReasoningParam::summary?
 
+        # @param effort
+        #   The amount of reasoning effort the model should use. Omission lets the model
+        #   select it.
+        # @param summary
+        #   Controls whether the response includes a reasoning summary.
         def initialize: (
           ?effort: OpenAI::Models::Beta::AgentReasoningParam::effort?,
           ?summary: OpenAI::Models::Beta::AgentReasoningParam::summary?

data/sig/openai/models/beta/agent_resume_subagent_call_item.rbs

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class AgentResumeSubagentCallItem < OpenAI::Internal::Type::BaseModel
+        # The ID of the tool call item.
         attr_accessor id: String
 
+        # The ID of the agent to resume.
         attr_accessor recipient_agent_id: String
 
+        # The ID of the agent requesting the resume.
         attr_accessor sender_agent_id: String
 
+        # The status of the tool call.
         attr_accessor status: OpenAI::Models::Beta::agent_function_call_status
 
+        # The ID of the turn that contains this item.
         attr_accessor turn_id: String
 
+        # The item type. Always `resume_subagent_call`.
         attr_accessor type: :resume_subagent_call
 
+        # @param id
+        #   The ID of the tool call item.
+        # @param recipient_agent_id
+        #   The ID of the agent to resume.
+        # @param sender_agent_id
+        #   The ID of the agent requesting the resume.
+        # @param status
+        #   The status of the tool call.
+        # @param turn_id
+        #   The ID of the turn that contains this item.
+        # @param type
+        #   The item type. Always `resume_subagent_call`.
         def initialize: (
           id: String,
           recipient_agent_id: String,

data/sig/openai/models/beta/agent_send_subagent_input_call_item.rbs

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class AgentSendSubagentInputCallItem < OpenAI::Internal::Type::BaseModel
+        # The ID of the tool call item.
         attr_accessor id: String
 
+        # The input sent to the receiving agent.
         attr_accessor content: ::Array[OpenAI::Models::Beta::agent_content]
 
+        # The ID of the agent receiving the input.
         attr_accessor recipient_agent_id: String
 
+        # The ID of the agent sending the input.
         attr_accessor sender_agent_id: String
 
+        # The status of the tool call.
         attr_accessor status: OpenAI::Models::Beta::agent_function_call_status
 
+        # The ID of the turn that contains this item.
         attr_accessor turn_id: String
 
+        # The item type. Always `send_subagent_input_call`.
         attr_accessor type: :send_subagent_input_call
 
+        # @param id
+        #   The ID of the tool call item.
+        # @param content
+        #   The input sent to the receiving agent.
+        # @param recipient_agent_id
+        #   The ID of the agent receiving the input.
+        # @param sender_agent_id
+        #   The ID of the agent sending the input.
+        # @param status
+        #   The status of the tool call.
+        # @param turn_id
+        #   The ID of the turn that contains this item.
+        # @param type
+        #   The item type. Always `send_subagent_input_call`.
         def initialize: (
           id: String,
           content: ::Array[OpenAI::Models::Beta::agent_content],

data/sig/openai/models/beta/agent_session.rbs

@@ -18,30 +18,68 @@ module OpenAI
         }
 
       class AgentSession < OpenAI::Internal::Type::BaseModel
+        # The ID of the session.
         attr_accessor id: String
 
+        # The agent running in the session.
         attr_accessor agent: OpenAI::Beta::AgentSession::Agent
 
+        # The Unix timestamp, in seconds, when the session was created.
         attr_accessor created_at: Integer
 
+        # The execution environment for the session.
         attr_accessor environment: OpenAI::Models::Beta::environment
 
+        # The error that caused the session to fail, if any.
         attr_accessor error: String?
 
+        # The Unix timestamp, in seconds, when the session was last active.
         attr_accessor last_active_at: Integer
 
+        # Custom string key-value pairs attached to the session.
         attr_accessor metadata: ::Hash[Symbol, String]
 
+        # The object type. Always `agent.session`.
         attr_accessor object: :"agent.session"
 
+        # Actions that must be completed before the session can continue.
         attr_accessor required_actions: ::Array[OpenAI::Models::Beta::AgentSession::required_action]
 
+        # The current status of the session.
         attr_accessor status: OpenAI::Models::Beta::AgentSession::status
 
+        # Best-effort token usage for the session, or null if unknown. Recorded usage may
+        # change.
         attr_accessor usage: OpenAI::Beta::TokenUsage?
 
+        # The IDs of vaults made available to the session.
         attr_accessor vault_ids: ::Array[String]
 
+        # @param id
+        #   The ID of the session.
+        # @param agent
+        #   The agent running in the session.
+        # @param created_at
+        #   The Unix timestamp, in seconds, when the session was created.
+        # @param environment
+        #   The execution environment for the session.
+        # @param error
+        #   The error that caused the session to fail, if any.
+        # @param last_active_at
+        #   The Unix timestamp, in seconds, when the session was last active.
+        # @param metadata
+        #   Custom string key-value pairs attached to the session.
+        # @param required_actions
+        #   Actions that must be completed before the session can continue.
+        # @param status
+        #   The current status of the session.
+        # @param usage
+        #   Best-effort token usage for the session, or null if unknown. Recorded usage may
+        #   change.
+        # @param vault_ids
+        #   The IDs of vaults made available to the session.
+        # @param object
+        #   The object type. Always `agent.session`.
         def initialize: (
           id: String,
           agent: OpenAI::Beta::AgentSession::Agent,
@@ -86,24 +124,53 @@ module OpenAI
           }
 
         class Agent < OpenAI::Internal::Type::BaseModel
+          # The ID of the agent.
           attr_accessor id: String
 
+          # Custom instructions appended to the agent's default base instructions.
           attr_accessor instructions: String?
 
+          # The model used by the agent.
           attr_accessor model: String
 
+          # Configuration for creating and coordinating subagents.
           attr_accessor multi_agent: OpenAI::Beta::MultiAgentConfig
 
+          # The reusable agent's name when the session was created, or null if no name was
+          # saved. Later changes to the agent's name do not affect this value.
           attr_accessor name: String?
 
+          # The agent's reasoning configuration.
           attr_accessor reasoning: OpenAI::Beta::AgentReasoning
 
+          # The effective service-tier policy for model requests. Defaults to `auto`.
           attr_accessor service_tier: OpenAI::Models::Beta::AgentSession::Agent::service_tier
 
+          # Configuration for text generated by the agent.
           attr_accessor text: OpenAI::Beta::AgentText
 
+          # Tools available to the agent.
           attr_accessor tools: ::Array[OpenAI::Models::Beta::agent_tool]
 
+          # @param id
+          #   The ID of the agent.
+          # @param instructions
+          #   Custom instructions appended to the agent's default base instructions.
+          # @param model
+          #   The model used by the agent.
+          # @param multi_agent
+          #   Configuration for creating and coordinating subagents.
+          # @param name
+          #   The reusable agent's name when the session was created, or null if no name was
+          #   saved. Later changes to the agent's name do not affect this value.
+          # @param reasoning
+          #   The agent's reasoning configuration.
+          # @param service_tier
+          #   The effective service-tier policy for model requests. Defaults to `auto`.
+          # @param text
+          #   Configuration for text generated by the agent.
+          # @param tools
+          #   Tools available to the agent.
           def initialize: (
             id: String,
             instructions: String?,
@@ -160,16 +227,31 @@ module OpenAI
             }
 
           class FunctionCall < OpenAI::Internal::Type::BaseModel
+            # The arguments supplied by the model.
             attr_accessor arguments: top
 
+            # The ID to include when submitting the function result.
             attr_accessor call_id: String
 
+            # The function name.
             attr_accessor name: String
 
+            # The ID of the turn that requested the function call.
             attr_accessor turn_id: String
 
+            # The type of the object. Always `function_call`.
             attr_accessor type: :function_call
 
+            # @param arguments
+            #   The arguments supplied by the model.
+            # @param call_id
+            #   The ID to include when submitting the function result.
+            # @param name
+            #   The function name.
+            # @param turn_id
+            #   The ID of the turn that requested the function call.
+            # @param type
+            #   The type of the object. Always `function_call`.
             def initialize: (
               arguments: top,
               call_id: String,
@@ -191,10 +273,16 @@ module OpenAI
             { environment_id: String, ?type: :environment_connection }
 
           class EnvironmentConnection < OpenAI::Internal::Type::BaseModel
+            # The ID of the environment to reconnect.
             attr_accessor environment_id: String
 
+            # The type of the object. Always `environment_connection`.
             attr_accessor type: :environment_connection
 
+            # @param environment_id
+            #   The ID of the environment to reconnect.
+            # @param type
+            #   The type of the object. Always `environment_connection`.
             def initialize: (
               environment_id: String,
               ?type: :environment_connection

data/sig/openai/models/beta/agent_session_assistant_message.rbs

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class AgentSessionAssistantMessage < OpenAI::Internal::Type::BaseModel
+        # The ID of the message.
         attr_accessor id: String
 
+        # The content of the message.
         attr_accessor content: ::Array[OpenAI::Beta::OutputText]
 
+        # The phase of the assistant message.
         attr_accessor phase: OpenAI::Models::Beta::AgentSessionAssistantMessage::phase?
 
+        # The role of the message author. Always `assistant`.
         attr_accessor role: :assistant
 
+        # The status of the message.
         attr_accessor status: OpenAI::Models::Beta::agent_output_item_status
 
+        # The ID of the turn that contains this item.
         attr_accessor turn_id: String
 
+        # The item type. Always `message`.
         attr_accessor type: :message
 
+        # @param id
+        #   The ID of the message.
+        # @param content
+        #   The content of the message.
+        # @param phase
+        #   The phase of the assistant message.
+        # @param status
+        #   The status of the message.
+        # @param turn_id
+        #   The ID of the turn that contains this item.
+        # @param role
+        #   The role of the message author. Always `assistant`.
+        # @param type
+        #   The item type. Always `message`.
         def initialize: (
           id: String,
           content: ::Array[OpenAI::Beta::OutputText],

data/sig/openai/models/beta/agent_session_created_event.rbs

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class AgentSessionCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The session that was created.
         attr_accessor session: OpenAI::Beta::AgentSession
 
+        # The type of the object. Always `agent.session.created`.
         attr_accessor type: :"agent.session.created"
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session
+        #   The session that was created.
+        # @param type
+        #   The type of the object. Always `agent.session.created`.
         def initialize: (
           event_id: String,
           session: OpenAI::Beta::AgentSession,

data/sig/openai/models/beta/agent_session_deleted.rbs

@@ -5,12 +5,23 @@ module OpenAI
         { id: String, deleted: bool, ?object: :"agent.session.deleted" }
 
       class AgentSessionDeleted < OpenAI::Internal::Type::BaseModel
+        # The ID of the deleted session.
         attr_accessor id: String
 
+        # Whether the session has been removed from the public API. Always `true`.
+        # Physical cleanup may still be in progress.
         attr_accessor deleted: bool
 
+        # The object type. Always `agent.session.deleted`.
         attr_accessor object: :"agent.session.deleted"
 
+        # @param id
+        #   The ID of the deleted session.
+        # @param deleted
+        #   Whether the session has been removed from the public API. Always `true`.
+        #   Physical cleanup may still be in progress.
+        # @param object
+        #   The object type. Always `agent.session.deleted`.
         def initialize: (
           id: String,
           deleted: bool,

data/sig/openai/models/beta/agent_session_environment_connected_event.rbs

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class AgentSessionEnvironmentConnectedEvent < OpenAI::Internal::Type::BaseModel
+        # The current environment state.
         attr_accessor environment: OpenAI::Beta::AgentSessionEnvironmentState
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the session associated with the event.
         attr_accessor session_id: String
 
+        # The ID of the turn associated with the event, when applicable.
         attr_accessor turn_id: String?
 
+        # The type of the object. Always `agent.session.environment.connected`.
         attr_accessor type: :"agent.session.environment.connected"
 
+        # @param environment
+        #   The current environment state.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param type
+        #   The type of the object. Always `agent.session.environment.connected`.
         def initialize: (
           environment: OpenAI::Beta::AgentSessionEnvironmentState,
           event_id: String,

data/sig/openai/models/beta/agent_session_environment_disconnected_event.rbs

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class AgentSessionEnvironmentDisconnectedEvent < OpenAI::Internal::Type::BaseModel
+        # The current environment state.
         attr_accessor environment: OpenAI::Beta::AgentSessionEnvironmentState
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the session associated with the event.
         attr_accessor session_id: String
 
+        # The ID of the turn associated with the event, when applicable.
         attr_accessor turn_id: String?
 
+        # The type of the object. Always `agent.session.environment.disconnected`.
         attr_accessor type: :"agent.session.environment.disconnected"
 
+        # @param environment
+        #   The current environment state.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param type
+        #   The type of the object. Always `agent.session.environment.disconnected`.
         def initialize: (
           environment: OpenAI::Beta::AgentSessionEnvironmentState,
           event_id: String,

data/sig/openai/models/beta/agent_session_environment_failed_event.rbs

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class AgentSessionEnvironmentFailedEvent < OpenAI::Internal::Type::BaseModel
+        # The current environment state.
         attr_accessor environment: OpenAI::Beta::AgentSessionEnvironmentState
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the session associated with the event.
         attr_accessor session_id: String
 
+        # The ID of the turn associated with the event, when applicable.
         attr_accessor turn_id: String?
 
+        # The type of the object. Always `agent.session.environment.failed`.
         attr_accessor type: :"agent.session.environment.failed"
 
+        # @param environment
+        #   The current environment state.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param type
+        #   The type of the object. Always `agent.session.environment.failed`.
         def initialize: (
           environment: OpenAI::Beta::AgentSessionEnvironmentState,
           event_id: String,

data/sig/openai/models/beta/agent_session_environment_pending_event.rbs

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class AgentSessionEnvironmentPendingEvent < OpenAI::Internal::Type::BaseModel
+        # The current environment state.
         attr_accessor environment: OpenAI::Beta::AgentSessionEnvironmentState
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the session associated with the event.
         attr_accessor session_id: String
 
+        # The ID of the turn associated with the event, when applicable.
         attr_accessor turn_id: String?
 
+        # The type of the object. Always `agent.session.environment.pending`.
         attr_accessor type: :"agent.session.environment.pending"
 
+        # @param environment
+        #   The current environment state.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param type
+        #   The type of the object. Always `agent.session.environment.pending`.
         def initialize: (
           environment: OpenAI::Beta::AgentSessionEnvironmentState,
           event_id: String,

data/sig/openai/models/beta/agent_session_environment_ready_event.rbs

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class AgentSessionEnvironmentReadyEvent < OpenAI::Internal::Type::BaseModel
+        # The current environment state.
         attr_accessor environment: OpenAI::Beta::AgentSessionEnvironmentState
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the session associated with the event.
         attr_accessor session_id: String
 
+        # The ID of the turn associated with the event, when applicable.
         attr_accessor turn_id: String?
 
+        # The type of the object. Always `agent.session.environment.ready`.
         attr_accessor type: :"agent.session.environment.ready"
 
+        # @param environment
+        #   The current environment state.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param type
+        #   The type of the object. Always `agent.session.environment.ready`.
         def initialize: (
           environment: OpenAI::Beta::AgentSessionEnvironmentState,
           event_id: String,