cloudmersive-nlp-api-client 3.0.2 → 3.0.3

data/docs/WordPosition.md

@@ -0,0 +1,11 @@
+# CloudmersiveNlpApiClient::WordPosition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**word** | **String** | Word as a string | [optional] 
+**word_index** | **Integer** | Zero-based index of the word; first word has index 0, second word has index 1 and so on | [optional] 
+**start_position** | **Integer** | Zero-based character offset at which the word begins in the input string | [optional] 
+**end_position** | **Integer** | Zero-based character offset at which the word ends in the input string | [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-nlp-api-client.rb

@@ -0,0 +1,85 @@
+=begin
+#nlpapiv2
+
+#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: 2.4.14
+
+=end
+
+# Common files
+require 'cloudmersive-nlp-api-client/api_client'
+require 'cloudmersive-nlp-api-client/api_error'
+require 'cloudmersive-nlp-api-client/version'
+require 'cloudmersive-nlp-api-client/configuration'
+
+# Models
+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/hate_speech_analysis_request'
+require 'cloudmersive-nlp-api-client/models/hate_speech_analysis_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/language_translation_request'
+require 'cloudmersive-nlp-api-client/models/language_translation_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/profanity_analysis_request'
+require 'cloudmersive-nlp-api-client/models/profanity_analysis_response'
+require 'cloudmersive-nlp-api-client/models/rephrase_request'
+require 'cloudmersive-nlp-api-client/models/rephrase_response'
+require 'cloudmersive-nlp-api-client/models/rephrased_sentence'
+require 'cloudmersive-nlp-api-client/models/rephrased_sentence_option'
+require 'cloudmersive-nlp-api-client/models/sentence_segmentation_request'
+require 'cloudmersive-nlp-api-client/models/sentence_segmentation_response'
+require 'cloudmersive-nlp-api-client/models/sentiment_analysis_request'
+require 'cloudmersive-nlp-api-client/models/sentiment_analysis_response'
+require 'cloudmersive-nlp-api-client/models/similarity_analysis_request'
+require 'cloudmersive-nlp-api-client/models/similarity_analysis_response'
+require 'cloudmersive-nlp-api-client/models/subjectivity_analysis_request'
+require 'cloudmersive-nlp-api-client/models/subjectivity_analysis_response'
+require 'cloudmersive-nlp-api-client/models/word_position'
+
+# APIs
+require 'cloudmersive-nlp-api-client/api/analytics_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/language_translation_api'
+require 'cloudmersive-nlp-api-client/api/parse_api'
+require 'cloudmersive-nlp-api-client/api/pos_tagger_api'
+require 'cloudmersive-nlp-api-client/api/rephrase_api'
+require 'cloudmersive-nlp-api-client/api/segmentation_api'
+require 'cloudmersive-nlp-api-client/api/spellcheck_api'
+
+module CloudmersiveNlpApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   CloudmersiveNlpApiClient.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-nlp-api-client/api/analytics_api.rb

@@ -0,0 +1,293 @@
+=begin
+#nlpapiv2
+
+#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: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveNlpApiClient
+  class AnalyticsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Perform Hate Speech Analysis and Detection on Text
+    # Analyze input text using advanced Hate Speech Analysis to determine if the input contains hate speech language.  Supports English language input.  Consumes 1-2 API calls per sentence.
+    # @param input Input hate speech analysis request
+    # @param [Hash] opts the optional parameters
+    # @return [HateSpeechAnalysisResponse]
+    def analytics_hate_speech(input, opts = {})
+      data, _status_code, _headers = analytics_hate_speech_with_http_info(input, opts)
+      data
+    end
+
+    # Perform Hate Speech Analysis and Detection on Text
+    # Analyze input text using advanced Hate Speech Analysis to determine if the input contains hate speech language.  Supports English language input.  Consumes 1-2 API calls per sentence.
+    # @param input Input hate speech analysis request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(HateSpeechAnalysisResponse, Fixnum, Hash)>] HateSpeechAnalysisResponse data, response status code and response headers
+    def analytics_hate_speech_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsApi.analytics_hate_speech ...'
+      end
+      # 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 AnalyticsApi.analytics_hate_speech"
+      end
+      # resource path
+      local_var_path = '/nlp-v2/analytics/hate-speech'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      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,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'HateSpeechAnalysisResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#analytics_hate_speech\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Perform Profanity and Obscene Language Analysis and Detection on Text
+    # Analyze input text using advanced Profanity and Obscene Language Analysis to determine if the input contains profane language.  Supports English language input.  Consumes 1-2 API calls per sentence.
+    # @param input Input profanity analysis request
+    # @param [Hash] opts the optional parameters
+    # @return [ProfanityAnalysisResponse]
+    def analytics_profanity(input, opts = {})
+      data, _status_code, _headers = analytics_profanity_with_http_info(input, opts)
+      data
+    end
+
+    # Perform Profanity and Obscene Language Analysis and Detection on Text
+    # Analyze input text using advanced Profanity and Obscene Language Analysis to determine if the input contains profane language.  Supports English language input.  Consumes 1-2 API calls per sentence.
+    # @param input Input profanity analysis request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProfanityAnalysisResponse, Fixnum, Hash)>] ProfanityAnalysisResponse data, response status code and response headers
+    def analytics_profanity_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsApi.analytics_profanity ...'
+      end
+      # 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 AnalyticsApi.analytics_profanity"
+      end
+      # resource path
+      local_var_path = '/nlp-v2/analytics/profanity'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      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,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ProfanityAnalysisResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#analytics_profanity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Perform Sentiment Analysis and Classification on Text
+    # Analyze input text using advanced Sentiment Analysis to determine if the input is positive, negative, or neutral.  Supports English language input.  Consumes 1-2 API calls per sentence.
+    # @param input Input sentiment analysis request
+    # @param [Hash] opts the optional parameters
+    # @return [SentimentAnalysisResponse]
+    def analytics_sentiment(input, opts = {})
+      data, _status_code, _headers = analytics_sentiment_with_http_info(input, opts)
+      data
+    end
+
+    # Perform Sentiment Analysis and Classification on Text
+    # Analyze input text using advanced Sentiment Analysis to determine if the input is positive, negative, or neutral.  Supports English language input.  Consumes 1-2 API calls per sentence.
+    # @param input Input sentiment analysis request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SentimentAnalysisResponse, Fixnum, Hash)>] SentimentAnalysisResponse data, response status code and response headers
+    def analytics_sentiment_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsApi.analytics_sentiment ...'
+      end
+      # 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 AnalyticsApi.analytics_sentiment"
+      end
+      # resource path
+      local_var_path = '/nlp-v2/analytics/sentiment'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      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,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SentimentAnalysisResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#analytics_sentiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Perform Semantic Similarity Comparison of Two Strings
+    # Analyze two input text strings, typically sentences, and determine the semantic similarity of each.  Semantic similarity refers to the degree to which two sentences mean the same thing semantically.  Uses advanced Deep Learning to perform the semantic similarity comparison.  Consumes 1-2 API calls per sentence.
+    # @param input Input similarity analysis request
+    # @param [Hash] opts the optional parameters
+    # @return [SimilarityAnalysisResponse]
+    def analytics_similarity(input, opts = {})
+      data, _status_code, _headers = analytics_similarity_with_http_info(input, opts)
+      data
+    end
+
+    # Perform Semantic Similarity Comparison of Two Strings
+    # Analyze two input text strings, typically sentences, and determine the semantic similarity of each.  Semantic similarity refers to the degree to which two sentences mean the same thing semantically.  Uses advanced Deep Learning to perform the semantic similarity comparison.  Consumes 1-2 API calls per sentence.
+    # @param input Input similarity analysis request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SimilarityAnalysisResponse, Fixnum, Hash)>] SimilarityAnalysisResponse data, response status code and response headers
+    def analytics_similarity_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsApi.analytics_similarity ...'
+      end
+      # 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 AnalyticsApi.analytics_similarity"
+      end
+      # resource path
+      local_var_path = '/nlp-v2/analytics/similarity'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      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,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SimilarityAnalysisResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#analytics_similarity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Perform Subjectivity and Objectivity Analysis on Text
+    # Analyze input text using advanced Subjectivity and Objectivity Language Analysis to determine if the input text is objective or subjective, and how much.  Supports English language input.  Consumes 1-2 API calls per sentence.
+    # @param input Input subjectivity analysis request
+    # @param [Hash] opts the optional parameters
+    # @return [SubjectivityAnalysisResponse]
+    def analytics_subjectivity(input, opts = {})
+      data, _status_code, _headers = analytics_subjectivity_with_http_info(input, opts)
+      data
+    end
+
+    # Perform Subjectivity and Objectivity Analysis on Text
+    # Analyze input text using advanced Subjectivity and Objectivity Language Analysis to determine if the input text is objective or subjective, and how much.  Supports English language input.  Consumes 1-2 API calls per sentence.
+    # @param input Input subjectivity analysis request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SubjectivityAnalysisResponse, Fixnum, Hash)>] SubjectivityAnalysisResponse data, response status code and response headers
+    def analytics_subjectivity_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsApi.analytics_subjectivity ...'
+      end
+      # 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 AnalyticsApi.analytics_subjectivity"
+      end
+      # resource path
+      local_var_path = '/nlp-v2/analytics/subjectivity'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      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,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SubjectivityAnalysisResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#analytics_subjectivity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+=begin
+#nlpapiv2
+
+#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: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveNlpApiClient
+  class ExtractEntitiesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Extract entities from string
+    # Extract the named entitites from an input string.
+    # @param value Input string
+    # @param [Hash] opts the optional parameters
+    # @return [ExtractEntitiesResponse]
+    def extract_entities_post(value, opts = {})
+      data, _status_code, _headers = extract_entities_post_with_http_info(value, opts)
+      data
+    end
+
+    # Extract entities from string
+    # Extract the named entitites from an input string.
+    # @param value Input string
+    # @param [Hash] opts the optional parameters
+    # @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: 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 ExtractEntitiesApi.extract_entities_post"
+      end
+      # resource path
+      local_var_path = '/nlp-v2/extract-entities'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      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 => 'ExtractEntitiesResponse')
+      if @api_client.config.debugging
+        @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
+  end
+end