cloudmersive-voice-recognition-api-client 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d899858a804d48defc3d934ecb7ec0d29bbf27e37d2ad8abe3d1f79d2bfd9305
-  data.tar.gz: 5eb8b0ebfc18841349c4a4ca854e7a2389d2a89c116936a50e4067513f312059
+  metadata.gz: e3f0ec0065e6389def9a8ef1efacae88a15b53c714fc504428e0990f71641651
+  data.tar.gz: 854bf6aba251810894e68f8d85bc5b207fdb84a0c81c7f897a93a1026597d7e2
 SHA512:
-  metadata.gz: 5a79201e57bd8aad9e2fd40e296242eeca6bdde1099e4b8009d101db5242a762800e5704b68450e0eb5c706dbbdad4170fb4354e04f7dd867aa5914b4bf20cf3
-  data.tar.gz: 988b6cc4040bf68a297cd11710a8f07532e9c72ed7c2fc8f3ab2744559e07b382a5a80736dea8a9f63a652a5d8032b1334f03471d09a1afcb4c931b3f0b61317
+  metadata.gz: ae2b1b4cd9580e946fc811541f0601dba1d66c590872201dee67b9c55b9e51a4ef0d2460cfb46476c38c3b904d6f4b79304c660797339f12f50f6813134912a7
+  data.tar.gz: a65eb4983dd9f0302c98e1ee7285a208b1f8d967b15fe6073dcf4ab5b2991ca4a00dbf569195b3d57a5f85eb87cca06b5f320e3d01b2b1934a756de0eea73cc3

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/README.md

