cloudmersive-voice-recognition-api-client 1.2.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 311b63f1d0d08d384689eb523f326bf21eaa444f864e2864f4785905499393aa
+  data.tar.gz: 073c876d2361908ab79b4b17338eedf27753f7d0d728592538c37102047e0679
+SHA512:
+  metadata.gz: b8d2800cbb8995257650bda27275e3ae4f6f5da9132e7467aa5dbeaeeaa8f74cac0aaa7ae111f3234566d556f08f904d40c1d40b82872464b920722720d1487b
+  data.tar.gz: af6ac0542a139265805c6d78c84c892fa409e74bf03032e59a2fe457d43f1849f5b32833d761c922615f7d0f3eb6a395a3e44c8dca8f68a9eb5ef3aa576014e7

data/Gemfile

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

data/README.md

@@ -0,0 +1,103 @@
+# 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: 1.2.9
+- 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-1.2.9.gem
+```
+(for development, run `gem install --dev ./cloudmersive-voice-recognition-api-client-1.2.9.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', '~> 1.2.9'
+
+### 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
+
+
+## Documentation for Models
+
+ - [CloudmersiveVoiceRecognitionApiClient::SpeechRecognitionResult](docs/SpeechRecognitionResult.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: unset
+
+=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,66 @@
+# 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_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/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/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,42 @@
+=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: unset
+
+=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'
+
+# 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

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

@@ -0,0 +1,79 @@
+=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: unset
+
+=end
+
+require "uri"
+
+module CloudmersiveVoiceRecognitionApiClient
+  class RecognizeApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Recognize audio input as text using machine learning
+    # Uses advanced machine learning to convert input audio, which can be mp3 or wav, into text.
+    # @param speech_file Speech file to perform the operation on.  Common file formats such as WAV, MP3 are supported.
+    # @param [Hash] opts the optional parameters
+    # @return [SpeechRecognitionResult]
+    def recognize_file(speech_file, opts = {})
+      data, _status_code, _headers = recognize_file_with_http_info(speech_file, opts)
+      return data
+    end
+
+    # Recognize audio input as text using machine learning
+    # Uses advanced machine learning to convert input audio, which can be mp3 or wav, into text.
+    # @param speech_file Speech file to perform the operation on.  Common file formats such as WAV, MP3 are supported.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SpeechRecognitionResult, Fixnum, Hash)>] SpeechRecognitionResult data, response status code and response headers
+    def recognize_file_with_http_info(speech_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RecognizeApi.recognize_file ..."
+      end
+      # verify the required parameter 'speech_file' is set
+      if @api_client.config.client_side_validation && speech_file.nil?
+        fail ArgumentError, "Missing the required parameter 'speech_file' when calling RecognizeApi.recognize_file"
+      end
+      # resource path
+      local_var_path = "/speech/recognize/file"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params["speechFile"] = speech_file
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SpeechRecognitionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecognizeApi#recognize_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end