azure_stt

API Wrapper for the Microsoft Azure Speech Services Speech-to-text REST API 3.0 (Cognitive Services).

Installation

Add this line to your application’s Gemfile:

ruby gem 'azure_stt'

And then execute:

bash bundle

Or install it yourself as:

bash gem install azure_stt

Azure Speech-to-text Subscription key

To be able to use the gem, you must have a subscription key. You can generate one on your Azure account.

• If you don’t have an Azure account, you can create one for free on this page.
• Once logged on your Azure portal, subscribe to SpeechServices in Microsoft Cognitive Service.
• You will find two subscription keys available in ‘RESOURCE MANAGEMENT > Keys’ (‘KEY 1’ and ‘KEY 2’).

Usage

Configuration

Two environment variables are used:

• ‘REGION’: the region of your subscription

• ‘SUBSCRIPTION_KEY’: the API key you can generate on your Azure account.

You can look at the file env.sample and change the values. If you do not want to use environment variables, you can configure the values like so:

ruby AzureSTT.configure do |config| config.region = 'your_region' config.subscription_key = 'your_key' end

Finally, the class AzureSTT::Session uses by the default the values from the configuration, but you can initialize the session with custom values:

ruby session = AzureSTT::Session.new(region: 'your_region', subscription_key: 'your_key')

start a transcription

```ruby require ‘azure_stt’

properties = { “diarizationEnabled” => false, “wordLevelTimestampsEnabled” => false, “punctuationMode” => “DictatedAndAutomatic”, “profanityFilterMode” => “Masked” }

content_urls = [ ‘https://path.com/audio.ogg’, ‘https://path.com/audio1.ogg’]

session = AzureSTT::Session.new

transcription = session.create_transcription( content_urls: content_urls, properties: properties, locale: ‘en-US’, display_name: ‘The name of the transcription’)

You can the retrieve the results of your transcription with the id

puts transcription.id # Outputs ‘your_transcription_id’

```

Get a transcription

```ruby require ‘azure_stt’

session = AzureSTT::Session.new

transcription = session.get_transcription(‘your_transcription_id’)

Returns

# #<AzureSTT::Transcription id=”d35a802d-70ae-4358-a35d-b5faa0c75457” # # model=”” properties=# # “wordLevelTimestampsEnabled”=>false, “channels”=>[0, 1], # # “punctuationMode”=>”DictatedAndAutomatic”, “profanityFilterMode”=>”Masked”, # # “duration”=>”PT5M18S” # # links=“files”=>”https://uscentral.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/d35a802d-70ae-4358-a35d-b5faa0c75457/files” # # last_action_date_time=#<Date: 2020-05-31 ((2459366j,0s,0n),+0s,2299161j)> created_date_time=#<Date: 2020-05-31 ((2459366j,0s,0n),+0s,2299161j)> # # status=”Succeeded” locale=”en-US” display_name=”Transcription name” files=[]>

if transcription.succeeded? # You can then access to the text, for instance : result = transcription.results.first puts result.text end ```

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/azure_stt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the AzureStt project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.