openai 0.92.0 → 0.94.0

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

@@ -15,20 +15,41 @@ module OpenAI
         }
 
       class BetaResponseReasoningSummaryPartAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the item this summary part is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this summary part is associated with.
         attr_accessor output_index: Integer
 
+        # The summary part that was added.
         attr_accessor part: OpenAI::Beta::BetaResponseReasoningSummaryPartAddedEvent::Part
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The index of the summary part within the reasoning summary.
         attr_accessor summary_index: Integer
 
+        # The type of the event. Always `response.reasoning_summary_part.added`.
         attr_accessor type: :"response.reasoning_summary_part.added"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseReasoningSummaryPartAddedEvent::Agent?
 
+        # @param item_id
+        #   The ID of the item this summary part is associated with.
+        # @param output_index
+        #   The index of the output item this summary part is associated with.
+        # @param part
+        #   The summary part that was added.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param summary_index
+        #   The index of the summary part within the reasoning summary.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.reasoning_summary_part.added`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -52,10 +73,16 @@ module OpenAI
         type part = { text: String, ?type: :summary_text }
 
         class Part < OpenAI::Internal::Type::BaseModel
+          # The text of the summary part.
           attr_accessor text: String
 
+          # The type of the summary part. Always `summary_text`.
           attr_accessor type: :summary_text
 
+          # @param text
+          #   The text of the summary part.
+          # @param type
+          #   The type of the summary part. Always `summary_text`.
           def initialize: (text: String, ?type: :summary_text) -> void
 
           def to_hash: -> { text: String, ?type: :summary_text }
@@ -64,8 +91,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_reasoning_summary_part_done_event.rbs

@@ -16,26 +16,54 @@ module OpenAI
         }
 
       class BetaResponseReasoningSummaryPartDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the item this summary part is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this summary part is associated with.
         attr_accessor output_index: Integer
 
+        # The completed summary part.
         attr_accessor part: OpenAI::Beta::BetaResponseReasoningSummaryPartDoneEvent::Part
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The index of the summary part within the reasoning summary.
         attr_accessor summary_index: Integer
 
+        # The type of the event. Always `response.reasoning_summary_part.done`.
         attr_accessor type: :"response.reasoning_summary_part.done"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseReasoningSummaryPartDoneEvent::Agent?
 
+        # The completion status of the summary part. Omitted when the part completed
+        # normally and set to `incomplete` when generation was interrupted.
         attr_reader status: OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::status?
 
+        # The completion status of the summary part. Omitted when the part completed
+        # normally and set to `incomplete` when generation was interrupted.
         def status=: (
           OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::status
         ) -> OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::status
 
+        # @param item_id
+        #   The ID of the item this summary part is associated with.
+        # @param output_index
+        #   The index of the output item this summary part is associated with.
+        # @param part
+        #   The completed summary part.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param summary_index
+        #   The index of the summary part within the reasoning summary.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param status
+        #   The completion status of the summary part. Omitted when the part completed
+        #   normally and set to `incomplete` when generation was interrupted.
+        # @param type
+        #   The type of the event. Always `response.reasoning_summary_part.done`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -61,10 +89,16 @@ module OpenAI
         type part = { text: String, ?type: :summary_text }
 
         class Part < OpenAI::Internal::Type::BaseModel
+          # The text of the summary part.
           attr_accessor text: String
 
+          # The type of the summary part. Always `summary_text`.
           attr_accessor type: :summary_text
 
+          # @param text
+          #   The text of the summary part.
+          # @param type
+          #   The type of the summary part. Always `summary_text`.
           def initialize: (text: String, ?type: :summary_text) -> void
 
           def to_hash: -> { text: String, ?type: :summary_text }
@@ -73,8 +107,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_reasoning_summary_text_delta_event.rbs

@@ -15,20 +15,41 @@ module OpenAI
         }
 
       class BetaResponseReasoningSummaryTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The text delta that was added to the summary.
         attr_accessor delta: String
 
+        # The ID of the item this summary text delta is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this summary text delta is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The index of the summary part within the reasoning summary.
         attr_accessor summary_index: Integer
 
+        # The type of the event. Always `response.reasoning_summary_text.delta`.
         attr_accessor type: :"response.reasoning_summary_text.delta"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseReasoningSummaryTextDeltaEvent::Agent?
 
+        # @param delta
+        #   The text delta that was added to the summary.
+        # @param item_id
+        #   The ID of the item this summary text delta is associated with.
+        # @param output_index
+        #   The index of the output item this summary text delta is associated with.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param summary_index
+        #   The index of the summary part within the reasoning summary.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.reasoning_summary_text.delta`.
         def initialize: (
           delta: String,
           item_id: String,
@@ -52,8 +73,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_reasoning_summary_text_done_event.rbs

@@ -15,20 +15,41 @@ module OpenAI
         }
 
       class BetaResponseReasoningSummaryTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the item this summary text is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this summary text is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The index of the summary part within the reasoning summary.
         attr_accessor summary_index: Integer
 
