openai 0.92.0 → 0.93.0

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

@@ -15,20 +15,45 @@ module OpenAI
         }
 
       class BetaResponseCodeInterpreterToolCall < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the code interpreter tool call.
         attr_accessor id: String
 
+        # The code to run, or null if not available.
         attr_accessor code: String?
 
+        # The ID of the container used to run the code.
         attr_accessor container_id: String
 
+        # The outputs generated by the code interpreter, such as logs or images. Can be
+        # null if no outputs are available.
         attr_accessor outputs: ::Array[OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall::output]?
 
+        # The status of the code interpreter tool call. Valid values are `in_progress`,
+        # `completed`, `incomplete`, `interpreting`, and `failed`.
         attr_accessor status: OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall::status
 
+        # The type of the code interpreter tool call. Always `code_interpreter_call`.
         attr_accessor type: :code_interpreter_call
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseCodeInterpreterToolCall::Agent?
 
+        # @param id
+        #   The unique ID of the code interpreter tool call.
+        # @param code
+        #   The code to run, or null if not available.
+        # @param container_id
+        #   The ID of the container used to run the code.
+        # @param outputs
+        #   The outputs generated by the code interpreter, such as logs or images. Can be
+        #   null if no outputs are available.
+        # @param status
+        #   The status of the code interpreter tool call. Valid values are `in_progress`,
+        #   `completed`, `incomplete`, `interpreting`, and `failed`.
+        # @param agent
+        #   The agent that produced this item.
+        # @param type
+        #   The type of the code interpreter tool call. Always `code_interpreter_call`.
         def initialize: (
           id: String,
           code: String?,
@@ -59,10 +84,16 @@ module OpenAI
           type logs = { logs: String, ?type: :logs }
 
           class Logs < OpenAI::Internal::Type::BaseModel
+            # The logs output from the code interpreter.
             attr_accessor logs: String
 
+            # The type of the output. Always `logs`.
             attr_accessor type: :logs
 
+            # @param logs
+            #   The logs output from the code interpreter.
+            # @param type
+            #   The type of the output. Always `logs`.
             def initialize: (logs: String, ?type: :logs) -> void
 
             def to_hash: -> { logs: String, ?type: :logs }
@@ -71,10 +102,16 @@ module OpenAI
           type image = { ?type: :image, url: String }
 
           class Image < OpenAI::Internal::Type::BaseModel
+            # The type of the output. Always `image`.
             attr_accessor type: :image
 
+            # The URL of the image output from the code interpreter.
             attr_accessor url: String
 
+            # @param url
+            #   The URL of the image output from the code interpreter.
+            # @param type
+            #   The type of the output. Always `image`.
             def initialize: (url: String, ?type: :image) -> void
 
             def to_hash: -> { ?type: :image, url: String }
@@ -101,8 +138,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 }

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

@@ -13,20 +13,36 @@ module OpenAI
         }
 
       class BetaResponseCompactionCompactingEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the compaction output item.
         attr_accessor item_id: String
 
+        # The index of the compaction output item.
         attr_accessor output_index: Integer
 
+        # The sequence number of the event that was emitted.
         attr_accessor sequence_number: Integer
 
+        # The type of the event, always `response.compaction.compacting`.
         attr_accessor type: :"response.compaction.compacting"
 
+        # The agent that owns this multi-agent streaming event.
         attr_reader agent: OpenAI::Beta::BetaResponseCompactionCompactingEvent::Agent?
 
+        # The agent that owns this multi-agent streaming event.
         def agent=: (
           OpenAI::Beta::BetaResponseCompactionCompactingEvent::Agent
         ) -> OpenAI::Beta::BetaResponseCompactionCompactingEvent::Agent
 
+        # @param item_id
+        #   The ID of the compaction output item.
+        # @param output_index
+        #   The index of the compaction output item.
+        # @param sequence_number
+        #   The sequence number of the event that was emitted.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event, always `response.compaction.compacting`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -46,8 +62,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 }

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

