assemblyai 1.0.0.pre.beta.7 → 1.0.0.pre.beta.8

data/lib/assemblyai/transcripts/types/topic_detection_model_result.rb

@@ -2,60 +2,80 @@
 
 require_relative "audio_intelligence_model_status"
 require_relative "topic_detection_result"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     # The result of the Topic Detection model, if it is enabled.
-    # See [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) for more information.
+    #  See [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection)
+    #  for more information.
     class TopicDetectionModelResult
-      attr_reader :status, :results, :summary, :additional_properties
+      # @return [AssemblyAI::Transcripts::AudioIntelligenceModelStatus] The status of the Topic Detection model. Either success, or unavailable in the
+      #  rare case that the model failed.
+      attr_reader :status
+      # @return [Array<AssemblyAI::Transcripts::TopicDetectionResult>] An array of results for the Topic Detection model
+      attr_reader :results
+      # @return [Hash{String => Float}] The overall relevance of topic to the entire audio file
+      attr_reader :summary
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
 
-      # @param status [Transcripts::AudioIntelligenceModelStatus] The status of the Topic Detection model. Either success, or unavailable in the rare case that the model failed.
-      # @param results [Array<Transcripts::TopicDetectionResult>] An array of results for the Topic Detection model
+      OMIT = Object.new
+
+      # @param status [AssemblyAI::Transcripts::AudioIntelligenceModelStatus] The status of the Topic Detection model. Either success, or unavailable in the
+      #  rare case that the model failed.
+      # @param results [Array<AssemblyAI::Transcripts::TopicDetectionResult>] An array of results for the Topic Detection model
       # @param summary [Hash{String => Float}] The overall relevance of topic to the entire audio file
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TopicDetectionModelResult]
+      # @return [AssemblyAI::Transcripts::TopicDetectionModelResult]
       def initialize(status:, results:, summary:, additional_properties: nil)
-        # @type [Transcripts::AudioIntelligenceModelStatus] The status of the Topic Detection model. Either success, or unavailable in the rare case that the model failed.
         @status = status
-        # @type [Array<Transcripts::TopicDetectionResult>] An array of results for the Topic Detection model
         @results = results
-        # @type [Hash{String => Float}] The overall relevance of topic to the entire audio file
         @summary = summary
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "status": status, "results": results, "summary": summary }
       end
 
       # Deserialize a JSON object to an instance of TopicDetectionModelResult
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TopicDetectionModelResult]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TopicDetectionModelResult]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        status = struct.status
+        status = struct["status"]
         results = parsed_json["results"]&.map do |v|
           v = v.to_json
-          Transcripts::TopicDetectionResult.from_json(json_object: v)
+          AssemblyAI::Transcripts::TopicDetectionResult.from_json(json_object: v)
         end
-        summary = struct.summary
-        new(status: status, results: results, summary: summary, additional_properties: struct)
+        summary = struct["summary"]
+        new(
+          status: status,
+          results: results,
+          summary: summary,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TopicDetectionModelResult to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "status": @status, "results": @results, "summary": @summary }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.status.is_a?(Transcripts::AudioIntelligenceModelStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.status.is_a?(AssemblyAI::Transcripts::AudioIntelligenceModelStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
         obj.summary.is_a?(Hash) != false || raise("Passed value for field obj.summary is not the expected type, validation failed.")
       end

data/lib/assemblyai/transcripts/types/topic_detection_result.rb

@@ -2,66 +2,85 @@
 
 require_relative "topic_detection_result_labels_item"
 require_relative "timestamp"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     # The result of the topic detection model
     class TopicDetectionResult
-      attr_reader :text, :labels, :timestamp, :additional_properties
+      # @return [String] The text in the transcript in which a detected topic occurs
+      attr_reader :text
+      # @return [Array<AssemblyAI::Transcripts::TopicDetectionResultLabelsItem>]
+      attr_reader :labels
+      # @return [AssemblyAI::Transcripts::Timestamp]
+      attr_reader :timestamp
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
 
       # @param text [String] The text in the transcript in which a detected topic occurs
-      # @param labels [Array<Transcripts::TopicDetectionResultLabelsItem>]
-      # @param timestamp [Transcripts::Timestamp]
+      # @param labels [Array<AssemblyAI::Transcripts::TopicDetectionResultLabelsItem>]
+      # @param timestamp [AssemblyAI::Transcripts::Timestamp]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TopicDetectionResult]
-      def initialize(text:, labels: nil, timestamp: nil, additional_properties: nil)
-        # @type [String] The text in the transcript in which a detected topic occurs
+      # @return [AssemblyAI::Transcripts::TopicDetectionResult]
+      def initialize(text:, labels: OMIT, timestamp: OMIT, additional_properties: nil)
         @text = text
-        # @type [Array<Transcripts::TopicDetectionResultLabelsItem>]
-        @labels = labels
-        # @type [Transcripts::Timestamp]
-        @timestamp = timestamp
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @labels = labels if labels != OMIT
+        @timestamp = timestamp if timestamp != OMIT
         @additional_properties = additional_properties
+        @_field_set = { "text": text, "labels": labels, "timestamp": timestamp }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of TopicDetectionResult
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TopicDetectionResult]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TopicDetectionResult]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        text = struct.text
+        text = struct["text"]
         labels = parsed_json["labels"]&.map do |v|
           v = v.to_json
