Code Monkey home page Code Monkey logo

azure_stt's People

Contributors

dependabot[bot] avatar frpouly avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

themire

azure_stt's Issues

Use Speech-to-text REST API v3.1

At the moment, the Gem is using Speech-to-text REST API v3.0.

However, according to this page, the version 3.0 will be retired.

It is therefore important to release a new version of the Gem that uses the new version of the API

Details about API errors are not given

Description

When encountering an error with the API, the exception should contain information about the error to help the user understand it.

Reproduction

Any API error will do. For instance, let us give an invalid subscription key.

begin
  session = AzureSTT::Session.new(region: 'eastus', subscription_key: 'invalid')
  session.get_transcriptions
rescue AzureSTT::ServiceError => e
  puts e.message
end

Current behavior

PermissionDenied (401)

Expected behavior

PermissionDenied (401): Access denied due to invalid subscription key or wrong API endpoint. Make sure to provide a valid key for an active subscription and use a correct regional API endpoint for your resource.

Notes

We can enable the logging of the HTTP requests for debugging purposes with the following instruction. See this HTTParty example for details.

AzureSTT::Client.class_eval { logger ::Logger.new($stdout), :debug, :curl }

Re-running the snippet above now prints the body of the response.

D, [2023-04-05T11:47:18.863532 #490911] DEBUG -- : [HTTParty] [2023-04-05 11:47:18 +0200] > GET https://eastus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions
[HTTParty] [2023-04-05 11:47:18 +0200] > Headers: 
[HTTParty] [2023-04-05 11:47:18 +0200] > Ocp-Apim-Subscription-Key: invalid
[HTTParty] [2023-04-05 11:47:18 +0200] > Content-Type: application/json
[HTTParty] [2023-04-05 11:47:18 +0200] > 
[HTTParty] [2023-04-05 11:47:18 +0200] < HTTP/1.1 401
[HTTParty] [2023-04-05 11:47:18 +0200] < Content-length: 224
[HTTParty] [2023-04-05 11:47:18 +0200] < Content-type: application/json
[HTTParty] [2023-04-05 11:47:18 +0200] < Apim-request-id: da69ffd0-143f-480d-919f-17caa875031d
[HTTParty] [2023-04-05 11:47:18 +0200] < Date: Wed, 05 Apr 2023 09:47:18 GMT
[HTTParty] [2023-04-05 11:47:18 +0200] < Connection: close
[HTTParty] [2023-04-05 11:47:18 +0200] < 
{"error":{"code":"401","message":"Access denied due to invalid subscription key or wrong API endpoint. Make sure to provide a valid key for an active subscription and use a correct regional API endpoint for your resource."}}
[HTTParty] [2023-04-05 11:47:18 +0200] < 

We can see that the response contains a useful error message about the nature of the problem. This pattern is present in most (if not all) of the API routes, according to the reference.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.