Class: OpenAI::Models::Responses::ResponseReasoningSummaryDeltaEvent

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

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(delta: , item_id: , output_index: , sequence_number: , summary_index: , type: :"response.reasoning_summary.delta") ⇒ Object

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

Emitted when there is a delta (partial update) to the reasoning summary content.

Parameters:

  • delta (Object) (defaults to: ) —

    The partial update to the reasoning summary content.

  • item_id (String) (defaults to: ) —

    The unique identifier of the item for which the reasoning summary is being updat

  • 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.

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

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




# File 'lib/openai/models/responses/response_reasoning_summary_delta_event.rb', line 44

Instance Attribute Details

#delta ⇒ Object

The partial update to the reasoning summary content.

Returns:

  • (Object) 


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

required :delta, OpenAI::Internal::Type::Unknown

#item_id ⇒ String

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

Returns:

  • (String) 


18
 
# File 'lib/openai/models/responses/response_reasoning_summary_delta_event.rb', line 18

required :item_id, String

#output_index ⇒ Integer

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

Returns:

  • (Integer) 


24
 
# File 'lib/openai/models/responses/response_reasoning_summary_delta_event.rb', line 24

required :output_index, Integer

#sequence_number ⇒ Integer

The sequence number of this event.

Returns:

  • (Integer) 


30
 
# File 'lib/openai/models/responses/response_reasoning_summary_delta_event.rb', line 30

required :sequence_number, Integer

#summary_index ⇒ Integer

The index of the summary part within the output item.

Returns:

  • (Integer) 


36
 
# File 'lib/openai/models/responses/response_reasoning_summary_delta_event.rb', line 36

required :summary_index, Integer

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

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

Returns:

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


42
 
# File 'lib/openai/models/responses/response_reasoning_summary_delta_event.rb', line 42

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