@@ -13,22 +13,39 @@ module OpenAI
         }
 
       class BetaResponseCompactionItem < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the compaction item.
         attr_accessor id: String
 
+        # The encrypted content that was produced by compaction.
         attr_accessor encrypted_content: String
 
+        # The type of the item. Always `compaction`.
         attr_accessor type: :compaction
 
+        # The agent that produced this item.
         attr_reader agent: OpenAI::Beta::BetaResponseCompactionItem::Agent?
 
+        # The agent that produced this item.
         def agent=: (
           OpenAI::Beta::BetaResponseCompactionItem::Agent
         ) -> OpenAI::Beta::BetaResponseCompactionItem::Agent
 
+        # The identifier of the actor that created the item.
         attr_reader created_by: String?
 
+        # The identifier of the actor that created the item.
         def created_by=: (String) -> String
 
+        # @param id
+        #   The unique ID of the compaction item.
+        # @param encrypted_content
+        #   The encrypted content that was produced by compaction.
+        # @param agent
+        #   The agent that produced this item.
+        # @param created_by
+        #   The identifier of the actor that created the item.
+        # @param type
+        #   The type of the item. Always `compaction`.
         def initialize: (
           id: String,
           encrypted_content: String,
@@ -48,8 +65,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 }

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

@@ -12,14 +12,26 @@ module OpenAI
         }
 
       class BetaResponseCompactionItemParam < OpenAI::Internal::Type::BaseModel
+        # The encrypted content of the compaction summary.
         attr_accessor encrypted_content: String
 
+        # The type of the item. Always `compaction`.
         attr_accessor type: :compaction
 
+        # The ID of the compaction item.
         attr_accessor id: String?
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseCompactionItemParam::Agent?
 
+        # @param encrypted_content
+        #   The encrypted content of the compaction summary.
+        # @param id
+        #   The ID of the compaction item.
+        # @param agent
+        #   The agent that produced this item.
+        # @param type
+        #   The type of the item. Always `compaction`.
         def initialize: (
           encrypted_content: String,
           ?id: String?,
@@ -37,8 +49,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 }

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

@@ -12,14 +12,26 @@ module OpenAI
         }
 
       class BetaResponseCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # Properties of the completed response.
         attr_accessor response: OpenAI::Beta::BetaResponse
 
+        # The sequence number for this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.completed`.
         attr_accessor type: :"response.completed"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseCompletedEvent::Agent?
 
+        # @param response
+        #   Properties of the completed response.
+        # @param sequence_number
+        #   The sequence number for this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.completed`.
         def initialize: (
           response: OpenAI::Beta::BetaResponse,
           sequence_number: Integer,
@@ -37,8 +49,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 }

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

@@ -16,30 +16,61 @@ module OpenAI
         }
 
       class BetaResponseComputerToolCall < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the computer call.
         attr_accessor id: String
 
+        # An identifier used when responding to the tool call with output.
         attr_accessor call_id: String
 
+        # The pending safety checks for the computer call.
         attr_accessor pending_safety_checks: ::Array[OpenAI::Beta::BetaResponseComputerToolCall::PendingSafetyCheck]
 
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
         attr_accessor status: OpenAI::Models::Beta::BetaResponseComputerToolCall::status
 
+        # The type of the computer call. Always `computer_call`.
         attr_accessor type: OpenAI::Models::Beta::BetaResponseComputerToolCall::type_
 
+        # A click action.
         attr_reader action: OpenAI::Models::Beta::beta_computer_action?
 
+        # A click action.
         def action=: (
           OpenAI::Models::Beta::beta_computer_action
         ) -> OpenAI::Models::Beta::beta_computer_action
 
+        # Flattened batched actions for `computer_use`. Each action includes an `type`
+        # discriminator and action-specific fields.
         attr_reader actions: OpenAI::Models::Beta::beta_computer_action_list?
 
