Class: OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb,
sig/openai/models/beta/beta_response_reasoning_summary_part_done_event.rbs

Defined Under Namespace

Modules: Status Classes: Agent, Part

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(agent_name:) ⇒ Object

The agent that owns this multi-agent streaming event.

Parameters:

  • agent_name (String) —

    The canonical name of the agent that produced this item.




# File 'lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb', line 56

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Agent?

The agent that owns this multi-agent streaming event.

Parameters:

  • value (OpenAI::Beta::BetaResponseReasoningSummaryPartDoneEvent::Agent, nil)

Returns:



47
 
# File 'lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb', line 47

optional :agent, -> { OpenAI::Beta::BetaResponseReasoningSummaryPartDoneEvent::Agent }, nil?: true

#item_id ⇒ String

The ID of the item this summary part is associated with.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb', line 11

required :item_id, String

#output_index ⇒ Integer

The index of the output item this summary part is associated with.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


17
 
# File 'lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb', line 17

required :output_index, Integer

#part ⇒ OpenAI::Models::Beta::BetaResponseReasoningSummaryPartDoneEvent::Part

The completed summary part.

Parameters:

  • value (OpenAI::Beta::BetaResponseReasoningSummaryPartDoneEvent::Part)

Returns:



23
 
# File 'lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb', line 23

required :part, -> { OpenAI::Beta::BetaResponseReasoningSummaryPartDoneEvent::Part }

#sequence_number ⇒ Integer

The sequence number of this event.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


29
 
# File 'lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb', line 29

required :sequence_number, Integer

#status ⇒ Symbol, ...

The completion status of the summary part. Omitted when the part completed normally and set to incomplete when generation was interrupted.

Returns:



54
 
# File 'lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb', line 54

optional :status, enum: -> { OpenAI::Beta::BetaResponseReasoningSummaryPartDoneEvent::Status }

#summary_index ⇒ Integer

The index of the summary part within the reasoning summary.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


35
 
# File 'lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb', line 35

required :summary_index, Integer

#type ⇒ Symbol, :"response.reasoning_summary_part.done"

The type of the event. Always response.reasoning_summary_part.done.

Parameters:

  • value (:"response.reasoning_summary_part.done")

Returns:

  • (Symbol, :"response.reasoning_summary_part.done") 


41
 
# File 'lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb', line 41

required :type, const: :"response.reasoning_summary_part.done"

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/openai/models/beta/beta_response_reasoning_summary_part_done_event.rbs', line 50

def to_hash: -> {