cloudmersive-nlp-api-client 3.0.2 → 3.0.3

data/docs/CheckSentenceRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveNlpApiClient::CheckSentenceRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sentence** | **String** | Input sentence for spell check | [optional] 
+
+

data/docs/CheckSentenceResponse.md

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

data/docs/CheckWordRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveNlpApiClient::CheckWordRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**word** | **String** |  | [optional] 
+
+

data/docs/CheckWordResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveNlpApiClient::CheckWordResponse
+
+## 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/CorrectWordInSentence.md

@@ -0,0 +1,10 @@
+# CloudmersiveNlpApiClient::CorrectWordInSentence
+
+## 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/Entity.md

@@ -0,0 +1,9 @@
+# CloudmersiveNlpApiClient::Entity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** |  | [optional] 
+**entity_text** | **String** |  | [optional] 
+
+

data/docs/ExtractEntitiesApi.md

@@ -0,0 +1,63 @@
+# CloudmersiveNlpApiClient::ExtractEntitiesApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**extract_entities_post**](ExtractEntitiesApi.md#extract_entities_post) | **POST** /nlp-v2/extract-entities | Extract entities from string
+
+
+# **extract_entities_post**
+> ExtractEntitiesResponse extract_entities_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::ExtractEntitiesApi.new
+
+value = CloudmersiveNlpApiClient::ExtractEntitiesRequest.new # ExtractEntitiesRequest | Input string
+
+
+begin
+  #Extract entities from string
+  result = api_instance.extract_entities_post(value)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling ExtractEntitiesApi->extract_entities_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | [**ExtractEntitiesRequest**](ExtractEntitiesRequest.md)| Input string | 
+
+### Return type
+
+[**ExtractEntitiesResponse**](ExtractEntitiesResponse.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
+
+
+

data/docs/ExtractEntitiesRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveNlpApiClient::ExtractEntitiesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_string** | **String** | Input string to extract entities from | [optional] 
+
+

data/docs/ExtractEntitiesResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveNlpApiClient::ExtractEntitiesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**entities** | [**Array<Entity>**](Entity.md) |  | [optional] 
+
+

data/docs/GetWordsRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveNlpApiClient::GetWordsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_text** | **String** |  | [optional] 
+
+

data/docs/GetWordsResponse.md

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

data/docs/HateSpeechAnalysisRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveNlpApiClient::HateSpeechAnalysisRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_to_analyze** | **String** | Text to analyze | [optional] 
+
+

data/docs/HateSpeechAnalysisResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveNlpApiClient::HateSpeechAnalysisResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the profanity detection operation was successful, false otherwise | [optional] 
+**hate_speech_score_result** | **Float** | Hate speech classification score between 0.0 and 1.0 where scores closer to zero have a low probability of being hate speech language, while scores close to 1.0 have a high probability of being hate speech language.  Values above 0.8 have a very high probability of being hate speech. | [optional] 
+**sentence_count** | **Integer** | Number of sentences in input text | [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_get_language**](LanguageDetectionApi.md#language_detection_get_language) | **POST** /nlp-v2/language/detect | Detect language of text
+
+
+# **language_detection_get_language**
+> LanguageDetectionResponse language_detection_get_language(input)
+
+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
+
+input = CloudmersiveNlpApiClient::LanguageDetectionRequest.new # LanguageDetectionRequest | 
+
+
+begin
+  #Detect language of text
+  result = api_instance.language_detection_get_language(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling LanguageDetectionApi->language_detection_get_language: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**LanguageDetectionRequest**](LanguageDetectionRequest.md)|  | 
+
+### 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
+
+
+

data/docs/LanguageDetectionRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveNlpApiClient::LanguageDetectionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_to_detect** | **String** | Text to detect the language of | [optional] 
+
+

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/LanguageTranslationApi.md

@@ -0,0 +1,338 @@
+# CloudmersiveNlpApiClient::LanguageTranslationApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**language_translation_translate_deu_to_eng**](LanguageTranslationApi.md#language_translation_translate_deu_to_eng) | **POST** /nlp-v2/translate/language/deu/to/eng | Translate German to English text with Deep Learning AI
+[**language_translation_translate_eng_to_deu**](LanguageTranslationApi.md#language_translation_translate_eng_to_deu) | **POST** /nlp-v2/translate/language/eng/to/deu | Translate English to German text with Deep Learning AI
+[**language_translation_translate_eng_to_fra**](LanguageTranslationApi.md#language_translation_translate_eng_to_fra) | **POST** /nlp-v2/translate/language/eng/to/fra | Translate English to French text with Deep Learning AI
+[**language_translation_translate_eng_to_rus**](LanguageTranslationApi.md#language_translation_translate_eng_to_rus) | **POST** /nlp-v2/translate/language/eng/to/rus | Translate English to Russian text with Deep Learning AI
+[**language_translation_translate_fra_to_eng**](LanguageTranslationApi.md#language_translation_translate_fra_to_eng) | **POST** /nlp-v2/translate/language/fra/to/eng | Translate French to English text with Deep Learning AI
+[**language_translation_translate_rus_to_eng**](LanguageTranslationApi.md#language_translation_translate_rus_to_eng) | **POST** /nlp-v2/translate/language/rus/to/eng | Translate Russian to English text with Deep Learning AI
+
+
+# **language_translation_translate_deu_to_eng**
+> LanguageTranslationResponse language_translation_translate_deu_to_eng(input)
+
+Translate German to English text with Deep Learning AI
+
+Automatically translates input text in German to output text in English using advanced Deep Learning and Neural NLP.  Consumes 1-2 API calls per input sentence.
+
+### 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::LanguageTranslationApi.new
+
+input = CloudmersiveNlpApiClient::LanguageTranslationRequest.new # LanguageTranslationRequest | Input translation request
+
+
+begin
+  #Translate German to English text with Deep Learning AI
+  result = api_instance.language_translation_translate_deu_to_eng(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling LanguageTranslationApi->language_translation_translate_deu_to_eng: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**LanguageTranslationRequest**](LanguageTranslationRequest.md)| Input translation request | 
+
+### Return type
+
+[**LanguageTranslationResponse**](LanguageTranslationResponse.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
+
+
+
+# **language_translation_translate_eng_to_deu**
+> LanguageTranslationResponse language_translation_translate_eng_to_deu(input)
+
+Translate English to German text with Deep Learning AI
+
+Automatically translates input text in English to output text in German using advanced Deep Learning and Neural NLP.  Consumes 1-2 API calls per input sentence.
+
+### 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::LanguageTranslationApi.new
+
+input = CloudmersiveNlpApiClient::LanguageTranslationRequest.new # LanguageTranslationRequest | Input translation request
+
+
+begin
+  #Translate English to German text with Deep Learning AI
+  result = api_instance.language_translation_translate_eng_to_deu(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling LanguageTranslationApi->language_translation_translate_eng_to_deu: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**LanguageTranslationRequest**](LanguageTranslationRequest.md)| Input translation request | 
+
+### Return type
+
+[**LanguageTranslationResponse**](LanguageTranslationResponse.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
+
+
+
+# **language_translation_translate_eng_to_fra**
+> LanguageTranslationResponse language_translation_translate_eng_to_fra(input)
+
+Translate English to French text with Deep Learning AI
+
+Automatically translates input text in English to output text in French using advanced Deep Learning and Neural NLP.  Consumes 1-2 API calls per input sentence.
+
+### 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::LanguageTranslationApi.new
+
+input = CloudmersiveNlpApiClient::LanguageTranslationRequest.new # LanguageTranslationRequest | Input translation request
+
+
+begin
+  #Translate English to French text with Deep Learning AI
+  result = api_instance.language_translation_translate_eng_to_fra(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling LanguageTranslationApi->language_translation_translate_eng_to_fra: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**LanguageTranslationRequest**](LanguageTranslationRequest.md)| Input translation request | 
+
+### Return type
+
+[**LanguageTranslationResponse**](LanguageTranslationResponse.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
+
+
+
+# **language_translation_translate_eng_to_rus**
+> LanguageTranslationResponse language_translation_translate_eng_to_rus(input)
+
+Translate English to Russian text with Deep Learning AI
+
+Automatically translates input text in English to output text in Russian using advanced Deep Learning and Neural NLP.  Consumes 1-2 API calls per input sentence.
+
+### 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::LanguageTranslationApi.new
+
+input = CloudmersiveNlpApiClient::LanguageTranslationRequest.new # LanguageTranslationRequest | Input translation request
+
+
+begin
+  #Translate English to Russian text with Deep Learning AI
+  result = api_instance.language_translation_translate_eng_to_rus(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling LanguageTranslationApi->language_translation_translate_eng_to_rus: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**LanguageTranslationRequest**](LanguageTranslationRequest.md)| Input translation request | 
+
+### Return type
+
+[**LanguageTranslationResponse**](LanguageTranslationResponse.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
+
+
+
+# **language_translation_translate_fra_to_eng**
+> LanguageTranslationResponse language_translation_translate_fra_to_eng(input)
+
+Translate French to English text with Deep Learning AI
+
+Automatically translates input text in French to output text in English using advanced Deep Learning and Neural NLP.  Consumes 1-2 API calls per input sentence.
+
+### 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::LanguageTranslationApi.new
+
+input = CloudmersiveNlpApiClient::LanguageTranslationRequest.new # LanguageTranslationRequest | Input translation request
+
+
+begin
+  #Translate French to English text with Deep Learning AI
+  result = api_instance.language_translation_translate_fra_to_eng(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling LanguageTranslationApi->language_translation_translate_fra_to_eng: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**LanguageTranslationRequest**](LanguageTranslationRequest.md)| Input translation request | 
+
+### Return type
+
+[**LanguageTranslationResponse**](LanguageTranslationResponse.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
+
+
+
+# **language_translation_translate_rus_to_eng**
+> LanguageTranslationResponse language_translation_translate_rus_to_eng(input)
+
+Translate Russian to English text with Deep Learning AI
+
+Automatically translates input text in Russian to output text in English using advanced Deep Learning and Neural NLP.  Consumes 1-2 API calls per input sentence.
+
+### 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::LanguageTranslationApi.new
+
+input = CloudmersiveNlpApiClient::LanguageTranslationRequest.new # LanguageTranslationRequest | Input translation request
+
+
+begin
+  #Translate Russian to English text with Deep Learning AI
+  result = api_instance.language_translation_translate_rus_to_eng(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling LanguageTranslationApi->language_translation_translate_rus_to_eng: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**LanguageTranslationRequest**](LanguageTranslationRequest.md)| Input translation request | 
+
+### Return type
+
+[**LanguageTranslationResponse**](LanguageTranslationResponse.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
+
+
+