VoiceBase Ruby SDK

Overview

Ruby SDK for VoiceBase.com audio transcription service.

Installation

Via Bundler

Add voicebase to Gemfile and then run bundle:

$ echo "gem 'voicebase'" >> Gemfile
$ bundle

Via RubyGems

$ gem install voicebase

Usage

Upload Media

The upload_media method will accept a hash of parameters to send to the VoiceBase API. All supported parameters can be passed in.

From Filepath

Using SDK helper the :filePath and :fileContentType parameters will be auto-converted to a :file parameter supported by the VoiceBase API. It is also possible to directly include a :file parameter using Faraday::UploadIO.

voicebase = VoiceBase::V1::Client.new('myApiKey', 'myPassword')

# Using SDK Helpers
voicebase.upload_media(
  :filePath => '/path/to/myFile.mp3'
  :fileContentType => 'audio/mpeg'
)

# Using Faraday::UploadIO directly
voicebase.upload_media(
  :file => Faraday::UploadIO.new('/path/to/myFile.mp3', 'audio/mpeg')
)

From URL

voicebase = VoiceBase::V1::Client.new('myApiKey', 'myPassword')

voicebase.upload_media(
  :mediaUrl => 'http://example.com/path/to/myFile.mp3'
)

Change Log

See CHANGELOG.md

Contributions

Any reports of problems, comments or suggestions are most welcome.

Please report these on Github

License

VoiceBase Ruby SDK is available under an MIT-style license. See LICENSE.txt for details.