azure_stt 0.1.0

data/lib/azure_stt/models/file.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module AzureSTT
+  module Models
+    #
+    # Model class to represent files in our models
+    #
+    # @see https://francecentral.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles/console
+    #
+    class File < Base
+      #
+      # The id of the file
+      #
+      # @!attribute [r] id
+      #   @return [Types::Coercible::String]
+      attribute :id, Types::Coercible::String
+
+      #
+      # The name of the file
+      #
+      # @!attribute [r] name
+      #   @return [Types::Coercible::String]
+      attribute :name, Types::Coercible::String
+
+      #
+      # The kind of the file. It is useful to determine wether it is a
+      # transcription result or a report
+      #
+      # @!attribute [r] kind
+      #   @return [Types::Coercible::String]
+      attribute :kind, Types::Coercible::String
+
+      #
+      # The properties you specified when you started the transcription
+      #
+      # @!attribute [r] properties
+      #   @return [Types::Coercible::Hash]
+      attribute :properties, Types::Coercible::Hash
+
+      #
+      # The date the file had been created
+      #
+      # @!attribute [r] created_date_time
+      #   @return [Types::Date]
+      attribute :created_date_time, Types::Date
+
+      #
+      # The url where you will be able to find the file. This url is valid only
+      # for a period of time.
+      #
+      # @!attribute [r] content_url
+      #   @return [Types::Coercible::String]
+      attribute :content_url, Types::Coercible::String
+
+      #
+      # The client used to interrogate the API to get the content of the file
+      #
+      # @!attribute [r] client
+      #   @return [AzureSTT::Client]
+      attribute :client, Types.Instance(AzureSTT::Client)
+
+      #
+      # Returns the result of the request to the file with the url content_url
+      #
+      # @return [Hash]
+      #
+      def content
+        client.get_file(content_url)
+      end
+    end
+  end
+end

data/lib/azure_stt/models/recognized_phrase.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module AzureSTT
+  module Models
+    #
+    # Model class to store a recognized phrase from the results file
+    #
+    class RecognizedPhrase < Base
+      #
+      # The status of the recognition for this phrase
+      #
+      # @!attribute [r] recognition_status
+      #   @return [Types::Coercible::String]
+      attribute :recognition_status, Types::Coercible::String
+
+      #
+      # The channel of the phrase. The API supports only two channels, so
+      # it is 0 or 1
+      #
+      # @!attribute [r] channel
+      #   @return [Types::Coercible::Integer]
+      attribute :channel, Types::Coercible::Integer
+
+      #
+      # The speaker. The API supports only two speakers, so it is 0 or 1
+      #
+      # @!attribute [r] speaker
+      #   @return [Types::Coercible::Integer]
+      attribute? :speaker, Types::Coercible::Integer
+
+      #
+      # The offset of the phrase in the audio. Ex: 'PT0.13S' means that the
+      # phrase begins at 13 seconds on the audio file
+      #
+      # @!attribute [r] offset
+      #   @return [Types::Coercible::String]
+      attribute? :offset, Types::Coercible::String
+
+      #
+      # The duration of the phrase. Ex: 'PT0.13S' means that the phrase lasts 13
+      # seconds
+      #
+      # @!attribute [r] duration
+      #   @return [Types::Coercible::String]
+      attribute? :duration, Types::Coercible::String
+
+      #
+      # The offset of the phrase in the audio in ticks.
+      #
+      # @!attribute [r] offset_in_ticks
+      #   @return [Types::Coercible::Integer]
+      attribute? :offset_in_ticks, Types::Coercible::Integer
+
+      #
+      # The duration of the phrase in ticks
+      #
+      # @!attribute [r] duration_in_ticks
+      #   @return [Types::Coercible::Integer]
+      attribute? :duration_in_ticks, Types::Coercible::Integer
+
+      #
+      # The sentences the API recognized. The first is the sentence with the
+      # highest confidence.
+      #
+      # @!attribute [r] n_best
+      #   @return [Types::Array.of(Sentence)]
+      attribute :n_best, Types::Array.of(Sentence).default([].freeze)
+    end
+  end
+end

