Class: AssemblyAI::Realtime::SessionInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/assemblyai/realtime/types/session_information.rb

Overview

Information about the session that is concluding.

This message is sent at the end of the session, before the SessionTerminated
message.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message_type:, audio_duration_seconds:, additional_properties: nil) ⇒ AssemblyAI::Realtime::SessionInformation

Parameters:

  • message_type (String) —

    Describes the type of the message

  • audio_duration_seconds (Float) —

    The total duration of the audio in seconds

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



28
29
30
31
32
33
 
# File 'lib/assemblyai/realtime/types/session_information.rb', line 28

def initialize(message_type:, audio_duration_seconds:, additional_properties: nil)
  @message_type = message_type
  @audio_duration_seconds = audio_duration_seconds
  @additional_properties = additional_properties
  @_field_set = { "message_type": message_type, "audio_duration_seconds": audio_duration_seconds }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



17
18
19
 
# File 'lib/assemblyai/realtime/types/session_information.rb', line 17

def additional_properties
  @additional_properties
end

#audio_duration_seconds ⇒ Float (readonly)

Returns The total duration of the audio in seconds.

Returns:

  • (Float) —

    The total duration of the audio in seconds



15
16
17
 
# File 'lib/assemblyai/realtime/types/session_information.rb', line 15

def audio_duration_seconds
  @audio_duration_seconds
end

#message_type ⇒ String (readonly)

Returns Describes the type of the message.

Returns:

  • (String) —

    Describes the type of the message



13
14
15
 
# File 'lib/assemblyai/realtime/types/session_information.rb', line 13

def message_type
  @message_type
end

Class Method Details

.from_json(json_object:) ⇒ AssemblyAI::Realtime::SessionInformation

Deserialize a JSON object to an instance of SessionInformation

Parameters:

  • json_object (String)

Returns:



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/assemblyai/realtime/types/session_information.rb', line 39

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  message_type = struct["message_type"]
  audio_duration_seconds = struct["audio_duration_seconds"]
  new(
    message_type: message_type,
    audio_duration_seconds: audio_duration_seconds,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


63
64
65
66
 
# File 'lib/assemblyai/realtime/types/session_information.rb', line 63

def self.validate_raw(obj:)
  obj.message_type.is_a?(String) != false || raise("Passed value for field obj.message_type is not the expected type, validation failed.")
  obj.audio_duration_seconds.is_a?(Float) != false || raise("Passed value for field obj.audio_duration_seconds is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of SessionInformation to a JSON object

Returns:

  • (String) 


53
54
55
 
# File 'lib/assemblyai/realtime/types/session_information.rb', line 53

def to_json(*_args)
  @_field_set&.to_json
end