@@ -0,0 +1,105 @@
+# cloudmersive-voice-recognition-api-client
+
+CloudmersiveVoiceRecognitionApiClient - the Ruby gem for the speechapi
+
+Speech APIs enable you to recognize speech and convert it to text using advanced machine learning, and also to convert text to speech.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: v1
+- Package version: 2.0.2
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build cloudmersive-voice-recognition-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cloudmersive-voice-recognition-api-client-2.0.2.gem
+```
+(for development, run `gem install --dev ./cloudmersive-voice-recognition-api-client-2.0.2.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'cloudmersive-voice-recognition-api-client', '~> 2.0.2'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'cloudmersive-voice-recognition-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'cloudmersive-voice-recognition-api-client'
+
+# Setup authorization
+CloudmersiveVoiceRecognitionApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveVoiceRecognitionApiClient::RecognizeApi.new
+
+speech_file = File.new('/path/to/file.txt') # File | Speech file to perform the operation on.  Common file formats such as WAV, MP3 are supported.
+
+
+begin
+  #Recognize audio input as text using machine learning
+  result = api_instance.recognize_file(speech_file)
+  p result
+rescue CloudmersiveVoiceRecognitionApiClient::ApiError => e
+  puts "Exception when calling RecognizeApi->recognize_file: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CloudmersiveVoiceRecognitionApiClient::RecognizeApi* | [**recognize_file**](docs/RecognizeApi.md#recognize_file) | **POST** /speech/recognize/file | Recognize audio input as text using machine learning
+*CloudmersiveVoiceRecognitionApiClient::SpeakApi* | [**speak_post**](docs/SpeakApi.md#speak_post) | **POST** /speech/speak/text/basicVoice/{format} | Perform text-to-speech on a string
+*CloudmersiveVoiceRecognitionApiClient::SpeakApi* | [**speak_text_to_speech**](docs/SpeakApi.md#speak_text_to_speech) | **POST** /speech/speak/text/voice/basic/audio | Perform text-to-speech on a string
+
+
+## Documentation for Models
+
+ - [CloudmersiveVoiceRecognitionApiClient::SpeechRecognitionResult](docs/SpeechRecognitionResult.md)
+ - [CloudmersiveVoiceRecognitionApiClient::TextToSpeechRequest](docs/TextToSpeechRequest.md)
+
+
+## Documentation for Authorization
+
+
+### Apikey
+
+- **Type**: API key
+- **API key parameter name**: Apikey
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/cloudmersive-voice-recognition-api-client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#speechapi
+
+#Speech APIs enable you to recognize speech and convert it to text using advanced machine learning, and also to convert text to speech.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cloudmersive-voice-recognition-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudmersive-voice-recognition-api-client"
+  s.version     = CloudmersiveVoiceRecognitionApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cloudmersive"]
+  s.email       = [""]
+  s.homepage    = "https://www.cloudmersive.com/voice-recognition-and-speech-api"
+  s.summary     = "The most powerful and cost-effective speech recognition and voice AI APIs, continuously updated."
+  s.description = "Speech APIs enable you to recognize speech and convert it to text using advanced machine learning, and also to convert text to speech."
+  s.license     = 'Apache 2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = Dir['./**/*']
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/RecognizeApi.md

@@ -0,0 +1,63 @@
+# CloudmersiveVoiceRecognitionApiClient::RecognizeApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**recognize_file**](RecognizeApi.md#recognize_file) | **POST** /speech/recognize/file | Recognize audio input as text using machine learning
+
+
+# **recognize_file**
+> SpeechRecognitionResult recognize_file(speech_file)
+
+Recognize audio input as text using machine learning
+
+Uses advanced machine learning to convert input audio, which can be mp3 or wav, into text.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-voice-recognition-api-client'
+# setup authorization
+CloudmersiveVoiceRecognitionApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveVoiceRecognitionApiClient::RecognizeApi.new
+
+speech_file = File.new('/path/to/file.txt') # File | Speech file to perform the operation on.  Common file formats such as WAV, MP3 are supported.
+
+
+begin
+  #Recognize audio input as text using machine learning
+  result = api_instance.recognize_file(speech_file)
+  p result
+rescue CloudmersiveVoiceRecognitionApiClient::ApiError => e
+  puts "Exception when calling RecognizeApi->recognize_file: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **speech_file** | **File**| Speech file to perform the operation on.  Common file formats such as WAV, MP3 are supported. | 
+
+### Return type
+
+[**SpeechRecognitionResult**](SpeechRecognitionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/SpeakApi.md

@@ -0,0 +1,121 @@
+# CloudmersiveVoiceRecognitionApiClient::SpeakApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**speak_post**](SpeakApi.md#speak_post) | **POST** /speech/speak/text/basicVoice/{format} | Perform text-to-speech on a string
+[**speak_text_to_speech**](SpeakApi.md#speak_text_to_speech) | **POST** /speech/speak/text/voice/basic/audio | Perform text-to-speech on a string
+
+
+# **speak_post**
+> Object speak_post(format, text)
+
+Perform text-to-speech on a string
+
+Takes as input a string and a file format (mp3 or wav) and outputs a wave form in the appropriate format.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-voice-recognition-api-client'
+# setup authorization
+CloudmersiveVoiceRecognitionApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveVoiceRecognitionApiClient::SpeakApi.new
+
+format = 'format_example' # String | File format to generate response in; possible values are \"mp3\" or \"wav\"
+
+text = 'text_example' # String | The text you would like to conver to speech.  Be sure to surround with quotes, e.g. \"The quick brown fox jumps over the lazy dog.\"
+
+
+begin
+  #Perform text-to-speech on a string
+  result = api_instance.speak_post(format, text)
+  p result
+rescue CloudmersiveVoiceRecognitionApiClient::ApiError => e
+  puts "Exception when calling SpeakApi->speak_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **format** | **String**| File format to generate response in; possible values are \"mp3\" or \"wav\" | 
+ **text** | **String**| The text you would like to conver to speech.  Be sure to surround with quotes, e.g. \"The quick brown fox jumps over the lazy dog.\" | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/octet-stream
+
+
+
+# **speak_text_to_speech**
+> Object speak_text_to_speech(req_config)
+
+Perform text-to-speech on a string
+
+Takes as input a string and a file format (mp3 or wav) and outputs a wave form in the appropriate format.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-voice-recognition-api-client'
+# setup authorization
+CloudmersiveVoiceRecognitionApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveVoiceRecognitionApiClient::SpeakApi.new
+
+req_config = CloudmersiveVoiceRecognitionApiClient::TextToSpeechRequest.new # TextToSpeechRequest | String input request
+
+
+begin
+  #Perform text-to-speech on a string
+  result = api_instance.speak_text_to_speech(req_config)
+  p result
+rescue CloudmersiveVoiceRecognitionApiClient::ApiError => e
+  puts "Exception when calling SpeakApi->speak_text_to_speech: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req_config** | [**TextToSpeechRequest**](TextToSpeechRequest.md)| String input request | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/SpeechRecognitionResult.md

@@ -0,0 +1,8 @@
+# CloudmersiveVoiceRecognitionApiClient::SpeechRecognitionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_result** | **String** | Recognition result in text format | [optional] 
+
+

data/docs/TextToSpeechRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveVoiceRecognitionApiClient::TextToSpeechRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**format** | **String** | File format for output audio file: wav or mp3, default is mp3 | [optional] 
+**text** | **String** | Text to be converted to speech | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/cloudmersive-voice-recognition-api-client.rb

@@ -0,0 +1,43 @@
+=begin
+#speechapi
+
+#Speech APIs enable you to recognize speech and convert it to text using advanced machine learning, and also to convert text to speech.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+# Common files
+require 'cloudmersive-voice-recognition-api-client/api_client'
+require 'cloudmersive-voice-recognition-api-client/api_error'
+require 'cloudmersive-voice-recognition-api-client/version'
+require 'cloudmersive-voice-recognition-api-client/configuration'
+
+# Models
+require 'cloudmersive-voice-recognition-api-client/models/speech_recognition_result'
+require 'cloudmersive-voice-recognition-api-client/models/text_to_speech_request'
+
+# APIs
+require 'cloudmersive-voice-recognition-api-client/api/recognize_api'
+require 'cloudmersive-voice-recognition-api-client/api/speak_api'
+
+module CloudmersiveVoiceRecognitionApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   CloudmersiveVoiceRecognitionApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end