Class: OpenAI::Models::Realtime::InputAudioBufferTimeoutTriggered

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/input_audio_buffer_timeout_triggered.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(audio_end_ms:, audio_start_ms:, event_id:, item_id:, type: :"input_audio_buffer.timeout_triggered") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Realtime::InputAudioBufferTimeoutTriggered for more details.

Returned when the Server VAD timeout is triggered for the input audio buffer. This is configured with ‘idle_timeout_ms` in the `turn_detection` settings of the session, and it indicates that there hasn’t been any speech detected for the configured duration.

The ‘audio_start_ms` and `audio_end_ms` fields indicate the segment of audio after the last model response up to the triggering time, as an offset from the beginning of audio written to the input audio buffer. This means it demarcates the segment of audio that was silent and the difference between the start and end values will roughly match the configured timeout.

The empty audio will be committed to the conversation as an ‘input_audio` item (there will be a `input_audio_buffer.committed` event) and a model response will be generated. There may be speech that didn’t trigger VAD but is still detected by the model, so the model may respond with something relevant to the conversation or a prompt to continue speaking.

Parameters:

  • audio_end_ms (Integer) —

    Millisecond offset of audio written to the input audio buffer at the time the ti

  • audio_start_ms (Integer) —

    Millisecond offset of audio written to the input audio buffer that was after the

  • event_id (String) —

    The unique ID of the server event.

  • item_id (String) —

    The ID of the item associated with this segment.

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

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




# File 'lib/openai/models/realtime/input_audio_buffer_timeout_triggered.rb', line 39

Instance Attribute Details

#audio_end_ms ⇒ Integer

Millisecond offset of audio written to the input audio buffer at the time the timeout was triggered.

Returns:

  • (Integer) 


12
 
# File 'lib/openai/models/realtime/input_audio_buffer_timeout_triggered.rb', line 12

required :audio_end_ms, Integer

#audio_start_ms ⇒ Integer

Millisecond offset of audio written to the input audio buffer that was after the playback time of the last model response.

Returns:

  • (Integer) 


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

required :audio_start_ms, Integer

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


25
 
# File 'lib/openai/models/realtime/input_audio_buffer_timeout_triggered.rb', line 25

required :event_id, String

#item_id ⇒ String

The ID of the item associated with this segment.

Returns:

  • (String) 


31
 
# File 'lib/openai/models/realtime/input_audio_buffer_timeout_triggered.rb', line 31

required :item_id, String

#type ⇒ Symbol, :"input_audio_buffer.timeout_triggered"

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

Returns:

  • (Symbol, :"input_audio_buffer.timeout_triggered") 


37
 
# File 'lib/openai/models/realtime/input_audio_buffer_timeout_triggered.rb', line 37

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