Class: OpenAI::Models::Responses::ResponseReasoningSummaryDoneEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ResponseReasoningSummaryDoneEvent

Defined in:

lib/openai/models/responses/response_reasoning_summary_done_event.rb

Instance Attribute Summary

• #item_id ⇒ String

  The unique identifier of the item for which the reasoning summary is finalized.

• #output_index ⇒ Integer

  The index of the output item in the response’s output array.

• #sequence_number ⇒ Integer

  The sequence number of this event.

• #summary_index ⇒ Integer

  The index of the summary part within the output item.

• #text ⇒ String

  The finalized reasoning summary text.

• #type ⇒ Symbol, :"response.reasoning_summary.done"

  The type of the event.

Instance Method Summary

• #initialize(item_id: , output_index: , sequence_number: , summary_index: , text: , type: :"response.reasoning_summary.done") ⇒ Object constructor

  Emitted when the reasoning summary content is finalized for an item.

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: , sequence_number: , summary_index: , text: , type: :"response.reasoning_summary.done") ⇒ Object

Emitted when the reasoning summary content is finalized for an item.

Parameters:

• item_id (String) (defaults to: ) —

  The unique identifier of the item for which the reasoning summary is finalized.

• output_index (Integer) (defaults to: ) —

  The index of the output item in the response’s output array.

• sequence_number (Integer) (defaults to: ) —

  The sequence number of this event.

• summary_index (Integer) (defaults to: ) —

  The index of the summary part within the output item.

• text (String) (defaults to: ) —

  The finalized reasoning summary text.

• type (Symbol, :"response.reasoning_summary.done") (defaults to: :"response.reasoning_summary.done") —

  The type of the event. Always ‘response.reasoning_summary.done’.

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

Instance Attribute Details

#item_id ⇒ String

The unique identifier of the item for which the reasoning summary is finalized.

Returns:

• (String)

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

required :item_id, String

#output_index ⇒ Integer

The index of the output item in the response’s output array.

Returns:

• (Integer)

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

required :output_index, Integer

#sequence_number ⇒ Integer

The sequence number of this event.

Returns:

• (Integer)

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

required :sequence_number, Integer

#summary_index ⇒ Integer

The index of the summary part within the output item.

Returns:

• (Integer)

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

required :summary_index, Integer

#text ⇒ String

The finalized reasoning summary text.

Returns:

• (String)

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

required :text, String

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

The type of the event. Always ‘response.reasoning_summary.done’.

Returns:

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

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

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