cloudmersive-nlp-api-client 3.0.2 → 3.0.3

data/docs/ProfanityAnalysisRequest.md

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

data/docs/ProfanityAnalysisResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveNlpApiClient::ProfanityAnalysisResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the profanity detection operation was successful, false otherwise | [optional] 
+**profanity_score_result** | **Float** | Profanity classification score between 0.0 and 1.0 where scores closer to zero have a low probability of being profane or contain obscene language, while scores close to 1.0 have a high probability of being profane or containing obscene language.  Values above 0.8 have a very high probability of being profane. | [optional] 
+**sentence_count** | **Integer** | Number of sentences in input text | [optional] 
+
+

data/docs/RephraseApi.md

@@ -0,0 +1,63 @@
+# CloudmersiveNlpApiClient::RephraseApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**rephrase_english_rephrase_sentence_by_sentence**](RephraseApi.md#rephrase_english_rephrase_sentence_by_sentence) | **POST** /nlp-v2/rephrase/rephrase/eng/by-sentence | Rephrase, paraphrase English text sentence-by-sentence using Deep Learning AI
+
+
+# **rephrase_english_rephrase_sentence_by_sentence**
+> RephraseResponse rephrase_english_rephrase_sentence_by_sentence(input)
+
+Rephrase, paraphrase English text sentence-by-sentence using Deep Learning AI
+
+Automatically rephrases or paraphrases input text in English sentence by sentence using advanced Deep Learning and Neural NLP.  Creates multiple reprhasing candidates per input sentence, from 1 to 10 possible rephrasings of the original sentence.  Seeks to preserve original semantic meaning in rephrased output candidates.  Consumes 1-2 API calls per output rephrasing option generated, per 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::RephraseApi.new
+
+input = CloudmersiveNlpApiClient::RephraseRequest.new # RephraseRequest | Input rephrase request
+
+
+begin
+  #Rephrase, paraphrase English text sentence-by-sentence using Deep Learning AI
+  result = api_instance.rephrase_english_rephrase_sentence_by_sentence(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling RephraseApi->rephrase_english_rephrase_sentence_by_sentence: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**RephraseRequest**](RephraseRequest.md)| Input rephrase request | 
+
+### Return type
+
+[**RephraseResponse**](RephraseResponse.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/RephraseRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveNlpApiClient::RephraseRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_to_translate** | **String** | Text to rephrase | [optional] 
+**target_rephrasing_count** | **Integer** | The number of rephrasing output options you would like per sentence; possible values are 1 to 10.  Default is 2. | [optional] 
+
+

data/docs/RephraseResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveNlpApiClient::RephraseResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the language detection operation was successful, false otherwise | [optional] 
+**rephrased_results** | [**Array<RephrasedSentence>**](RephrasedSentence.md) | Results of the rephrasing, paraphrasing operation, in the order of the input sentences | [optional] 
+**sentence_count** | **Integer** | Number of sentences in input text | [optional] 
+
+

data/docs/RephrasedSentence.md

@@ -0,0 +1,10 @@
+# CloudmersiveNlpApiClient::RephrasedSentence
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sentence_index** | **Integer** | Index of the sentence, 1-based, ordered | [optional] 
+**original_sentence_text** | **String** | Original input sentence text | [optional] 
+**rephrasings** | [**Array<RephrasedSentenceOption>**](RephrasedSentenceOption.md) | Rephrasing text options, candidates of the original input sentence, in order - with best candidate first | [optional] 
+
+

data/docs/RephrasedSentenceOption.md

@@ -0,0 +1,9 @@
+# CloudmersiveNlpApiClient::RephrasedSentenceOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rephrased_option_index** | **Integer** | Ordered index of the rephrasing option, 1-based, with 1 being the best option | [optional] 
+**rephrased_sentence_text** | **String** | One sentence of output rephrased text of original input sentence | [optional] 
+
+

data/docs/SegmentationApi.md

@@ -0,0 +1,118 @@
+# CloudmersiveNlpApiClient::SegmentationApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**segmentation_get_sentences**](SegmentationApi.md#segmentation_get_sentences) | **POST** /nlp-v2/segmentation/sentences | Extract sentences from string
+[**segmentation_get_words**](SegmentationApi.md#segmentation_get_words) | **POST** /nlp-v2/segmentation/words | Get words in input string
+
+
+# **segmentation_get_sentences**
+> SentenceSegmentationResponse segmentation_get_sentences(input)
+
+Extract sentences from string
+
+Segment an input string into separate sentences, output result as a 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::SegmentationApi.new
+
+input = CloudmersiveNlpApiClient::SentenceSegmentationRequest.new # SentenceSegmentationRequest | Input string
+
+
+begin
+  #Extract sentences from string
+  result = api_instance.segmentation_get_sentences(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling SegmentationApi->segmentation_get_sentences: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**SentenceSegmentationRequest**](SentenceSegmentationRequest.md)| Input string | 
+
+### Return type
+
+[**SentenceSegmentationResponse**](SentenceSegmentationResponse.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
+
+
+
+# **segmentation_get_words**
+> GetWordsResponse segmentation_get_words(input)
+
+Get words in input string
+
+Get the component words in 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::SegmentationApi.new
+
+input = CloudmersiveNlpApiClient::GetWordsRequest.new # GetWordsRequest | String to process
+
+
+begin
+  #Get words in input string
+  result = api_instance.segmentation_get_words(input)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling SegmentationApi->segmentation_get_words: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**GetWordsRequest**](GetWordsRequest.md)| String to process | 
+
+### Return type
+
+[**GetWordsResponse**](GetWordsResponse.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/SentenceSegmentationRequest.md

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

data/docs/SentenceSegmentationResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveNlpApiClient::SentenceSegmentationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** |  | [optional] 
+**sentences** | **Array<String>** |  | [optional] 
+**sentence_count** | **Integer** |  | [optional] 
+
+

data/docs/SentimentAnalysisRequest.md

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

data/docs/SentimentAnalysisResponse.md

@@ -0,0 +1,11 @@
+# CloudmersiveNlpApiClient::SentimentAnalysisResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the sentiment analysis operation was successful, false otherwise | [optional] 
+**sentiment_classification_result** | **String** | Classification of input text into a sentiment classification; possible values are \"Positive\", \"Negative\" or \"Neutral\" | [optional] 
+**sentiment_score_result** | **Float** | Sentiment classification score between -1.0 and +1.0 where scores less than 0 are negative sentiment, scores greater than 0 are positive sentiment and scores close to 0 are neutral.  The greater the value deviates from 0.0 the stronger the sentiment, with +1.0 and -1.0 being maximum positive and negative sentiment, respectively. | [optional] 
+**sentence_count** | **Integer** | Number of sentences in input text | [optional] 
+
+

data/docs/SimilarityAnalysisRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveNlpApiClient::SimilarityAnalysisRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_to_analyze1** | **String** | First text to analyze | [optional] 
+**text_to_analyze2** | **String** | Second text to analyze | [optional] 
+
+

data/docs/SimilarityAnalysisResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveNlpApiClient::SimilarityAnalysisResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the similarity analysis operation was successful, false otherwise | [optional] 
+**similarity_score_result** | **Float** | Similarity score between 0.0 and 1.0 where scores closer to zero have a low probability of semantic similarity, while scores close to 1.0 have a high probability of semantic similarity. | [optional] 
+**sentence_count** | **Integer** | Number of sentences in input text | [optional] 
+
+

data/docs/SpellcheckApi.md

@@ -0,0 +1,118 @@
+# CloudmersiveNlpApiClient::SpellcheckApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**spellcheck_check_sentence**](SpellcheckApi.md#spellcheck_check_sentence) | **POST** /nlp-v2/spellcheck/check/sentence | Check if sentence is spelled correctly
+[**spellcheck_correct_json**](SpellcheckApi.md#spellcheck_correct_json) | **POST** /nlp-v2/spellcheck/check/word | Find spelling corrections
+
+
+# **spellcheck_check_sentence**
+> CheckSentenceResponse spellcheck_check_sentence(value)
+
+Check if sentence is spelled correctly
+
+Checks whether the sentence is spelled correctly and returns the result as JSON
+
+### 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::SpellcheckApi.new
+
+value = CloudmersiveNlpApiClient::CheckSentenceRequest.new # CheckSentenceRequest | Input sentence
+
+
+begin
+  #Check if sentence is spelled correctly
+  result = api_instance.spellcheck_check_sentence(value)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling SpellcheckApi->spellcheck_check_sentence: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | [**CheckSentenceRequest**](CheckSentenceRequest.md)| Input sentence | 
+
+### Return type
+
+[**CheckSentenceResponse**](CheckSentenceResponse.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
+
+
+
+# **spellcheck_correct_json**
+> CheckWordResponse spellcheck_correct_json(value)
+
+Find spelling corrections
+
+Find spelling correction suggestions and return result as JSON
+
+### 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::SpellcheckApi.new
+
+value = CloudmersiveNlpApiClient::CheckWordRequest.new # CheckWordRequest | Input string
+
+
+begin
+  #Find spelling corrections
+  result = api_instance.spellcheck_correct_json(value)
+  p result
+rescue CloudmersiveNlpApiClient::ApiError => e
+  puts "Exception when calling SpellcheckApi->spellcheck_correct_json: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | [**CheckWordRequest**](CheckWordRequest.md)| Input string | 
+
+### Return type
+
+[**CheckWordResponse**](CheckWordResponse.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/SubjectivityAnalysisRequest.md

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

data/docs/SubjectivityAnalysisResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveNlpApiClient::SubjectivityAnalysisResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the subjectivity analysis operation was successful, false otherwise | [optional] 
+**subjectivity_score_result** | **Float** | Subjectivity vs. objectivity classification score between 0.0 and 1.0 where scores closer to zero have a high probability of objectivity, while scores close to 1.0 have a high probability of subjectivity. | [optional] 
+**sentence_count** | **Integer** | Number of sentences in input text | [optional] 
+
+