+        # Flattened batched actions for `computer_use`. Each action includes an `type`
+        # discriminator and action-specific fields.
         def actions=: (
           OpenAI::Models::Beta::beta_computer_action_list
         ) -> OpenAI::Models::Beta::beta_computer_action_list
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseComputerToolCall::Agent?
 
+        # @param id
+        #   The unique ID of the computer call.
+        # @param call_id
+        #   An identifier used when responding to the tool call with output.
+        # @param pending_safety_checks
+        #   The pending safety checks for the computer call.
+        # @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 computer call. Always `computer_call`.
+        # @param action
+        #   A click action.
+        # @param actions
+        #   Flattened batched actions for `computer_use`. Each action includes an `type`
+        #   discriminator and action-specific fields.
+        # @param agent
+        #   The agent that produced this item.
         def initialize: (
           id: String,
           call_id: String,
@@ -66,12 +97,21 @@ module OpenAI
           { id: String, ?code: String?, ?message: String? }
 
         class PendingSafetyCheck < 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?,
@@ -106,8 +146,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 }

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

@@ -16,28 +16,59 @@ module OpenAI
         }
 
       class BetaResponseComputerToolCallOutputItem < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the computer call tool output.
         attr_accessor id: String
 
+        # 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::Beta::BetaResponseComputerToolCallOutputScreenshot
 
+        # 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::Beta::BetaResponseComputerToolCallOutputItem::status
 
+        # The type of the computer tool call output. Always `computer_call_output`.
         attr_accessor type: :computer_call_output
 
+        # The safety checks reported by the API that have been acknowledged by the
+        # developer.
         attr_reader acknowledged_safety_checks: ::Array[OpenAI::Beta::BetaResponseComputerToolCallOutputItem::AcknowledgedSafetyCheck]?
 
+        # The safety checks reported by the API that have been acknowledged by the
+        # developer.
         def acknowledged_safety_checks=: (
           ::Array[OpenAI::Beta::BetaResponseComputerToolCallOutputItem::AcknowledgedSafetyCheck]
         ) -> ::Array[OpenAI::Beta::BetaResponseComputerToolCallOutputItem::AcknowledgedSafetyCheck]
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseComputerToolCallOutputItem::Agent?
 
+        # The identifier of the actor that created the item.
         attr_reader created_by: String?
 
+        # The identifier of the actor that created the item.
         def created_by=: (String) -> String
 
+        # @param id
+        #   The unique ID of the computer call tool output.
+        # @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 status
+        #   The status of the message input. One of `in_progress`, `completed`, or
+        #   `incomplete`. Populated when input items are returned via API.
+        # @param acknowledged_safety_checks
+        #   The safety checks reported by the API that have been acknowledged by the
+        #   developer.
+        # @param agent
+        #   The agent that produced this item.
+        # @param created_by
+        #   The identifier of the actor that created the item.
+        # @param type
+        #   The type of the computer tool call output. Always `computer_call_output`.
         def initialize: (
           id: String,
           call_id: String,
@@ -77,12 +108,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?,
@@ -95,8 +135,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 }

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

@@ -7,16 +7,29 @@ module OpenAI
         { ?type: :computer_screenshot, ?file_id: String, ?image_url: String }
 
       class BetaResponseComputerToolCallOutputScreenshot < OpenAI::Internal::Type::BaseModel
+        # Specifies the event type. For a computer screenshot, this property is always set
+        # to `computer_screenshot`.
         attr_accessor type: :computer_screenshot
 
+        # The identifier of an uploaded file that contains the screenshot.
         attr_reader file_id: String?
 
+        # The identifier of an uploaded file that contains the screenshot.
         def file_id=: (String) -> String
 
+        # The URL of the screenshot image.
         attr_reader image_url: String?
 
+        # The URL of the screenshot image.
         def image_url=: (String) -> String
 
+        # @param file_id
+        #   The identifier of an uploaded file that contains the screenshot.
+        # @param image_url
+        #   The URL of the screenshot image.
+        # @param type
+        #   Specifies the event type. For a computer screenshot, this property is always set
+        #   to `computer_screenshot`.
         def initialize: (
           ?file_id: String,
           ?image_url: String,

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

@@ -12,22 +12,36 @@ module OpenAI
         }
 
       class BetaResponseConfigurationUpdateItem < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the configuration update item.
         attr_accessor id: String
 
