openai 0.92.0 → 0.94.0

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

@@ -0,0 +1,65 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_session_environment_reset_event =
+        {
+          environment_id: String,
+          event_id: String,
+          reset_count: Integer,
+          session_id: String,
+          turn_id: String?,
+          ?type: :"agent.session.environment.reset"
+        }
+
+      class AgentSessionEnvironmentResetEvent < OpenAI::Internal::Type::BaseModel
+        # The stable environment ID, retained across sandbox replacements.
+        attr_accessor environment_id: String
+
+        # The unique ID of the event.
+        attr_accessor event_id: String
+
+        # Monotonically increasing reset number. Repeated notifications share this number.
+        attr_accessor reset_count: Integer
+
+        # The ID of the session associated with the event.
+        attr_accessor session_id: String
+
+        # The associated turn, when applicable.
+        attr_accessor turn_id: String?
+
+        # The type of the object. Always `agent.session.environment.reset`.
+        attr_accessor type: :"agent.session.environment.reset"
+
+        # @param environment_id
+        #   The stable environment ID, retained across sandbox replacements.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param reset_count
+        #   Monotonically increasing reset number. Repeated notifications share this number.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn_id
+        #   The associated turn, when applicable.
+        # @param type
+        #   The type of the object. Always `agent.session.environment.reset`.
+        def initialize: (
+          environment_id: String,
+          event_id: String,
+          reset_count: Integer,
+          session_id: String,
+          turn_id: String?,
+          ?type: :"agent.session.environment.reset"
+        ) -> void
+
+        def to_hash: -> {
+          environment_id: String,
+          event_id: String,
+          reset_count: Integer,
+          session_id: String,
+          turn_id: String?,
+          ?type: :"agent.session.environment.reset"
+        }
+      end
+    end
+  end
+end

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

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class AgentSessionEnvironmentState < OpenAI::Internal::Type::BaseModel
+        # The public ID of the environment.
         attr_accessor id: String
 
+        # The error reported while preparing the environment, if any.
         attr_accessor error: OpenAI::Beta::AgentSessionEnvironmentState::Error?
 
+        # The environment's connection status.
         attr_accessor status: OpenAI::Models::Beta::AgentSessionEnvironmentState::status
 
+        # The environment type.
         attr_accessor type: String
 
