cloudmersive-nlp-api-client 1.2.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f6ebc52a41b9d3bcfe79a000a265347b93ececbd5c83104c49ead837215bb39
+  data.tar.gz: 945e33b59e45792703388182c70a53b4ebbd24480ab47bb81dfc667054ac360f
+SHA512:
+  metadata.gz: 5870e53fb640715ecfb710cdc53365b8dd796514da7589f809fb82618d4c95e46812f21b228b74f0884ed6c4c00531197c95259d0ab9ab2ab1522c1500c6a5f7
+  data.tar.gz: 77f70ea3b78f5896f9affa8b97c755e1139bab09f365ca57e936d1786c86e124d46a4a2809414b78135794bfcb270dfe92c12de8b1ed1264d8061aaaf66b07ab

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,131 @@
+# cloudmersive-nlp-api-client
+
+CloudmersiveNlpApiClient - the Ruby gem for the nlpapi
+
+The powerful Natural Language Processing APIs let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
+
+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-nlp-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cloudmersive-nlp-api-client-1.2.9.gem
+```
+(for development, run `gem install --dev ./cloudmersive-nlp-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-nlp-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-nlp-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-nlp-api-client'
+
+# Setup authorization
+CloudmersiveNlpApiClient.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 = CloudmersiveNlpApiClient::ExtractEntitiesStringApi.new
+
+value = "value_example" # String | Input string
+
+
+begin
+  #Extract entities from string
+  result = api_instance.extract_entities_string_post(value)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling ExtractEntitiesStringApi->extract_entities_string_post: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CloudmersiveNlpApiClient::ExtractEntitiesStringApi* | [**extract_entities_string_post**](docs/ExtractEntitiesStringApi.md#extract_entities_string_post) | **POST** /nlp/ExtractEntitiesString | Extract entities from string
+*CloudmersiveNlpApiClient::LanguageDetectionApi* | [**language_detection_post**](docs/LanguageDetectionApi.md#language_detection_post) | **POST** /nlp/language/detect | Detect language of text
+*CloudmersiveNlpApiClient::ParseStringApi* | [**parse_string_post**](docs/ParseStringApi.md#parse_string_post) | **POST** /nlp/ParseString | Parse string to syntax tree
+*CloudmersiveNlpApiClient::PosTaggerJsonApi* | [**pos_tagger_json_post**](docs/PosTaggerJsonApi.md#pos_tagger_json_post) | **POST** /nlp/PosTaggerJson | Part-of-speech tag a string
+*CloudmersiveNlpApiClient::PosTaggerStringApi* | [**pos_tagger_string_post**](docs/PosTaggerStringApi.md#pos_tagger_string_post) | **POST** /nlp/PosTaggerString | Part-of-speech tag a string
+*CloudmersiveNlpApiClient::SentencesApi* | [**sentences_post**](docs/SentencesApi.md#sentences_post) | **POST** /nlp/get/sentences/string | Extract sentences from string
+*CloudmersiveNlpApiClient::SpellCheckApi* | [**spell_check_check_json**](docs/SpellCheckApi.md#spell_check_check_json) | **POST** /nlp/spellcheck/check/word/json | Spell check word
+*CloudmersiveNlpApiClient::SpellCheckApi* | [**spell_check_check_sentence_json**](docs/SpellCheckApi.md#spell_check_check_sentence_json) | **POST** /nlp/spellcheck/check/sentence/json | Check if sentence is spelled correctly
+*CloudmersiveNlpApiClient::SpellCheckApi* | [**spell_check_check_sentence_string**](docs/SpellCheckApi.md#spell_check_check_sentence_string) | **POST** /nlp/spellcheck/check/sentence/string | Spell check a sentence
+*CloudmersiveNlpApiClient::SpellCheckApi* | [**spell_check_correct**](docs/SpellCheckApi.md#spell_check_correct) | **POST** /nlp/spellcheck/correct/word/string | Find spelling corrections
+*CloudmersiveNlpApiClient::SpellCheckApi* | [**spell_check_correct_json**](docs/SpellCheckApi.md#spell_check_correct_json) | **POST** /nlp/spellcheck/correct/word/json | Find spelling corrections
+*CloudmersiveNlpApiClient::SpellCheckApi* | [**spell_check_post**](docs/SpellCheckApi.md#spell_check_post) | **POST** /nlp/spellcheck/check/word/string | Spell check a word
+*CloudmersiveNlpApiClient::WordsApi* | [**words_adjectives**](docs/WordsApi.md#words_adjectives) | **POST** /nlp/get/words/adjectives/string | Get adjectives in string
+*CloudmersiveNlpApiClient::WordsApi* | [**words_adverbs**](docs/WordsApi.md#words_adverbs) | **POST** /nlp/get/words/adverbs/string | Get adverbs in input string
+*CloudmersiveNlpApiClient::WordsApi* | [**words_get_words_json**](docs/WordsApi.md#words_get_words_json) | **POST** /nlp/get/words/json | Get words in input string (JSON)
+*CloudmersiveNlpApiClient::WordsApi* | [**words_get_words_string**](docs/WordsApi.md#words_get_words_string) | **POST** /nlp/get/words/string | Get words from string
+*CloudmersiveNlpApiClient::WordsApi* | [**words_nouns**](docs/WordsApi.md#words_nouns) | **POST** /nlp/get/words/nouns/string | Get nouns in string
+*CloudmersiveNlpApiClient::WordsApi* | [**words_post**](docs/WordsApi.md#words_post) | **POST** /nlp/get/words/verbs/string | Get the verbs in a string
+*CloudmersiveNlpApiClient::WordsApi* | [**words_pronouns**](docs/WordsApi.md#words_pronouns) | **POST** /nlp/get/words/pronouns/string | Returns all pronounts in string
+*CloudmersiveNlpApiClient::WordsApi* | [**words_proper_nouns**](docs/WordsApi.md#words_proper_nouns) | **POST** /nlp/get/words/properNouns/string | Get proper nouns in a string
+
+
+## Documentation for Models
+
+ - [CloudmersiveNlpApiClient::CheckJsonResponse](docs/CheckJsonResponse.md)
+ - [CloudmersiveNlpApiClient::CheckSentenceJsonResponse](docs/CheckSentenceJsonResponse.md)
+ - [CloudmersiveNlpApiClient::CorrectJsonResponse](docs/CorrectJsonResponse.md)
+ - [CloudmersiveNlpApiClient::CorrectWordInSentenceJsonResponse](docs/CorrectWordInSentenceJsonResponse.md)
+ - [CloudmersiveNlpApiClient::GetWordsJsonResponse](docs/GetWordsJsonResponse.md)
+ - [CloudmersiveNlpApiClient::LanguageDetectionResponse](docs/LanguageDetectionResponse.md)
+ - [CloudmersiveNlpApiClient::PosRequest](docs/PosRequest.md)
+ - [CloudmersiveNlpApiClient::PosResponse](docs/PosResponse.md)
+ - [CloudmersiveNlpApiClient::PosSentence](docs/PosSentence.md)
+ - [CloudmersiveNlpApiClient::PosTaggedWord](docs/PosTaggedWord.md)
+ - [CloudmersiveNlpApiClient::WordPosition](docs/WordPosition.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-nlp-api-client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+#
+=begin
+#nlpapi
+
+#The powerful Natural Language Processing APIs let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
+
+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-nlp-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudmersive-nlp-api-client"
+  s.version     = CloudmersiveNlpApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cloudmersive"]
+  s.email       = [""]
+  s.homepage    = "https://www.cloudmersive.com/nlp-api"
+  s.summary     = "The most powerful and cost-effective NLP AI APIs, continuously updated."
+  s.description = "The powerful Natural Language Processing APIs let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text."
+  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/CheckJsonResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveNlpApiClient::CheckJsonResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**correct** | **BOOLEAN** | True if spellected correctly, false otherwise | [optional] 
+
+

data/docs/CheckSentenceJsonResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveNlpApiClient::CheckSentenceJsonResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**incorrect_count** | **Integer** | Number of incorrect words | [optional] 
+**words** | [**Array<CorrectWordInSentenceJsonResponse>**](CorrectWordInSentenceJsonResponse.md) | Words in the sentence, both correct and incorrect | [optional] 
+
+

data/docs/CorrectJsonResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveNlpApiClient::CorrectJsonResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**correct** | **BOOLEAN** | True if the word is spelled correctly, false otherwise | [optional] 
+**suggestions** | **Array<String>** | Suggested spelling corrections | [optional] 
+
+

data/docs/CorrectWordInSentenceJsonResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveNlpApiClient::CorrectWordInSentenceJsonResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**word** | [**WordPosition**](WordPosition.md) | Position of the word | [optional] 
+**correct** | **BOOLEAN** | True if the word is spelled correctly, false otherwise | [optional] 
+**suggestions** | **Array<String>** | Suggested spelling improvements | [optional] 
+
+

data/docs/ExtractEntitiesStringApi.md

@@ -0,0 +1,63 @@
+# CloudmersiveNlpApiClient::ExtractEntitiesStringApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**extract_entities_string_post**](ExtractEntitiesStringApi.md#extract_entities_string_post) | **POST** /nlp/ExtractEntitiesString | Extract entities from string
+
+
+# **extract_entities_string_post**
+> String extract_entities_string_post(value)
+
+Extract entities from string
+
+Extract the named entitites from an input string.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-nlp-api-client'
+# setup authorization
+CloudmersiveNlpApiClient.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 = CloudmersiveNlpApiClient::ExtractEntitiesStringApi.new
+
+value = "value_example" # String | Input string
+
+
+begin
+  #Extract entities from string
+  result = api_instance.extract_entities_string_post(value)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling ExtractEntitiesStringApi->extract_entities_string_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| Input string | 
+
+### Return type
+
+**String**
+
+### 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/GetWordsJsonResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveNlpApiClient::GetWordsJsonResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**words** | [**Array<WordPosition>**](WordPosition.md) | Array of words | [optional] 
+
+

data/docs/LanguageDetectionApi.md

@@ -0,0 +1,63 @@
+# CloudmersiveNlpApiClient::LanguageDetectionApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**language_detection_post**](LanguageDetectionApi.md#language_detection_post) | **POST** /nlp/language/detect | Detect language of text
+
+
+# **language_detection_post**
+> LanguageDetectionResponse language_detection_post(text_to_detect)
+
+Detect language of text
+
+Automatically determine which language a text string is written in.  Supports Danish (DAN), German (DEU), English (ENG), French (FRA), Italian (ITA), Japanese (JPN), Korean (KOR), Dutch (NLD), Norwegian (NOR), Portuguese (POR), Russian (RUS), Spanish (SPA), Swedish (SWE), Chinese (ZHO).
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-nlp-api-client'
+# setup authorization
+CloudmersiveNlpApiClient.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 = CloudmersiveNlpApiClient::LanguageDetectionApi.new
+
+text_to_detect = "text_to_detect_example" # String | Text to detect language of
+
+
+begin
+  #Detect language of text
+  result = api_instance.language_detection_post(text_to_detect)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling LanguageDetectionApi->language_detection_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **text_to_detect** | **String**| Text to detect language of | 
+
+### Return type
+
+[**LanguageDetectionResponse**](LanguageDetectionResponse.md)
+
+### 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/LanguageDetectionResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveNlpApiClient::LanguageDetectionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the language detection operation was successful, false otherwise | [optional] 
+**detected_language_three_letter_code** | **String** | ISO 639 three letter language code | [optional] 
+**detected_language_full_name** | **String** | The full name (in English) of the detected language | [optional] 
+
+

data/docs/ParseStringApi.md

@@ -0,0 +1,63 @@
+# CloudmersiveNlpApiClient::ParseStringApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**parse_string_post**](ParseStringApi.md#parse_string_post) | **POST** /nlp/ParseString | Parse string to syntax tree
+
+
+# **parse_string_post**
+> String parse_string_post(input)
+
+Parse string to syntax tree
+
+Parses the input string into a Penn Treebank syntax tree
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-nlp-api-client'
+# setup authorization
+CloudmersiveNlpApiClient.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 = CloudmersiveNlpApiClient::ParseStringApi.new
+
+input = "input_example" # String | Input string
+
+
+begin
+  #Parse string to syntax tree
+  result = api_instance.parse_string_post(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling ParseStringApi->parse_string_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | **String**| Input string | 
+
+### Return type
+
+**String**
+
+### 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
+
+
+