+        # The full text of the completed reasoning summary.
         attr_accessor text: String
 
+        # The type of the event. Always `response.reasoning_summary_text.done`.
         attr_accessor type: :"response.reasoning_summary_text.done"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseReasoningSummaryTextDoneEvent::Agent?
 
+        # @param item_id
+        #   The ID of the item this summary text is associated with.
+        # @param output_index
+        #   The index of the output item this summary text is associated with.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param summary_index
+        #   The index of the summary part within the reasoning summary.
+        # @param text
+        #   The full text of the completed reasoning summary.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.reasoning_summary_text.done`.
         def initialize: (
           item_id: String,
           output_index: Integer,
@@ -52,8 +73,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_reasoning_text_delta_event.rbs

@@ -15,20 +15,41 @@ module OpenAI
         }
 
       class BetaResponseReasoningTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the reasoning content part this delta is associated with.
         attr_accessor content_index: Integer
 
+        # The text delta that was added to the reasoning content.
         attr_accessor delta: String
 
+        # The ID of the item this reasoning text delta is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this reasoning text delta is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.reasoning_text.delta`.
         attr_accessor type: :"response.reasoning_text.delta"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseReasoningTextDeltaEvent::Agent?
 
+        # @param content_index
+        #   The index of the reasoning content part this delta is associated with.
+        # @param delta
+        #   The text delta that was added to the reasoning content.
+        # @param item_id
+        #   The ID of the item this reasoning text delta is associated with.
+        # @param output_index
+        #   The index of the output item this reasoning text delta is associated with.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.reasoning_text.delta`.
         def initialize: (
           content_index: Integer,
           delta: String,
@@ -52,8 +73,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_reasoning_text_done_event.rbs

@@ -15,20 +15,41 @@ module OpenAI
         }
 
       class BetaResponseReasoningTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the reasoning content part.
         attr_accessor content_index: Integer
 
+        # The ID of the item this reasoning text is associated with.
         attr_accessor item_id: String
 
+        # The index of the output item this reasoning text is associated with.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The full text of the completed reasoning content.
         attr_accessor text: String
 
+        # The type of the event. Always `response.reasoning_text.done`.
         attr_accessor type: :"response.reasoning_text.done"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseReasoningTextDoneEvent::Agent?
 
+        # @param content_index
+        #   The index of the reasoning content part.
+        # @param item_id
+        #   The ID of the item this reasoning text is associated with.
+        # @param output_index
+        #   The index of the output item this reasoning text is associated with.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param text
+        #   The full text of the completed reasoning content.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.reasoning_text.done`.
         def initialize: (
           content_index: Integer,
           item_id: String,
@@ -52,8 +73,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_refusal_delta_event.rbs

@@ -15,20 +15,41 @@ module OpenAI
         }
 
       class BetaResponseRefusalDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part that the refusal text is added to.
         attr_accessor content_index: Integer
 
+        # The refusal text that is added.
         attr_accessor delta: String
 
+        # The ID of the output item that the refusal text is added to.
         attr_accessor item_id: String
 
+        # The index of the output item that the refusal text is added to.
         attr_accessor output_index: Integer
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.refusal.delta`.
         attr_accessor type: :"response.refusal.delta"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseRefusalDeltaEvent::Agent?
 
+        # @param content_index
+        #   The index of the content part that the refusal text is added to.
+        # @param delta
+        #   The refusal text that is added.
+        # @param item_id
+        #   The ID of the output item that the refusal text is added to.
+        # @param output_index
+        #   The index of the output item that the refusal text is added to.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.refusal.delta`.
         def initialize: (
           content_index: Integer,
           delta: String,
@@ -52,8 +73,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_refusal_done_event.rbs

@@ -15,20 +15,41 @@ module OpenAI
         }
 
       class BetaResponseRefusalDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part that the refusal text is finalized.
         attr_accessor content_index: Integer
 
+        # The ID of the output item that the refusal text is finalized.
         attr_accessor item_id: String
 
+        # The index of the output item that the refusal text is finalized.
         attr_accessor output_index: Integer
 
+        # The refusal text that is finalized.
         attr_accessor refusal: String
 
+        # The sequence number of this event.
         attr_accessor sequence_number: Integer
 
+        # The type of the event. Always `response.refusal.done`.
         attr_accessor type: :"response.refusal.done"
 
