Class: OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent

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

Defined Under Namespace

Classes: 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: :"transcription_session.updated") ⇒ Object

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

Returned when a transcription session is updated with a ‘transcription_session.update` event, unless there is an error.

Parameters:

  • event_id (String) —

    The unique ID of the server event.

  • session (OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session) —

    A new Realtime transcription session configuration.

  • type (Symbol, :"transcription_session.updated") (defaults to: :"transcription_session.updated") —

    The event type, must be ‘transcription_session.updated`.




# File 'lib/openai/models/realtime/transcription_session_updated_event.rb', line 29

Instance Attribute Details

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


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

required :event_id, String

#session ⇒ OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session

A new Realtime transcription session configuration.

When a session is created on the server via REST API, the session object also contains an ephemeral key. Default TTL for keys is 10 minutes. This property is not present when a session is updated via the WebSocket API.

Returns:



21
 
# File 'lib/openai/models/realtime/transcription_session_updated_event.rb', line 21

required :session, -> { OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session }

#type ⇒ Symbol, :"transcription_session.updated"

The event type, must be ‘transcription_session.updated`.

Returns:

  • (Symbol, :"transcription_session.updated") 


27
 
# File 'lib/openai/models/realtime/transcription_session_updated_event.rb', line 27

required :type, const: :"transcription_session.updated"