Class: OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_reasoning_summary_part_added_event.rb

Defined Under Namespace

Classes: 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, 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(item_id: , output_index: , part: , sequence_number: , summary_index: , type: :"response.reasoning_summary_part.added") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent for more details.

Emitted when a new reasoning summary part is added.

Parameters:

  • item_id (String) (defaults to: ) —

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

  • output_index (Integer) (defaults to: ) —

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

  • part (OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent::Part) (defaults to: ) —

    The summary part that was added.

  • sequence_number (Integer) (defaults to: ) —

    The sequence number of this event.

  • summary_index (Integer) (defaults to: ) —

    The index of the summary part within the reasoning summary.

  • type (Symbol, :"response.reasoning_summary_part.added") (defaults to: :"response.reasoning_summary_part.added") —

    The type of the event. Always ‘response.reasoning_summary_part.added`.




# File 'lib/openai/models/responses/response_reasoning_summary_part_added_event.rb', line 43

Instance Attribute Details

#item_id ⇒ String

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

Returns:

  • (String) 


11
 
# File 'lib/openai/models/responses/response_reasoning_summary_part_added_event.rb', line 11

required :item_id, String

#output_index ⇒ Integer

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

Returns:

  • (Integer) 


17
 
# File 'lib/openai/models/responses/response_reasoning_summary_part_added_event.rb', line 17

required :output_index, Integer

#part ⇒ OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent::Part

The summary part that was added.

Returns:



23
 
# File 'lib/openai/models/responses/response_reasoning_summary_part_added_event.rb', line 23

required :part, -> { OpenAI::Responses::ResponseReasoningSummaryPartAddedEvent::Part }

#sequence_number ⇒ Integer

The sequence number of this event.

Returns:

  • (Integer) 


29
 
# File 'lib/openai/models/responses/response_reasoning_summary_part_added_event.rb', line 29

required :sequence_number, Integer

#summary_index ⇒ Integer

The index of the summary part within the reasoning summary.

Returns:

  • (Integer) 


35
 
# File 'lib/openai/models/responses/response_reasoning_summary_part_added_event.rb', line 35

required :summary_index, Integer

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

The type of the event. Always ‘response.reasoning_summary_part.added`.

Returns:

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


41
 
# File 'lib/openai/models/responses/response_reasoning_summary_part_added_event.rb', line 41

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