Class: OpenAI::Models::Realtime::SessionCreatedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/session_created_event.rb

Defined Under Namespace

Modules: Session

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:, session:, type: :"session.created") ⇒ Object

Returned when a Session is created. Emitted automatically when a new connection is established as the first server event. This event will contain the default Session configuration.

Parameters:




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

Instance Attribute Details

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


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

required :event_id, String

#session ⇒ OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest

The session configuration.

Returns:



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

required :session, union: -> { OpenAI::Realtime::SessionCreatedEvent::Session }

#type ⇒ Symbol, :"session.created"

The event type, must be ‘session.created`.

Returns:



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

required :type, const: :"session.created"