Module: OpenAI::Models::Live::ForkServerEvent

Extended by:
Internal::Type::Union
Defined in:
lib/openai/models/live/fork_server_event.rb,
sig/openai/models/live/fork_server_event.rbs

Overview

Server events for Live. Response lifecycle events are wrapped inside response.event; dispatch the nested event by its full type and tolerate new response event types. Follow the Live prompting guide when designing the conversation and delegation policy.

Defined Under Namespace

Classes: SessionInputAudioAppend, TransportAnswered, TransportDtmfReceived, TransportDtmfSend, TransportFailed, TransportRinging

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(OpenAI::Models::Live::SessionStartedEvent, OpenAI::Models::Live::SessionUpdatedEvent, OpenAI::Models::Live::InputAudioMutedEvent, OpenAI::Models::Live::InputAudioUnmutedEvent, OpenAI::Models::Live::InstructionsAppendedEvent, OpenAI::Models::Live::ThinkingAppendedEvent, OpenAI::Models::Live::CommentaryAppendedEvent, OpenAI::Models::Live::ForkServerEvent::SessionInputAudioAppend, OpenAI::Models::Live::OutputAudioDeltaEvent, OpenAI::Models::Live::InputTranscriptDeltaEvent, OpenAI::Models::Live::OutputTranscriptDeltaEvent, OpenAI::Models::Live::DelegationCreatedEvent, OpenAI::Models::Live::ResponseEvent, OpenAI::Models::Live::SessionUsageUpdatedEvent, OpenAI::Models::Live::SessionClosedEvent, OpenAI::Models::Live::ErrorEvent, OpenAI::Models::Live::InfoEvent, OpenAI::Models::Live::ForkServerEvent::TransportDtmfReceived, OpenAI::Models::Live::ForkServerEvent::TransportDtmfSend, OpenAI::Models::Live::ForkServerEvent::TransportRinging, OpenAI::Models::Live::ForkServerEvent::TransportAnswered, OpenAI::Models::Live::ForkServerEvent::TransportFailed)

Returns:




# File 'lib/openai/models/live/fork_server_event.rb', line 290

Instance Method Details

#initialize(event_id:, session_id:, type: :"transport.answered") ⇒ Object

The outbound SIP provider leg answered and media is established. Delivered only to sideband observers.

Parameters:

  • event_id (String)
  • session_id (String) —

    The canonical Live session ID.

  • type (Symbol, :"transport.answered") (defaults to: :"transport.answered") 



# File 'lib/openai/models/live/fork_server_event.rb', line 97

#self?.variants ⇒ ::Array[OpenAI::Models::Live::fork_server_event]

Returns:

  • (::Array[OpenAI::Models::Live::fork_server_event]) 


208
 
# File 'sig/openai/models/live/fork_server_event.rbs', line 208

def self?.variants: -> ::Array[OpenAI::Models::Live::fork_server_event]