+        # The item type. Always `configuration_update`.
         attr_accessor type: :configuration_update
 
+        # The agent that produced this item.
         attr_reader agent: OpenAI::Beta::BetaResponseConfigurationUpdateItem::Agent?
 
+        # The agent that produced this item.
         def agent=: (
           OpenAI::Beta::BetaResponseConfigurationUpdateItem::Agent
         ) -> OpenAI::Beta::BetaResponseConfigurationUpdateItem::Agent
 
+        # The reasoning configuration applied by this update.
         attr_reader reasoning: OpenAI::Beta::BetaResponseConfigurationUpdateItem::Reasoning?
 
+        # The reasoning configuration applied by this update.
         def reasoning=: (
           OpenAI::Beta::BetaResponseConfigurationUpdateItem::Reasoning
         ) -> OpenAI::Beta::BetaResponseConfigurationUpdateItem::Reasoning
 
+        # @param id
+        #   The unique ID of the configuration update item.
+        # @param agent
+        #   The agent that produced this item.
+        # @param reasoning
+        #   The reasoning configuration applied by this update.
+        # @param type
+        #   The item type. Always `configuration_update`.
         def initialize: (
           id: String,
           ?agent: OpenAI::Beta::BetaResponseConfigurationUpdateItem::Agent,
@@ -45,8 +59,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 }
@@ -58,8 +75,13 @@ module OpenAI
           }
 
         class Reasoning < OpenAI::Internal::Type::BaseModel
+          # The reasoning effort used for subsequent responses until another configuration
+          # update replaces it.
           attr_accessor effort: OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Reasoning::effort?
 
+          # @param effort
+          #   The reasoning effort used for subsequent responses until another configuration
+          #   update replaces it.
           def initialize: (
             ?effort: OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Reasoning::effort?
           ) -> void

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

@@ -12,18 +12,31 @@ module OpenAI
         }
 
       class BetaResponseConfigurationUpdateItemParam < OpenAI::Internal::Type::BaseModel
+        # The item type. Always `configuration_update`.
         attr_accessor type: :configuration_update
 
+        # The unique ID of the configuration update item.
         attr_accessor id: String?
 
+        # The agent that produced this item.
         attr_accessor agent: OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Agent?
 
+        # Updates to reasoning configuration. Only effort is supported.
         attr_reader reasoning: OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning?
 
+        # Updates to reasoning configuration. Only effort is supported.
         def reasoning=: (
           OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning
         ) -> OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning
 
+        # @param id
+        #   The unique ID of the configuration update item.
+        # @param agent
+        #   The agent that produced this item.
+        # @param reasoning
+        #   Updates to reasoning configuration. Only effort is supported.
+        # @param type
+        #   The item type. Always `configuration_update`.
         def initialize: (
           ?id: String?,
           ?agent: OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Agent?,
@@ -41,8 +54,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 }
@@ -54,8 +70,13 @@ module OpenAI
           }
 
         class Reasoning < OpenAI::Internal::Type::BaseModel
+          # The reasoning effort to use for subsequent responses until another configuration
+          # update replaces it.
           attr_accessor effort: OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::effort?
 
+          # @param effort
+          #   The reasoning effort to use for subsequent responses until another configuration
+          #   update replaces it.
           def initialize: (
             ?effort: OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning::effort?
           ) -> void

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

@@ -9,8 +9,11 @@ module OpenAI
       class BetaResponseContainerReference < OpenAI::Internal::Type::BaseModel
         attr_accessor container_id: String
 
+        # The environment type. Always `container_reference`.
         attr_accessor type: :container_reference
 
+        # @param type
+        #   The environment type. Always `container_reference`.
         def initialize: (
           container_id: String,
           ?type: :container_reference

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

@@ -17,10 +17,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 }