Class: OpenAI::Models::Responses::ResponseRefusalDeltaEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_refusal_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, 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(content_index: , delta: , item_id: , output_index: , sequence_number: , type: :"response.refusal.delta") ⇒ void

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

Emitted when there is a partial refusal text.




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

Instance Attribute Details

#content_index ⇒ Integer

The index of the content part that the refusal text is added to.



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

required :content_index, Integer

#delta ⇒ String

The refusal text that is added.



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

required :delta, String

#item_id ⇒ String

The ID of the output item that the refusal text is added to.



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

required :item_id, String

#output_index ⇒ Integer

The index of the output item that the refusal text is added to.



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

required :output_index, Integer

#sequence_number ⇒ Integer

The sequence number of this event.



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

required :sequence_number, Integer

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

The type of the event. Always response.refusal.delta.



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

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