Class: OpenAI::Models::Realtime::InputAudioBufferClearEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Realtime::InputAudioBufferClearEvent

Defined in:

lib/openai/models/realtime/input_audio_buffer_clear_event.rb

Instance Attribute Summary

• #event_id ⇒ String^?

  Optional client-generated ID used to identify this event.

• #type ⇒ Symbol, :"input_audio_buffer.clear"

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

Instance Method Summary

• #initialize(event_id: nil, type: :"input_audio_buffer.clear") ⇒ Object constructor

  Send this event to clear the audio bytes in the buffer.

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: :"input_audio_buffer.clear") ⇒ Object

Send this event to clear the audio bytes in the buffer. The server will respond with an ‘input_audio_buffer.cleared` event.

Parameters:

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

  Optional client-generated ID used to identify this event.

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

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

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

Instance Attribute Details

#event_id ⇒ String^?

Optional client-generated ID used to identify this event.

Returns:

• (String, nil)

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

optional :event_id, String

#type ⇒ Symbol, :"input_audio_buffer.clear"

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

Returns:

• (Symbol, :"input_audio_buffer.clear")

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

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