data/lib/azure_stt/models/report.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module AzureSTT
+  module Models
+    #
+    # Model class for reports from a transcription.
+    #
+    class Report < Base
+      #
+      # The number of audio files that had been successsfully transcripted
+      #
+      # @!attribute [r] successful_transcriptions_count
+      #   @return [Types::Coercible::Integer]
+      attribute :successful_transcriptions_count, Types::Coercible::Integer
+
+      #
+      # The number of audio files that have failed
+      #
+      # @!attribute [r] failed_transcriptions_count
+      #   @return [Types::Coercible::Integer]
+      attribute :failed_transcriptions_count, Types::Coercible::Integer
+
+      #
+      # The details
+      #
+      # @!attribute [r] details
+      #   @return [Types::Array.of(Types::Hash)]
+      attribute :details, Types::Array.of(Types::Hash).default([].freeze)
+    end
+  end
+end

data/lib/azure_stt/models/result.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module AzureSTT
+  module Models
+    #
+    # Model class for the results of a transcription when the transcription is
+    # successful
+    #
+    class Result < Base
+      #
+      # The audio file source
+      #
+      # @!attribute [r] source
+      #   @return [Types::Coercible::String]
+      attribute :source, Types::Coercible::String
+
+      #
+      # The creation date of the result file
+      #
+      # @!attribute [r] timestamp
+      #   @return [Types::Date]
+      attribute :timestamp, Types::Date
+
+      #
+      # The duration of the audio in ticks
+      #
+      # @!attribute [r] duration_in_ticks
+      #   @return [Types::Coercible::Integer]
+      attribute :duration_in_ticks, Types::Coercible::Integer
+
+      #
+      # The duration of the audio in a String format
+      #
+      # @!attribute [r] duration
+      #   @return [Types::Coercible::String]
+      attribute :duration, Types::Coercible::String
+
+      #
+      # The transcript. It seems that the API generates one
+      # 'combinedRecognizedPhrase per channel.
+      #
+      # @!attribute [r] combined_recognized_phrases
+      #   @return [Types::Array.of(CombinedRecognizedPhrases)]
+      attribute :combined_recognized_phrases,
+                Types::Array.of(CombinedRecognizedPhrases).default([].freeze)
+
+      #
+      # The phrases that have been recognized from by the transcription
+      #
+      # @!attribute [r] recognized_phrases
+      #   @return [Types::Array.of(RecognizedPhrases)]
+      attribute :recognized_phrases,
+                Types::Array.of(RecognizedPhrase).default([].freeze)
+
+      #
+      # The display field of the first CombinedRecognizedPhrases
+      #
+      # @return [String]
+      #
+      def text
+        combined_recognized_phrases.first.transcript
+      end
+
+      #
+      # Get all the best Models::Sentence of a result.
+      #
+      # @return [Array[Models::Sentence]]
+      #
+      def sentences
+        recognized_phrases.map do |recognized_phrase|
+          recognized_phrase.n_best.first
+        end
+      end
+    end
+  end
+end

data/lib/azure_stt/models/sentence.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module AzureSTT
+  module Models
+    #
+    # Model to describe a sentence. A sentence is inside a nBest of a recognizedPhrase
+    #
+    class Sentence < Base
+      #
+      # The confidence score of the transcripted sentence.
+      #
+      # @!attribute [r] confidence
+      #   @return [Types::Coercible::Float]
+      attribute :confidence, Types::Coercible::Float
+
+      #
+      # The lexical field
+      #
+      # @!attribute [r] lexical
+      #   @return [Types::Coercible::String]
+      attribute :lexical, Types::Coercible::String
+
+      #
+      # The itn field
+      #
+      # @!attribute [r] itn
+      #   @return [Types::Coercible::String]
+      attribute :itn, Types::Coercible::String
+
+      #
+      # The maskedITN field
+      #
+      # @!attribute [r] masked_itn
+      #   @return [Types::Coercible::String]
+      attribute :masked_itn, Types::Coercible::String
+
+      #
+      # The display field. Displays the text with the format you specified in
+      # the paramters of the transcription.
+      #
+      # @!attribute [r] transcript
+      #   @return [Types::Coercible::String]
+      attribute :transcript, Types::Coercible::String
+
+      #
+      # The words recognized in the sentence.
+      #
+      # @!attribute [r] words
+      #   @return [Types::Array.of(Word)]
+      attribute? :words, Types::Array.of(Word).default([].freeze)
+    end
+  end
+end

