Class: AssemblyAI::Realtime::ForceEndUtterance

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

Overview

Manually end an utterance

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(force_end_utterance:, additional_properties: nil) ⇒ AssemblyAI::Realtime::ForceEndUtterance

Parameters:

  • force_end_utterance (Boolean) —

    A boolean value to communicate that you wish to force the end of the utterance

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

    Additional properties unmapped to the current class definition



23
24
25
26
27
 
# File 'lib/assemblyai/realtime/types/force_end_utterance.rb', line 23

def initialize(force_end_utterance:, additional_properties: nil)
  @force_end_utterance = force_end_utterance
  @additional_properties = additional_properties
  @_field_set = { "force_end_utterance": force_end_utterance }
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



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

def additional_properties
  @additional_properties
end

#force_end_utterance ⇒ Boolean (readonly)

Returns A boolean value to communicate that you wish to force the end of the utterance.

Returns:

  • (Boolean) —

    A boolean value to communicate that you wish to force the end of the utterance



11
12
13
 
# File 'lib/assemblyai/realtime/types/force_end_utterance.rb', line 11

def force_end_utterance
  @force_end_utterance
end

Class Method Details

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

Deserialize a JSON object to an instance of ForceEndUtterance

Parameters:

  • json_object (String)

Returns:



33
34
35
36
37
 
# File 'lib/assemblyai/realtime/types/force_end_utterance.rb', line 33

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  force_end_utterance = struct["force_end_utterance"]
  new(force_end_utterance: force_end_utterance, 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) 


52
53
54
 
# File 'lib/assemblyai/realtime/types/force_end_utterance.rb', line 52

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ForceEndUtterance to a JSON object

Returns:

  • (String) 


42
43
44
 
# File 'lib/assemblyai/realtime/types/force_end_utterance.rb', line 42

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