Class: OpenAI::Models::Realtime::InputAudioBufferCommittedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/input_audio_buffer_committed_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: , item_id: , previous_item_id: nil, type: :"input_audio_buffer.committed") ⇒ Object

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

Returned when an input audio buffer is committed, either by the client or automatically in server VAD mode. The ‘item_id` property is the ID of the user message item that will be created, thus a `conversation.item.created` event will also be sent to the client.

Parameters:

  • event_id (String) (defaults to: ) —

    The unique ID of the server event.

  • item_id (String) (defaults to: ) —

    The ID of the user message item that will be created.

  • previous_item_id (String, nil) (defaults to: nil) —

    The ID of the preceding item after which the new item will be inserted.

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

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




# File 'lib/openai/models/realtime/input_audio_buffer_committed_event.rb', line 32

Instance Attribute Details

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


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

required :event_id, String

#item_id ⇒ String

The ID of the user message item that will be created.

Returns:

  • (String) 


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

required :item_id, String

#previous_item_id ⇒ String?

The ID of the preceding item after which the new item will be inserted. Can be ‘null` if the item has no predecessor.

Returns:

  • (String, nil) 


30
 
# File 'lib/openai/models/realtime/input_audio_buffer_committed_event.rb', line 30

optional :previous_item_id, String, nil?: true

#type ⇒ Symbol, :"input_audio_buffer.committed"

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

Returns:

  • (Symbol, :"input_audio_buffer.committed") 


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

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