cloudmersive-nlp-api-client 1.2.9 → 2.0.1

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, text/json, application/xml, text/xml
+
+
+
+# **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, text/json, application/xml, text/xml
+
+
+

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/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, text/json, application/xml, text/xml
+
+
+
+# **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, text/json, application/xml, text/xml
+
+
+

data/lib/cloudmersive-nlp-api-client.rb

@@ -1,12 +1,12 @@
 =begin
-#nlpapi
+#nlpapiv2
 
-#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.
+#The powerful Natural Language Processing APIs (v2) 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
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -17,27 +17,35 @@ require 'cloudmersive-nlp-api-client/version'
 require 'cloudmersive-nlp-api-client/configuration'
 
 # Models
-require 'cloudmersive-nlp-api-client/models/check_json_response'
-require 'cloudmersive-nlp-api-client/models/check_sentence_json_response'
-require 'cloudmersive-nlp-api-client/models/correct_json_response'
-require 'cloudmersive-nlp-api-client/models/correct_word_in_sentence_json_response'
-require 'cloudmersive-nlp-api-client/models/get_words_json_response'
+require 'cloudmersive-nlp-api-client/models/check_sentence_request'
+require 'cloudmersive-nlp-api-client/models/check_sentence_response'
+require 'cloudmersive-nlp-api-client/models/check_word_request'
+require 'cloudmersive-nlp-api-client/models/check_word_response'
+require 'cloudmersive-nlp-api-client/models/correct_word_in_sentence'
+require 'cloudmersive-nlp-api-client/models/entity'
+require 'cloudmersive-nlp-api-client/models/extract_entities_request'
+require 'cloudmersive-nlp-api-client/models/extract_entities_response'
+require 'cloudmersive-nlp-api-client/models/get_words_request'
+require 'cloudmersive-nlp-api-client/models/get_words_response'
+require 'cloudmersive-nlp-api-client/models/language_detection_request'
 require 'cloudmersive-nlp-api-client/models/language_detection_response'
+require 'cloudmersive-nlp-api-client/models/parse_request'
+require 'cloudmersive-nlp-api-client/models/parse_response'
 require 'cloudmersive-nlp-api-client/models/pos_request'
 require 'cloudmersive-nlp-api-client/models/pos_response'
 require 'cloudmersive-nlp-api-client/models/pos_sentence'
 require 'cloudmersive-nlp-api-client/models/pos_tagged_word'
+require 'cloudmersive-nlp-api-client/models/sentence_segmentation_request'
+require 'cloudmersive-nlp-api-client/models/sentence_segmentation_response'
 require 'cloudmersive-nlp-api-client/models/word_position'
 
 # APIs
-require 'cloudmersive-nlp-api-client/api/extract_entities_string_api'
+require 'cloudmersive-nlp-api-client/api/extract_entities_api'
 require 'cloudmersive-nlp-api-client/api/language_detection_api'
-require 'cloudmersive-nlp-api-client/api/parse_string_api'
-require 'cloudmersive-nlp-api-client/api/pos_tagger_json_api'
-require 'cloudmersive-nlp-api-client/api/pos_tagger_string_api'
-require 'cloudmersive-nlp-api-client/api/sentences_api'
-require 'cloudmersive-nlp-api-client/api/spell_check_api'
-require 'cloudmersive-nlp-api-client/api/words_api'
+require 'cloudmersive-nlp-api-client/api/parse_api'
+require 'cloudmersive-nlp-api-client/api/pos_tagger_api'
+require 'cloudmersive-nlp-api-client/api/segmentation_api'
+require 'cloudmersive-nlp-api-client/api/spellcheck_api'
 
 module CloudmersiveNlpApiClient
   class << self

data/lib/cloudmersive-nlp-api-client/api/{extract_entities_string_api.rb → extract_entities_api.rb}

@@ -1,19 +1,19 @@
 =begin
-#nlpapi
+#nlpapiv2
 
-#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.
+#The powerful Natural Language Processing APIs (v2) 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
+Swagger Codegen version: 2.3.1
 
 =end
 
 require "uri"
 
 module CloudmersiveNlpApiClient
-  class ExtractEntitiesStringApi
+  class ExtractEntitiesApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
@@ -24,9 +24,9 @@ module CloudmersiveNlpApiClient
     # Extract the named entitites from an input string.
     # @param value Input string
     # @param [Hash] opts the optional parameters
