Class: OpenAI::Models::Realtime::OutputAudioBufferClearEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/output_audio_buffer_clear_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(event_id: nil, type: :"output_audio_buffer.clear") ⇒ Object

**WebRTC/SIP Only:** Emit to cut off the current audio response. This will trigger the server to stop generating audio and emit a ‘output_audio_buffer.cleared` event. This event should be preceded by a `response.cancel` client event to stop the generation of the current response. [Learn more](platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).

Parameters:

  • event_id (String) (defaults to: nil) —

    The unique ID of the client event used for error handling.

  • type (Symbol, :"output_audio_buffer.clear") (defaults to: :"output_audio_buffer.clear") —

    The event type, must be ‘output_audio_buffer.clear`.




# File 'lib/openai/models/realtime/output_audio_buffer_clear_event.rb', line 19

Instance Attribute Details

#event_id ⇒ String?

The unique ID of the client event used for error handling.

Returns:

  • (String, nil) 


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

optional :event_id, String

#type ⇒ Symbol, :"output_audio_buffer.clear"

The event type, must be ‘output_audio_buffer.clear`.

Returns:

  • (Symbol, :"output_audio_buffer.clear") 


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

required :type, const: :"output_audio_buffer.clear"