openai 0.91.0 → 0.93.0

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

@@ -14,22 +14,46 @@ module OpenAI
         }
 
       class AgentSessionTurnContentPartAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the message.
         attr_accessor content_index: Integer
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the message item.
         attr_accessor item_id: String
 
+        # The index of the item in the turn output.
         attr_accessor output_index: Integer
 
+        # The initial content part.
         attr_accessor part: OpenAI::Beta::OutputText
 
+        # 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.turn.content_part.added`.
         attr_accessor type: :"agent.session.turn.content_part.added"
 
+        # @param content_index
+        #   The index of the content part in the message.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item_id
+        #   The ID of the message item.
+        # @param output_index
+        #   The index of the item in the turn output.
+        # @param part
+        #   The initial content part.
+        # @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.turn.content_part.added`.
         def initialize: (
           content_index: Integer,
           event_id: String,

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

@@ -14,22 +14,46 @@ module OpenAI
         }
 
       class AgentSessionTurnContentPartDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the message.
         attr_accessor content_index: Integer
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the message item.
         attr_accessor item_id: String
 
+        # The index of the item in the turn output.
         attr_accessor output_index: Integer
 
+        # The completed content part.
         attr_accessor part: OpenAI::Beta::OutputText
 
+        # 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.turn.content_part.done`.
         attr_accessor type: :"agent.session.turn.content_part.done"
 
