Class: AssemblyAI::Transcripts::TopicDetectionResultLabelsItem

Inherits:
Object
  • Object
show all
Defined in:
lib/assemblyai/transcripts/types/topic_detection_result_labels_item.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(relevance:, label:, additional_properties: nil) ⇒ AssemblyAI::Transcripts::TopicDetectionResultLabelsItem

Parameters:

  • relevance (Float) —

    How relevant the detected topic is of a detected topic

  • label (String) —

    The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship

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

    Additional properties unmapped to the current class definition



27
28
29
30
31
32
 
# File 'lib/assemblyai/transcripts/types/topic_detection_result_labels_item.rb', line 27

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



15
16
17
 
# File 'lib/assemblyai/transcripts/types/topic_detection_result_labels_item.rb', line 15

def additional_properties
  @additional_properties
end

#label ⇒ String (readonly)

Returns The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship.

Returns:

  • (String) —

    The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship



13
14
15
 
# File 'lib/assemblyai/transcripts/types/topic_detection_result_labels_item.rb', line 13

def label
  @label
end

#relevance ⇒ Float (readonly)

Returns How relevant the detected topic is of a detected topic.

Returns:

  • (Float) —

    How relevant the detected topic is of a detected topic



10
11
12
 
# File 'lib/assemblyai/transcripts/types/topic_detection_result_labels_item.rb', line 10

def relevance
  @relevance
end

Class Method Details

.from_json(json_object:) ⇒ AssemblyAI::Transcripts::TopicDetectionResultLabelsItem

Deserialize a JSON object to an instance of TopicDetectionResultLabelsItem

Parameters:

  • json_object (String)

Returns:



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/assemblyai/transcripts/types/topic_detection_result_labels_item.rb', line 38

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


62
63
64
65
 
# File 'lib/assemblyai/transcripts/types/topic_detection_result_labels_item.rb', line 62

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TopicDetectionResultLabelsItem to a JSON object

Returns:

  • (String) 


52
53
54
 
# File 'lib/assemblyai/transcripts/types/topic_detection_result_labels_item.rb', line 52

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