assemblyai 1.0.0.pre.beta

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "json"
+
+module AssemblyAI
+  class Transcripts
+    # Timestamp containing a start and end property in milliseconds
+    class Timestamp
+      attr_reader :start, :end_, :additional_properties
+
+      # @param start [Integer] The start time in milliseconds
+      # @param end_ [Integer] The end time in milliseconds
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Transcripts::Timestamp]
+      def initialize(start:, end_:, additional_properties: nil)
+        # @type [Integer] The start time in milliseconds
+        @start = start
+        # @type [Integer] The end time in milliseconds
+        @end_ = end_
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of Timestamp
+      #
+      # @param json_object [JSON]
+      # @return [Transcripts::Timestamp]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        start = struct.start
+        end_ = struct.end
+        new(start: start, end_: end_, additional_properties: struct)
+      end
+
+      # Serialize an instance of Timestamp to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "start": @start, "end": @end_ }.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.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.start.is_a?(Integer) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
+        obj.end_.is_a?(Integer) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "audio_intelligence_model_status"
+require_relative "topic_detection_result"
+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.
+    class TopicDetectionModelResult
+      attr_reader :status, :results, :summary, :additional_properties
+
+      # @param status [AUDIO_INTELLIGENCE_MODEL_STATUS] 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
+      # @param summary [Hash{String => String}] 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]
+      def initialize(status:, results:, summary:, additional_properties: nil)
+        # @type [AUDIO_INTELLIGENCE_MODEL_STATUS] 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 => String}] 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
+      end
+
+      # Deserialize a JSON object to an instance of TopicDetectionModelResult
+      #
+      # @param json_object [JSON]
+      # @return [Transcripts::TopicDetectionModelResult]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        status = Transcripts::AUDIO_INTELLIGENCE_MODEL_STATUS.key(parsed_json["status"]) || parsed_json["status"]
+        results = parsed_json["results"]&.map do |v|
+          v = v.to_json
+          Transcripts::TopicDetectionResult.from_json(json_object: v)
+        end
+        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]
+      def to_json(*_args)
+        {
+          "status": Transcripts::AUDIO_INTELLIGENCE_MODEL_STATUS[@status] || @status,
+          "results": @results,
+          "summary": @summary
+        }.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.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.status.is_a?(Transcripts::AUDIO_INTELLIGENCE_MODEL_STATUS) != 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
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "topic_detection_result_labels_item"
+require_relative "timestamp"
+require "json"
+
+module AssemblyAI
+  class Transcripts
+    # The result of the topic detection model
+    class TopicDetectionResult
+      attr_reader :text, :labels, :timestamp, :additional_properties
+
+      # @param text [String] The text in the transcript in which a detected topic occurs
+      # @param labels [Array<Transcripts::TopicDetectionResultLabelsItem>]
+      # @param timestamp [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
+        @text = text
+        # @type [Array<Transcripts::TopicDetectionResultLabelsItem>]
+        @labels = labels
+        # @type [Transcripts::Timestamp]
+        @timestamp = timestamp
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of TopicDetectionResult
+      #
+      # @param json_object [JSON]
+      # @return [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
+        labels = parsed_json["labels"]&.map do |v|
+          v = v.to_json
+          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)
+        end
+        new(text: text, labels: labels, timestamp: timestamp, additional_properties: struct)
+      end
+
+      # Serialize an instance of TopicDetectionResult to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "text": @text, "labels": @labels, "timestamp": @timestamp }.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.
+      #
+      # @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)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "json"
+
+module AssemblyAI
+  class Transcripts
+    class TopicDetectionResultLabelsItem
+      attr_reader :relevance, :label, :additional_properties
+
+      # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [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
+      end
+
+      # Deserialize a JSON object to an instance of TopicDetectionResultLabelsItem
+      #
+      # @param json_object [JSON]
+      # @return [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)
+      end
+
+      # Serialize an instance of TopicDetectionResultLabelsItem to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "relevance": @relevance, "label": @label }.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.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      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
+    end
+  end
+end