-          Transcripts::TopicDetectionResultLabelsItem.from_json(json_object: v)
+          AssemblyAI::Transcripts::TopicDetectionResultLabelsItem.from_json(json_object: v)
         end
         if parsed_json["timestamp"].nil?
           timestamp = nil
         else
           timestamp = parsed_json["timestamp"].to_json
-          timestamp = Transcripts::Timestamp.from_json(json_object: timestamp)
+          timestamp = AssemblyAI::Transcripts::Timestamp.from_json(json_object: timestamp)
         end
-        new(text: text, labels: labels, timestamp: timestamp, additional_properties: struct)
+        new(
+          text: text,
+          labels: labels,
+          timestamp: timestamp,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TopicDetectionResult to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "text": @text, "labels": @labels, "timestamp": @timestamp }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
         obj.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
         obj.labels&.is_a?(Array) != false || raise("Passed value for field obj.labels is not the expected type, validation failed.")
-        obj.timestamp.nil? || Transcripts::Timestamp.validate_raw(obj: obj.timestamp)
+        obj.timestamp.nil? || AssemblyAI::Transcripts::Timestamp.validate_raw(obj: obj.timestamp)
       end
     end
   end

data/lib/assemblyai/transcripts/types/topic_detection_result_labels_item.rb

@@ -1,45 +1,61 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class TopicDetectionResultLabelsItem
-      attr_reader :relevance, :label, :additional_properties
+      # @return [Float] How relevant the detected topic is of a detected topic
+      attr_reader :relevance
+      # @return [String] The IAB taxonomical label for the label of the detected topic, where > denotes
+      #  supertopic/subtopic relationship
+      attr_reader :label
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
 
       # @param relevance [Float] How relevant the detected topic is of a detected topic
-      # @param label [String] The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship
+      # @param label [String] The IAB taxonomical label for the label of the detected topic, where > denotes
+      #  supertopic/subtopic relationship
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TopicDetectionResultLabelsItem]
+      # @return [AssemblyAI::Transcripts::TopicDetectionResultLabelsItem]
       def initialize(relevance:, label:, additional_properties: nil)
-        # @type [Float] How relevant the detected topic is of a detected topic
         @relevance = relevance
-        # @type [String] The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship
         @label = label
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "relevance": relevance, "label": label }
       end
 
       # Deserialize a JSON object to an instance of TopicDetectionResultLabelsItem
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TopicDetectionResultLabelsItem]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TopicDetectionResultLabelsItem]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        relevance = struct.relevance
-        label = struct.label
-        new(relevance: relevance, label: label, additional_properties: struct)
+        relevance = struct["relevance"]
+        label = struct["label"]
+        new(
+          relevance: relevance,
+          label: label,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TopicDetectionResultLabelsItem to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "relevance": @relevance, "label": @label }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]