+        # The agent that owns this multi-agent streaming event.
         attr_accessor agent: OpenAI::Beta::BetaResponseRefusalDoneEvent::Agent?
 
+        # @param content_index
+        #   The index of the content part that the refusal text is finalized.
+        # @param item_id
+        #   The ID of the output item that the refusal text is finalized.
+        # @param output_index
+        #   The index of the output item that the refusal text is finalized.
+        # @param refusal
+        #   The refusal text that is finalized.
+        # @param sequence_number
+        #   The sequence number of this event.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param type
+        #   The type of the event. Always `response.refusal.done`.
         def initialize: (
           content_index: Integer,
           item_id: String,
@@ -52,8 +73,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_shell_call_command_added_event.rbs

@@ -14,22 +14,41 @@ module OpenAI
         }
 
       class BetaResponseShellCallCommandAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The shell command that was added.
         attr_accessor command: String
 
+        # The index of the shell command that was added.
         attr_accessor command_index: Integer
 
+        # The index of the output item that was updated.
         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.shell_call_command.added`.
         attr_accessor type: :"response.shell_call_command.added"
 
+        # The agent that owns this multi-agent streaming event.
         attr_reader agent: OpenAI::Beta::BetaResponseShellCallCommandAddedEvent::Agent?
 
+        # The agent that owns this multi-agent streaming event.
         def agent=: (
           OpenAI::Beta::BetaResponseShellCallCommandAddedEvent::Agent
         ) -> OpenAI::Beta::BetaResponseShellCallCommandAddedEvent::Agent
 
+        # @param command
+        #   The shell command that was added.
+        # @param command_index
+        #   The index of the shell command that was added.
+        # @param output_index
+        #   The index of the output item that was updated.
+        # @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.shell_call_command.added`.
         def initialize: (
           command: String,
           command_index: Integer,
@@ -51,8 +70,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_shell_call_command_delta_event.rbs

@@ -15,26 +15,49 @@ module OpenAI
         }
 
       class BetaResponseShellCallCommandDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the shell command that was updated.
         attr_accessor command_index: Integer
 
+        # The shell command delta that was appended.
         attr_accessor delta: String
 
+        # The index of the output item that was updated.
         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.shell_call_command.delta`.
         attr_accessor type: :"response.shell_call_command.delta"
 
+        # The agent that owns this multi-agent streaming event.
         attr_reader agent: OpenAI::Beta::BetaResponseShellCallCommandDeltaEvent::Agent?
 
+        # The agent that owns this multi-agent streaming event.
         def agent=: (
           OpenAI::Beta::BetaResponseShellCallCommandDeltaEvent::Agent
         ) -> OpenAI::Beta::BetaResponseShellCallCommandDeltaEvent::Agent
 
+        # An obfuscation string that was added to pad the event payload.
         attr_reader obfuscation: String?
 
+        # An obfuscation string that was added to pad the event payload.
         def obfuscation=: (String) -> String
 
+        # @param command_index
+        #   The index of the shell command that was updated.
+        # @param delta
+        #   The shell command delta that was appended.
+        # @param output_index
+        #   The index of the output item that was updated.
+        # @param sequence_number
+        #   The sequence number of the event that was emitted.
+        # @param agent
+        #   The agent that owns this multi-agent streaming event.
+        # @param obfuscation
+        #   An obfuscation string that was added to pad the event payload.
+        # @param type
+        #   The type of the event, always `response.shell_call_command.delta`.
         def initialize: (
           command_index: Integer,
           delta: String,
@@ -58,8 +81,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_shell_call_command_done_event.rbs

@@ -14,22 +14,41 @@ module OpenAI
         }
 
       class BetaResponseShellCallCommandDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The final shell command that was emitted.
         attr_accessor command: String
 
+        # The index of the shell command that was completed.
         attr_accessor command_index: Integer
 
+        # The index of the output item that was updated.
         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.shell_call_command.done`.
         attr_accessor type: :"response.shell_call_command.done"
 
+        # The agent that owns this multi-agent streaming event.
         attr_reader agent: OpenAI::Beta::BetaResponseShellCallCommandDoneEvent::Agent?
 
+        # The agent that owns this multi-agent streaming event.
         def agent=: (
           OpenAI::Beta::BetaResponseShellCallCommandDoneEvent::Agent
         ) -> OpenAI::Beta::BetaResponseShellCallCommandDoneEvent::Agent
 
+        # @param command
+        #   The final shell command that was emitted.
+        # @param command_index
+        #   The index of the shell command that was completed.
+        # @param output_index
+        #   The index of the output item that was updated.
+        # @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.shell_call_command.done`.
         def initialize: (
           command: String,
           command_index: Integer,
@@ -51,8 +70,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 }