Class: OpenAI::Models::Realtime::ResponseAudioDoneEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/response_audio_done_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, 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(content_index:, event_id:, item_id:, output_index:, response_id:, type: :"response.output_audio.done") ⇒ Object

Returned when the model-generated audio is done. Also emitted when a Response is interrupted, incomplete, or cancelled.

Parameters:

  • content_index (Integer) —

    The index of the content part in the item’s content array.

  • event_id (String) —

    The unique ID of the server event.

  • item_id (String) —

    The ID of the item.

  • output_index (Integer) —

    The index of the output item in the response.

  • response_id (String) —

    The ID of the response.

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

    The event type, must be ‘response.output_audio.done`.




# File 'lib/openai/models/realtime/response_audio_done_event.rb', line 43

Instance Attribute Details

#content_index ⇒ Integer

The index of the content part in the item’s content array.

Returns:

  • (Integer) 


11
 
# File 'lib/openai/models/realtime/response_audio_done_event.rb', line 11

required :content_index, Integer

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


17
 
# File 'lib/openai/models/realtime/response_audio_done_event.rb', line 17

required :event_id, String

#item_id ⇒ String

The ID of the item.

Returns:

  • (String) 


23
 
# File 'lib/openai/models/realtime/response_audio_done_event.rb', line 23

required :item_id, String

#output_index ⇒ Integer

The index of the output item in the response.

Returns:

  • (Integer) 


29
 
# File 'lib/openai/models/realtime/response_audio_done_event.rb', line 29

required :output_index, Integer

#response_id ⇒ String

The ID of the response.

Returns:

  • (String) 


35
 
# File 'lib/openai/models/realtime/response_audio_done_event.rb', line 35

required :response_id, String

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

The event type, must be ‘response.output_audio.done`.

Returns:

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


41
 
# File 'lib/openai/models/realtime/response_audio_done_event.rb', line 41

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