+        # @param id
+        #   The public ID of the environment.
+        # @param error
+        #   The error reported while preparing the environment, if any.
+        # @param status
+        #   The environment's connection status.
+        # @param type
+        #   The environment type.
         def initialize: (
           id: String,
           error: OpenAI::Beta::AgentSessionEnvironmentState::Error?,
@@ -35,12 +47,21 @@ module OpenAI
         type error = { code: String, message: String, type: String }
 
         class Error < OpenAI::Internal::Type::BaseModel
+          # A machine-readable error code.
           attr_accessor code: String
 
+          # A human-readable error message.
           attr_accessor message: String
 
+          # The error type.
           attr_accessor type: String
 
+          # @param code
+          #   A machine-readable error code.
+          # @param message
+          #   A human-readable error message.
+          # @param type
+          #   The error type.
           def initialize: (code: String, message: String, type: String) -> void
 
           def to_hash: -> { code: String, message: String, type: String }

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

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class AgentSessionErrorEvent < OpenAI::Internal::Type::BaseModel
+        # The error that occurred.
         attr_accessor error: OpenAI::Beta::SessionError
 
+        # 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 type of the object. Always `error`.
         attr_accessor type: :error
 
+        # @param error
+        #   The error that occurred.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param type
+        #   The type of the object. Always `error`.
         def initialize: (
           error: OpenAI::Beta::SessionError,
           event_id: String,

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

@@ -4,6 +4,7 @@ module OpenAI
       type agent_session_event =
         OpenAI::Beta::AgentSessionErrorEvent
         | OpenAI::Beta::AgentSessionEnvironmentReadyEvent
+        | OpenAI::Beta::AgentSessionEnvironmentResetEvent
         | OpenAI::Beta::AgentOutputCommandExecutionOutputDeltaEvent
         | OpenAI::Beta::AgentSessionCreatedEvent
         | OpenAI::Beta::AgentSessionTurnCreatedEvent

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

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

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

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

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

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

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

@@ -9,16 +9,26 @@ module OpenAI
         }
 
       class AgentSessionInputMessageParam < OpenAI::Internal::Type::BaseModel
+        # The content of the message.
         attr_accessor content: ::Array[OpenAI::Models::Beta::input_content_param]
 
+        # The role of the message author. Always `user`.
         attr_accessor role: :user
 
+        # The type of the input item. Always `message`.
         attr_reader type: OpenAI::Models::Beta::AgentSessionInputMessageParam::type_?
 
+        # The type of the input item. Always `message`.
         def type=: (
           OpenAI::Models::Beta::AgentSessionInputMessageParam::type_
         ) -> OpenAI::Models::Beta::AgentSessionInputMessageParam::type_
 
+        # @param content
+        #   The content of the message.
+        # @param type
+        #   The type of the input item. Always `message`.
+        # @param role
+        #   The role of the message author. Always `user`.
         def initialize: (
           content: ::Array[OpenAI::Models::Beta::input_content_param],
           ?type: OpenAI::Models::Beta::AgentSessionInputMessageParam::type_,

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

@@ -16,10 +16,16 @@ module OpenAI
           }
 
         class AgentSessionInputMessage < OpenAI::Internal::Type::BaseModel
+          # The user messages to add to the session.
           attr_accessor input: ::Array[OpenAI::Beta::AgentSessionInputMessageParam]
 
+          # The type of the object. Always `agent.session.input.message`.
           attr_accessor type: :"agent.session.input.message"
 
+          # @param input
+          #   The user messages to add to the session.
+          # @param type
+          #   The type of the object. Always `agent.session.input.message`.
           def initialize: (
             input: ::Array[OpenAI::Beta::AgentSessionInputMessageParam],
             ?type: :"agent.session.input.message"
@@ -35,8 +41,11 @@ module OpenAI
           { ?type: :"agent.session.input.cancel" }
 
         class AgentSessionInputCancel < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `agent.session.input.cancel`.
           attr_accessor type: :"agent.session.input.cancel"
 
+          # @param type
+          #   The type of the object. Always `agent.session.input.cancel`.
           def initialize: (?type: :"agent.session.input.cancel") -> void
 
           def to_hash: -> { ?type: :"agent.session.input.cancel" }
@@ -53,18 +62,36 @@ module OpenAI
           }
 
         class AgentSessionInputToolResult < OpenAI::Internal::Type::BaseModel
+          # The ID of the function call.
           attr_accessor call_id: String
 
+          # Whether the function call succeeded.
           attr_accessor success: bool
 
+          # The ID of the turn that requested the function call.
           attr_accessor turn_id: String
 
+          # The type of the object. Always `agent.session.input.tool_result`.
           attr_accessor type: :"agent.session.input.tool_result"
 
+          # The error message when the call failed.
           attr_accessor error: String?
 
+          # The function result when the call succeeded.
           attr_accessor output: OpenAI::Models::Beta::agent_function_call_output_param?
 
+          # @param call_id
+          #   The ID of the function call.
+          # @param success
+          #   Whether the function call succeeded.
+          # @param turn_id
+          #   The ID of the turn that requested the function call.
+          # @param error
+          #   The error message when the call failed.
+          # @param output
+          #   The function result when the call succeeded.
+          # @param type
+          #   The type of the object. Always `agent.session.input.tool_result`.
           def initialize: (
             call_id: String,
             success: bool,

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

@@ -32,20 +32,41 @@ module OpenAI
           }
 
         class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
+          # The ID of the function call output item.
           attr_accessor id: String
 
+          # The ID of the function call that produced this output.
           attr_accessor call_id: String
 
+          # The error message, if the call failed.
           attr_accessor error: String?
 
+          # The function result, if the call succeeded.
           attr_accessor output: OpenAI::Models::Beta::agent_function_call_output?
 
+          # The status of the function 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 `function_call_output`.
           attr_accessor type: :function_call_output
 
+          # @param id
+          #   The ID of the function call output item.
+          # @param call_id
+          #   The ID of the function call that produced this output.
+          # @param error
+          #   The error message, if the call failed.
+          # @param output
+          #   The function result, if the call succeeded.
+          # @param status
+          #   The status of the function call.
+          # @param turn_id
+          #   The ID of the turn that contains this item.
+          # @param type
+          #   The item type. Always `function_call_output`.
           def initialize: (
             id: String,
             call_id: String,
@@ -78,18 +99,36 @@ module OpenAI
           }
 
         class AgentMessage < OpenAI::Internal::Type::BaseModel
+          # The ID of the message.
           attr_accessor id: String
 
+          # The content exchanged between the agents.
           attr_accessor content: ::Array[OpenAI::Models::Beta::agent_content]
 
+          # The ID or name of the receiving agent.
           attr_accessor recipient_agent_id: String
 
+          # The ID or name of the sending agent.
           attr_accessor sender_agent_id: String
 
+          # The ID of the turn that contains this item.
           attr_accessor turn_id: String
 
+          # The item type. Always `agent_message`.
           attr_accessor type: :agent_message
 
+          # @param id
+          #   The ID of the message.
+          # @param content
+          #   The content exchanged between the agents.
+          # @param recipient_agent_id
+          #   The ID or name of the receiving agent.
+          # @param sender_agent_id
+          #   The ID or name of the sending agent.
+          # @param turn_id
+          #   The ID of the turn that contains this item.
+          # @param type
+          #   The item type. Always `agent_message`.
           def initialize: (
             id: String,
             content: ::Array[OpenAI::Models::Beta::agent_content],

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

@@ -13,20 +13,43 @@ module OpenAI
         }
 
       class AgentSessionMessage < OpenAI::Internal::Type::BaseModel
+        # The ID of this item, or null for legacy user messages whose ID was not recorded.
         attr_accessor id: String?
 
+        # The content of the message. User messages contain input text or images;
+        # assistant messages contain output text.
         attr_accessor content: ::Array[OpenAI::Models::Beta::agent_session_message_content]
 
+        # The phase of an assistant message. Null for user messages.
         attr_accessor phase: OpenAI::Models::Beta::AgentSessionMessage::phase?
 
+        # The role of the message author.
         attr_accessor role: OpenAI::Models::Beta::AgentSessionMessage::role
 
+        # The status of the message. User messages are always `completed`.
         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 this item, or null for legacy user messages whose ID was not recorded.
+        # @param content
+        #   The content of the message. User messages contain input text or images;
+        #   assistant messages contain output text.
+        # @param phase
+        #   The phase of an assistant message. Null for user messages.
+        # @param role
+        #   The role of the message author.
+        # @param status
+        #   The status of the message. User messages are always `completed`.
+        # @param turn_id
+        #   The ID of the turn that contains this item.
+        # @param type
+        #   The item type. Always `message`.
         def initialize: (
           id: String?,
           content: ::Array[OpenAI::Models::Beta::agent_session_message_content],

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

@@ -12,10 +12,16 @@ module OpenAI
         type input_text = { text: String, ?type: :input_text }
 
         class InputText < OpenAI::Internal::Type::BaseModel
+          # The text supplied by the user.
           attr_accessor text: String
 
+          # The type of the object. Always `input_text`.
           attr_accessor type: :input_text
 
+          # @param text
+          #   The text supplied by the user.
+          # @param type
+          #   The type of the object. Always `input_text`.
           def initialize: (text: String, ?type: :input_text) -> void
 
           def to_hash: -> { text: String, ?type: :input_text }
@@ -24,10 +30,18 @@ module OpenAI
         type input_image = { image_url: String, ?type: :input_image }
 
         class InputImage < OpenAI::Internal::Type::BaseModel
+          # The URL of the image supplied by the user, which may be a base64-encoded data
+          # URL.
           attr_accessor image_url: String
 
+          # The type of the object. Always `input_image`.
           attr_accessor type: :input_image
 
+          # @param image_url
+          #   The URL of the image supplied by the user, which may be a base64-encoded data
+          #   URL.
+          # @param type
+          #   The type of the object. Always `input_image`.
           def initialize: (image_url: String, ?type: :input_image) -> void
 
           def to_hash: -> { image_url: String, ?type: :input_image }
@@ -36,10 +50,16 @@ module OpenAI
         type output_text = { text: String, ?type: :output_text }
 
         class OutputText < OpenAI::Internal::Type::BaseModel
+          # The text produced by the assistant.
           attr_accessor text: String
 
+          # The type of the object. Always `output_text`.
           attr_accessor type: :output_text
 
+          # @param text
+          #   The text produced by the assistant.
+          # @param type
+          #   The type of the object. Always `output_text`.
           def initialize: (text: String, ?type: :output_text) -> void
 
           def to_hash: -> { text: String, ?type: :output_text }

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

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class AgentSessionRequiresActionEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The session and its current required actions.
         attr_accessor session: OpenAI::Beta::AgentSession
 
+        # The type of the object. Always `agent.session.requires_action`.
         attr_accessor type: :"agent.session.requires_action"
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session
+        #   The session and its current required actions.
+        # @param type
+        #   The type of the object. Always `agent.session.requires_action`.
         def initialize: (
           event_id: String,
           session: OpenAI::Beta::AgentSession,

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

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

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

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

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

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

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class AgentSessionTurnCancelledEvent < OpenAI::Internal::Type::BaseModel
+        # 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 cancelled turn.
         attr_accessor turn: OpenAI::Beta::Agents::Sessions::Turn
 
+        # The ID of the turn associated with the event.
         attr_accessor turn_id: String
 
+        # The type of the object. Always `agent.session.turn.cancelled`.
         attr_accessor type: :"agent.session.turn.cancelled"
 
+        # Token usage by the root agent during the turn, when available.
         attr_accessor usage: OpenAI::Beta::TokenUsage?
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn
+        #   The cancelled turn.
+        # @param turn_id
+        #   The ID of the turn associated with the event.
+        # @param usage
+        #   Token usage by the root agent during the turn, when available.
+        # @param type
+        #   The type of the object. Always `agent.session.turn.cancelled`.
         def initialize: (
           event_id: String,
           session_id: String,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class AgentSessionTurnCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # 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 completed turn.
         attr_accessor turn: OpenAI::Beta::Agents::Sessions::Turn
 
+        # The ID of the turn associated with the event.
         attr_accessor turn_id: String
 
+        # The type of the object. Always `agent.session.turn.completed`.
         attr_accessor type: :"agent.session.turn.completed"
 
+        # Token usage by the root agent during the turn, when available.
         attr_accessor usage: OpenAI::Beta::TokenUsage?
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn
+        #   The completed turn.
+        # @param turn_id
+        #   The ID of the turn associated with the event.
+        # @param usage
+        #   Token usage by the root agent during the turn, when available.
+        # @param type
+        #   The type of the object. Always `agent.session.turn.completed`.
         def initialize: (
           event_id: String,
           session_id: String,