-    # @return [String]
-    def extract_entities_string_post(value, opts = {})
-      data, _status_code, _headers = extract_entities_string_post_with_http_info(value, opts)
+    # @return [ExtractEntitiesResponse]
+    def extract_entities_post(value, opts = {})
+      data, _status_code, _headers = extract_entities_post_with_http_info(value, opts)
       return data
     end
 
@@ -34,17 +34,17 @@ module CloudmersiveNlpApiClient
     # Extract the named entitites from an input string.
     # @param value Input string
     # @param [Hash] opts the optional parameters
-    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
-    def extract_entities_string_post_with_http_info(value, opts = {})
+    # @return [Array<(ExtractEntitiesResponse, Fixnum, Hash)>] ExtractEntitiesResponse data, response status code and response headers
+    def extract_entities_post_with_http_info(value, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ExtractEntitiesStringApi.extract_entities_string_post ..."
+        @api_client.config.logger.debug "Calling API: ExtractEntitiesApi.extract_entities_post ..."
       end
       # verify the required parameter 'value' is set
       if @api_client.config.client_side_validation && value.nil?
-        fail ArgumentError, "Missing the required parameter 'value' when calling ExtractEntitiesStringApi.extract_entities_string_post"
+        fail ArgumentError, "Missing the required parameter 'value' when calling ExtractEntitiesApi.extract_entities_post"
       end
       # resource path
-      local_var_path = "/nlp/ExtractEntitiesString"
+      local_var_path = "/nlp-v2/extract-entities"
 
       # query parameters
       query_params = {}
@@ -68,9 +68,9 @@ module CloudmersiveNlpApiClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'String')
+        :return_type => 'ExtractEntitiesResponse')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ExtractEntitiesStringApi#extract_entities_string_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ExtractEntitiesApi#extract_entities_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/cloudmersive-nlp-api-client/api/language_detection_api.rb

@@ -1,12 +1,12 @@
 =begin
-#nlpapi
+#nlpapiv2
 
-#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.
+#The powerful Natural Language Processing APIs (v2) 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
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -22,29 +22,29 @@ module CloudmersiveNlpApiClient
 
     # 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).
-    # @param text_to_detect Text to detect language of
+    # @param input 
     # @param [Hash] opts the optional parameters
     # @return [LanguageDetectionResponse]
-    def language_detection_post(text_to_detect, opts = {})
-      data, _status_code, _headers = language_detection_post_with_http_info(text_to_detect, opts)
+    def language_detection_get_language(input, opts = {})
+      data, _status_code, _headers = language_detection_get_language_with_http_info(input, opts)
       return data
     end
 
     # 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).
-    # @param text_to_detect Text to detect language of
+    # @param input 
     # @param [Hash] opts the optional parameters
     # @return [Array<(LanguageDetectionResponse, Fixnum, Hash)>] LanguageDetectionResponse data, response status code and response headers
-    def language_detection_post_with_http_info(text_to_detect, opts = {})
+    def language_detection_get_language_with_http_info(input, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: LanguageDetectionApi.language_detection_post ..."
+        @api_client.config.logger.debug "Calling API: LanguageDetectionApi.language_detection_get_language ..."
       end
-      # verify the required parameter 'text_to_detect' is set
-      if @api_client.config.client_side_validation && text_to_detect.nil?
-        fail ArgumentError, "Missing the required parameter 'text_to_detect' when calling LanguageDetectionApi.language_detection_post"
+      # verify the required parameter 'input' is set
+      if @api_client.config.client_side_validation && input.nil?
+        fail ArgumentError, "Missing the required parameter 'input' when calling LanguageDetectionApi.language_detection_get_language"
       end
       # resource path
-      local_var_path = "/nlp/language/detect"
+      local_var_path = "/nlp-v2/language/detect"
 
       # query parameters
       query_params = {}
@@ -60,7 +60,7 @@ module CloudmersiveNlpApiClient
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(text_to_detect)
+      post_body = @api_client.object_to_http_body(input)
       auth_names = ['Apikey']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -70,7 +70,7 @@ module CloudmersiveNlpApiClient
         :auth_names => auth_names,
         :return_type => 'LanguageDetectionResponse')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: LanguageDetectionApi#language_detection_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: LanguageDetectionApi#language_detection_get_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end