{"id":22546638,"url":"https://github.com/prx/speechmatics","last_synced_at":"2025-04-10T00:52:49.034Z","repository":{"id":18667649,"uuid":"21875891","full_name":"PRX/speechmatics","owner":"PRX","description":"Ruby client for Speechmatics API: https://speechmatics.com/api-details","archived":false,"fork":false,"pushed_at":"2018-07-09T18:25:50.000Z","size":46,"stargazers_count":7,"open_issues_count":1,"forks_count":15,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-10T00:52:43.922Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PRX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-15T21:04:59.000Z","updated_at":"2018-07-09T18:25:39.000Z","dependencies_parsed_at":"2022-09-25T01:13:00.774Z","dependency_job_id":null,"html_url":"https://github.com/PRX/speechmatics","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRX%2Fspeechmatics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRX%2Fspeechmatics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRX%2Fspeechmatics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRX%2Fspeechmatics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PRX","download_url":"https://codeload.github.com/PRX/speechmatics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137995,"owners_count":21053775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-07T15:08:26.452Z","updated_at":"2025-04-10T00:52:49.013Z","avatar_url":"https://github.com/PRX.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Speechmatics\n\n[![Gem Version](https://badge.fury.io/rb/speechmatics.svg)](http://badge.fury.io/rb/speechmatics)\n[![Build Status](https://travis-ci.org/PRX/speechmatics.svg?branch=master)](https://travis-ci.org/PRX/speechmatics)\n\nSpeechmatics (https://speechmatics.com) provides an API for speech to text (https://speechmatics.com/api-details).\n\nThis gem implements the API making it easier to integrate into Ruby and/or Rails projects.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n    gem 'speechmatics'\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install speechmatics\n\n## Usage\n\nSee the tests, or here is basic usage:\n```ruby\n\n# configure with api key and user id to use for all requsts\nSpeechmatics.configure do |sm|\n  sm.auth_token = '\u003cyour api key here\u003e'\n  sm.user_id    = 1234\n\n  # these are defaults\n  sm.adapter    = :excon\n  sm.endpoint   = 'https://api.speechmatics.com/v1.0/'\n  sm.user_agent = \"Speechmatics Ruby Gem #{Speechmatics::VERSION}\"\nend\n\n# create a new client\nc = Speechmatics::Client.new\n\n# create a new client, passing in Faraday parameters\n# you can also pass in the same options as in `configure`\nc = Speechmatics::Client.new(:request =\u003e { :timeout =\u003e 240 })\n\n# retrieve user\nj = c.user.get\n\n# list jobs\njobs = c.user.jobs.list\n\n# create job\ninfo = c.user.jobs.create(data_file: '/Users/nobody/dev/speechmatics/test/zero.wav')\n\n# create job with more options\ninfo = c.user.jobs.create(\n  data_file: '/Users/nobody/dev/speechmatics/test/zero.wav',\n  content_type: 'audio/x-wav; charset=binary',\n  notification: '\u003cemail | none | callback\u003e',\n  callback: 'http://www.example.com/transcript_callback'\n)\n\n# retrieve job\njob = c.user.jobs.find(5678)\n\n# retrieve trancript for a job\ntrans = c.user.jobs(5678).transcript\n# alt syntax\ntrans = c.user.jobs.transcript(5678)\n\n```\n\n## Changes\n* 0.2.2 - 9 July 2018\n  - Permit requesting transcriptions in text/plain, or mixed requests. Thanks @benlangfeld\n\n* 0.2.1 - 13 Sept 2017\n  - Updated error handling with a class for each error type. Thanks @mziwisky\n\n* 0.2.0 - 10/12/2016\n  - Added alignment support, thanks @rogerz42892\n\n* 0.1.4 - 8/21/2015\n  - Add support for video files.\n\n* 0.1.3 - 6/10/2015\n  - Add default timeout of 120 seconds.\n\n* 0.1.2 - 6/10/2015\n  - Yanked\n\n* 0.1.1 - 3/26/2015\n  - Fix to work with Faraday 0.7.6\n\n* 0.1.0 - 10/24/2014\n  - Remove /user/$userid/jobs/$jobid/audio endpoint, no longer supported by speechmatics\n\n* 0.0.2 - 8/7/2014\n  - Minor bug fix, treat integers/numbers as strings for params\n  - Use mimemagic to determine content type (no more libmagic dependency; this works on heroku)\n  - Switched the endpoint to use new 'https' requirement\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprx%2Fspeechmatics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprx%2Fspeechmatics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprx%2Fspeechmatics/lists"}