Class: OpenAI::Models::Beta::BetaResponseAudioDoneEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_response_audio_done_event.rb,
sig/openai/models/beta/beta_response_audio_done_event.rbs

Defined Under Namespace

Classes: Agent

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(sequence_number:, agent: nil, type: :"response.audio.done") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::BetaResponseAudioDoneEvent for more details.

Emitted when the audio response is complete.

Parameters:

  • sequence_number (Integer) —

    The sequence number of the delta.

  • agent (OpenAI::Models::Beta::BetaResponseAudioDoneEvent::Agent, nil) (defaults to: nil) —

    The agent that owns this multi-agent streaming event.

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

    The type of the event. Always response.audio.done.




# File 'lib/openai/models/beta/beta_response_audio_done_event.rb', line 25

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseAudioDoneEvent::Agent?

The agent that owns this multi-agent streaming event.

Parameters:

  • value (OpenAI::Beta::BetaResponseAudioDoneEvent::Agent, nil)

Returns:



23
 
# File 'lib/openai/models/beta/beta_response_audio_done_event.rb', line 23

optional :agent, -> { OpenAI::Beta::BetaResponseAudioDoneEvent::Agent }, nil?: true

#sequence_number ⇒ Integer

The sequence number of the delta.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


11
 
# File 'lib/openai/models/beta/beta_response_audio_done_event.rb', line 11

required :sequence_number, Integer

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

The type of the event. Always response.audio.done.

Parameters:

  • value (:"response.audio.done")

Returns:

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


17
 
# File 'lib/openai/models/beta/beta_response_audio_done_event.rb', line 17

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


26
 
# File 'sig/openai/models/beta/beta_response_audio_done_event.rbs', line 26

def to_hash: -> {