+        # @param content_index
+        #   The index of the content part in the message.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item_id
+        #   The ID of the message item.
+        # @param output_index
+        #   The index of the item in the turn output.
+        # @param part
+        #   The completed content part.
+        # @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.turn.content_part.done`.
         def initialize: (
           content_index: Integer,
           event_id: String,

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

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class AgentSessionTurnCreatedEvent < 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 turn at the time it was created.
         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.created`.
         attr_accessor type: :"agent.session.turn.created"
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn
+        #   The turn at the time it was created.
+        # @param turn_id
+        #   The ID of the turn associated with the event.
+        # @param type
+        #   The type of the object. Always `agent.session.turn.created`.
         def initialize: (
           event_id: String,
           session_id: String,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class AgentSessionTurnFailedEvent < 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 failed 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.failed`.
         attr_accessor type: :"agent.session.turn.failed"
 
+        # 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 failed 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.failed`.
         def initialize: (
           event_id: String,
           session_id: String,

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

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class AgentSessionTurnInProgressEvent < 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 turn at the time it started running.
         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.in_progress`.
         attr_accessor type: :"agent.session.turn.in_progress"
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param turn
+        #   The turn at the time it started running.
+        # @param turn_id
+        #   The ID of the turn associated with the event.
+        # @param type
+        #   The type of the object. Always `agent.session.turn.in_progress`.
         def initialize: (
           event_id: String,
           session_id: String,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class AgentSessionTurnItemAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The item that was added.
         attr_accessor item: OpenAI::Models::Beta::agent_session_item
 
+        # The index of the item in the turn output, when the item is agent 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.session.turn.item.added`.
         attr_accessor type: :"agent.session.turn.item.added"
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item
+        #   The item that was added.
+        # @param output_index
+        #   The index of the item in the turn output, when the item is agent 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.session.turn.item.added`.
         def initialize: (
           event_id: String,
           item: OpenAI::Models::Beta::agent_session_item,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class AgentSessionTurnItemDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The completed output item.
         attr_accessor item: OpenAI::Models::Beta::agent_output_item
 
+        # The index of the output 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.session.turn.item.done`.
         attr_accessor type: :"agent.session.turn.item.done"
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item
+        #   The completed output item.
+        # @param output_index
+        #   The index of the output 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.session.turn.item.done`.
         def initialize: (
           event_id: String,
           item: OpenAI::Models::Beta::agent_output_item,

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

@@ -14,22 +14,46 @@ module OpenAI
         }
 
       class AgentSessionTurnOutputTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the message.
         attr_accessor content_index: Integer
 
+        # The text that was appended.
         attr_accessor delta: String
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the message 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.session.turn.output_text.delta`.
         attr_accessor type: :"agent.session.turn.output_text.delta"
 
+        # @param content_index
+        #   The index of the content part in the message.
+        # @param delta
+        #   The text that was appended.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item_id
+        #   The ID of the message 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.session.turn.output_text.delta`.
         def initialize: (
           content_index: Integer,
           delta: String,

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

@@ -14,22 +14,46 @@ module OpenAI
         }
 
       class AgentSessionTurnOutputTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the message.
         attr_accessor content_index: Integer
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the message 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 complete output text.
         attr_accessor text: 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.turn.output_text.done`.
         attr_accessor type: :"agent.session.turn.output_text.done"
 
+        # @param content_index
+        #   The index of the content part in the message.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item_id
+        #   The ID of the message 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 text
+        #   The complete output text.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param type
+        #   The type of the object. Always `agent.session.turn.output_text.done`.
         def initialize: (
           content_index: Integer,
           event_id: String,

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

@@ -14,22 +14,48 @@ module OpenAI
         }
 
       class AgentSessionTurnReasoningSummaryPartAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the reasoning item.
         attr_accessor item_id: String
 
+        # The index of the item in the turn output.
         attr_accessor output_index: Integer
 
+        # The initial summary part.
         attr_accessor part: OpenAI::Beta::SummaryText
 
+        # The ID of the session associated with the event.
         attr_accessor session_id: String
 
+        # The index of the summary content part.
         attr_accessor summary_index: Integer
 
+        # The ID of the turn associated with the event, when applicable.
         attr_accessor turn_id: String?
 
+        # The type of the object. Always
+        # `agent.session.turn.reasoning_summary_part.added`.
         attr_accessor type: :"agent.session.turn.reasoning_summary_part.added"
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item_id
+        #   The ID of the reasoning item.
+        # @param output_index
+        #   The index of the item in the turn output.
+        # @param part
+        #   The initial summary part.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param summary_index
+        #   The index of the summary content part.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param type
+        #   The type of the object. Always
+        #   `agent.session.turn.reasoning_summary_part.added`.
         def initialize: (
           event_id: String,
           item_id: String,

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

@@ -15,26 +15,54 @@ module OpenAI
         }
 
       class AgentSessionTurnReasoningSummaryPartDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the reasoning item.
         attr_accessor item_id: String
 
+        # The index of the item in the turn output.
         attr_accessor output_index: Integer
 
+        # The completed summary part.
         attr_accessor part: OpenAI::Beta::SummaryText
 
+        # The ID of the session associated with the event.
         attr_accessor session_id: String
 
+        # Present as `incomplete` when summary generation was interrupted.
         attr_reader status: :incomplete
 
+        # Present as `incomplete` when summary generation was interrupted.
         def status=: (:incomplete?) -> :incomplete?
 
+        # The index of the summary part.
         attr_accessor summary_index: Integer
 
+        # The ID of the turn associated with the event, when applicable.
         attr_accessor turn_id: String?
 
+        # The type of the object. Always `agent.session.turn.reasoning_summary_part.done`.
         attr_accessor type: :"agent.session.turn.reasoning_summary_part.done"
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item_id
+        #   The ID of the reasoning item.
+        # @param output_index
+        #   The index of the item in the turn output.
+        # @param part
+        #   The completed summary part.
+        # @param session_id
+        #   The ID of the session associated with the event.
+        # @param summary_index
+        #   The index of the summary part.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param status
+        #   Present as `incomplete` when summary generation was interrupted.
+        # @param type
+        #   The type of the object. Always `agent.session.turn.reasoning_summary_part.done`.
         def initialize: (
           event_id: String,
           item_id: String,

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

@@ -14,22 +14,48 @@ module OpenAI
         }
 
       class AgentSessionTurnReasoningSummaryTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The summary text that was appended.
         attr_accessor delta: String
 
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the reasoning 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 index of the summary content part.
         attr_accessor summary_index: Integer
 
+        # The ID of the turn associated with the event, when applicable.
         attr_accessor turn_id: String?
 
+        # The type of the object. Always
+        # `agent.session.turn.reasoning_summary_text.delta`.
         attr_accessor type: :"agent.session.turn.reasoning_summary_text.delta"
 
+        # @param delta
+        #   The summary text that was appended.
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item_id
+        #   The ID of the reasoning 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 summary_index
+        #   The index of the summary content part.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param type
+        #   The type of the object. Always
+        #   `agent.session.turn.reasoning_summary_text.delta`.
         def initialize: (
           delta: String,
           event_id: String,

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

@@ -14,22 +14,46 @@ module OpenAI
         }
 
       class AgentSessionTurnReasoningSummaryTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the event.
         attr_accessor event_id: String
 
+        # The ID of the reasoning 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 index of the summary content part.
         attr_accessor summary_index: Integer
 
+        # The complete reasoning summary text.
         attr_accessor text: 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.turn.reasoning_summary_text.done`.
         attr_accessor type: :"agent.session.turn.reasoning_summary_text.done"
 
+        # @param event_id
+        #   The unique ID of the event.
+        # @param item_id
+        #   The ID of the reasoning 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 summary_index
+        #   The index of the summary content part.
+        # @param text
+        #   The complete reasoning summary text.
+        # @param turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        # @param type
+        #   The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
         def initialize: (
           event_id: String,
           item_id: String,

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

@@ -8,10 +8,16 @@ module OpenAI
         }
 
       class AgentText < OpenAI::Internal::Type::BaseModel
+        # The effective output format. Defaults to ordinary text.
         attr_accessor format_: OpenAI::Models::Beta::text_format
 
+        # The amount of text produced by the agent. Defaults to `medium`.
         attr_accessor verbosity: OpenAI::Models::Beta::AgentText::verbosity
 
+        # @param format_
+        #   The effective output format. Defaults to ordinary text.
+        # @param verbosity
+        #   The amount of text produced by the agent. Defaults to `medium`.
         def initialize: (
           format_: OpenAI::Models::Beta::text_format,
           verbosity: OpenAI::Models::Beta::AgentText::verbosity

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

@@ -8,10 +8,18 @@ module OpenAI
         }
 
       class AgentTextParam < OpenAI::Internal::Type::BaseModel
+        # The output format. Omission uses ordinary text (`{"type": "text"}`).
         attr_accessor format_: OpenAI::Models::Beta::text_format_param?
 
+        # The amount of text the model should produce. Defaults to `medium`, matching
+        # Responses.
         attr_accessor verbosity: OpenAI::Models::Beta::AgentTextParam::verbosity?
 
+        # @param format_
+        #   The output format. Omission uses ordinary text (`{"type": "text"}`).
+        # @param verbosity
+        #   The amount of text the model should produce. Defaults to `medium`, matching
+        #   Responses.
         def initialize: (
           ?format_: OpenAI::Models::Beta::text_format_param?,
           ?verbosity: OpenAI::Models::Beta::AgentTextParam::verbosity?