data/lib/azure_stt/models/transcription.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+module AzureSTT
+  module Models
+    #
+    # Model for a transcription. Contains the results and static methods to
+    # create and retrieve the transcriptions.
+    #
+    class Transcription < Base
+      #
+      # The id of the transcription
+      #
+      # @!attribute [r] id
+      #   @return [Types::Coercible::String]
+      attribute :id, Types::Coercible::String
+
+      #
+      # The model url of the transcription
+      #
+      # @!attribute [r] model
+      #   @return [Types::Coercible::String]
+      attribute :model, Types::Coercible::String
+
+      #
+      # The properties of the transcription
+      #
+      # @!attribute [r] properties
+      #   @return [Types::Hash]
+      attribute :properties, Types::Hash
+
+      #
+      # The links for the transcription (usually just a link to the files route)
+      #
+      # @!attribute [r] links
+      #   @return [Types::Hash]
+      attribute :links, Types::Hash
+
+      #
+      # The last date the transcription has been updated
+      #
+      # @!attribute [r] last_action_date_time
+      #   @return [Types::Date]
+      attribute :last_action_date_time, Types::Date
+
+      #
+      # The date the transcription has been created
+      #
+      # @!attribute [r] created_date_time
+      #   @return [Types::Date]
+      attribute :created_date_time, Types::Date
+
+      #
+      # The status of the transcription
+      #
+      # @!attribute [r] status
+      #   @return [Types::Coercible::String]
+      attribute :status, Types::Coercible::String
+
+      #
+      # The locale of the transcription. Example: 'en-US'
+      #
+      # @!attribute [r] locale
+      #   @return [Types::Coercible::String]
+      attribute :locale, Types::Coercible::String
+
+      #
+      # The displayName of the transcription, not unique
+      #
+      # @!attribute [r] display_name
+      #   @return [Types::Coercible::String]
+      attribute :display_name, Types::Coercible::String
+
+      #
+      # The transcription's files that can be retrieve
+      #
+      # @!attribute [r] files
+      #   @return [Types::Array.of(File)]
+      attribute? :files, Types::Array.of(File).default([].freeze)
+
+      #
+      # The client used to interrogate the API
+      #
+      # @!attribute [r] client
+      #   @return [AzureSTT::Client]
+      attribute :client, Types.Instance(AzureSTT::Client)
+
+      #
+      # Is the process still running ?
+      #
+      # @return [Boolean]
+      #
+      def running?
+        status == 'Running'
+      end
+
+      #
+      # Is the status is failed ?
+      #
+      # @return [Boolean]
+      #
+      def failed?
+        status == 'Failed'
+      end
+
+      #
+      # Has the process succeeded ?
+      #
+      # @return [Boolean]
+      #
+      def succeeded?
+        status == 'Succeeded'
+      end
+
+      #
+      # Is the process finished ? (Succeeded or failed)
+      #
+      # @return [Boolean]
+      #
+      def finished?
+        succeeded? || failed?
+      end
+
+      #
+      # Get the report of a transcription from transcriptions/id/files route
+      #
+      # @see https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles/console
+      #
+      # @return [Models::Report]
+      #
+      def report
+        @report ||= retrieve_report
+      end
+
+      #
+      # Get the results of a transcription. The results are the files containing
+      # the speech-to-text. As a transcription process can have multiple files,
+      # the results are in an Array.
+      #
+      # @return [Array[Models::Result]]
+      #
+      def results
+        @results ||= retrieve_results
+      end
+
+      private
+
+      #
+      # All the files of a transcription
+      #
+      # @return [Array[File]] The files of the transcription
+      #
+      def files
+        @files ||= retrieve_files
+      end
+
+      #
+      # Interrogate the API to retrieve the files
+      #
+      # @return [Array[Files]] The files of the transcription
+      #
+      def retrieve_files
+        files_array = client.get_transcription_files(id)
+        files_array.map do |file_hash|
+          Models::File.new(
+            Parsers::File.new(file_hash).attributes.merge({ client: client })
+          )
+        end
+      end
+
+      def retrieve_report
+        report_file = files.find { |f| f.kind == 'TranscriptionReport' }
+        file_hash = report_file.content
+        Models::Report.new(Parsers::Report.new(file_hash).attributes)
+      end
+
+      def retrieve_results
+        results_files = files.select { |f| f.kind == 'Transcription' }
+        results_files.map do |result_file|
+          result_hash = result_file.content
+          Models::Result.new(Parsers::Result.new(result_hash).attributes)
+        end
+      end
+    end
+  end
+end