cloudmersive-nlp-api-client

cloudmersive-nlp-api-client

CloudmersiveNlpApiClient - JavaScript client for cloudmersive-nlp-api-client 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. Cloudmersive NLP API provides advanced machine learning-based natural language processing to detect language, sentiment, meaning and intent of text content.

• API version: v1
• Package version: 2.1.1

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cloudmersive-nlp-api-client --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your cloudmersive-nlp-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('cloudmersive-nlp-api-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CloudmersiveNlpApiClient = require('cloudmersive-nlp-api-client');

var defaultClient = CloudmersiveNlpApiClient.ApiClient.instance;

// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix['Apikey'] = "Token"

var api = new CloudmersiveNlpApiClient.AnalyticsApi()

var input = new CloudmersiveNlpApiClient.HateSpeechAnalysisRequest(); // {HateSpeechAnalysisRequest} Input hate speech analysis request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.analyticsHateSpeech(input, callback);

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class	Method	HTTP request	Description
CloudmersiveNlpApiClient.AnalyticsApi	analyticsHateSpeech	POST /nlp-v2/analytics/hate-speech	Perform Hate Speech Analysis and Detection on Text
CloudmersiveNlpApiClient.AnalyticsApi	analyticsProfanity	POST /nlp-v2/analytics/profanity	Perform Profanity and Obscene Language Analysis and Detection on Text
CloudmersiveNlpApiClient.AnalyticsApi	analyticsSentiment	POST /nlp-v2/analytics/sentiment	Perform Sentiment Analysis and Classification on Text
CloudmersiveNlpApiClient.AnalyticsApi	analyticsSimilarity	POST /nlp-v2/analytics/similarity	Perform Semantic Similarity Comparison of Two Strings
CloudmersiveNlpApiClient.AnalyticsApi	analyticsSubjectivity	POST /nlp-v2/analytics/subjectivity	Perform Subjectivity and Objectivity Analysis on Text
CloudmersiveNlpApiClient.ExtractEntitiesApi	extractEntitiesPost	POST /nlp-v2/extract-entities	Extract entities from string
CloudmersiveNlpApiClient.LanguageDetectionApi	languageDetectionGetLanguage	POST /nlp-v2/language/detect	Detect language of text
CloudmersiveNlpApiClient.LanguageTranslationApi	languageTranslationTranslateDeuToEng	POST /nlp-v2/translate/language/deu/to/eng	Translate German to English text with Deep Learning AI
CloudmersiveNlpApiClient.LanguageTranslationApi	languageTranslationTranslateEngToDeu	POST /nlp-v2/translate/language/eng/to/deu	Translate English to German text with Deep Learning AI
CloudmersiveNlpApiClient.LanguageTranslationApi	languageTranslationTranslateEngToFra	POST /nlp-v2/translate/language/eng/to/fra	Translate English to French text with Deep Learning AI
CloudmersiveNlpApiClient.LanguageTranslationApi	languageTranslationTranslateEngToRus	POST /nlp-v2/translate/language/eng/to/rus	Translate English to Russian text with Deep Learning AI
CloudmersiveNlpApiClient.LanguageTranslationApi	languageTranslationTranslateFraToEng	POST /nlp-v2/translate/language/fra/to/eng	Translate French to English text with Deep Learning AI
CloudmersiveNlpApiClient.LanguageTranslationApi	languageTranslationTranslateRusToEng	POST /nlp-v2/translate/language/rus/to/eng	Translate Russian to English text with Deep Learning AI
CloudmersiveNlpApiClient.ParseApi	parseParseString	POST /nlp-v2/parse/tree	Parse string to syntax tree
CloudmersiveNlpApiClient.PosTaggerApi	posTaggerTagAdjectives	POST /nlp-v2/pos/tag/adjectives	Part-of-speech tag a string, filter to adjectives
CloudmersiveNlpApiClient.PosTaggerApi	posTaggerTagAdverbs	POST /nlp-v2/pos/tag/adverbs	Part-of-speech tag a string, filter to adverbs
CloudmersiveNlpApiClient.PosTaggerApi	posTaggerTagNouns	POST /nlp-v2/pos/tag/nouns	Part-of-speech tag a string, filter to nouns
CloudmersiveNlpApiClient.PosTaggerApi	posTaggerTagPronouns	POST /nlp-v2/pos/tag/pronouns	Part-of-speech tag a string, filter to pronouns
CloudmersiveNlpApiClient.PosTaggerApi	posTaggerTagSentence	POST /nlp-v2/pos/tag/sentence	Part-of-speech tag a string
CloudmersiveNlpApiClient.PosTaggerApi	posTaggerTagVerbs	POST /nlp-v2/pos/tag/verbs	Part-of-speech tag a string, filter to verbs
CloudmersiveNlpApiClient.RephraseApi	rephraseEnglishRephraseSentenceBySentence	POST /nlp-v2/rephrase/rephrase/eng/by-sentence	Rephrase, paraphrase English text sentence-by-sentence using Deep Learning AI
CloudmersiveNlpApiClient.SegmentationApi	segmentationGetSentences	POST /nlp-v2/segmentation/sentences	Extract sentences from string
CloudmersiveNlpApiClient.SegmentationApi	segmentationGetWords	POST /nlp-v2/segmentation/words	Get words in input string
CloudmersiveNlpApiClient.SpellcheckApi	spellcheckCheckSentence	POST /nlp-v2/spellcheck/check/sentence	Check if sentence is spelled correctly
CloudmersiveNlpApiClient.SpellcheckApi	spellcheckCorrectJson	POST /nlp-v2/spellcheck/check/word	Find spelling corrections

Documentation for Models

• CloudmersiveNlpApiClient.CheckSentenceRequest
• CloudmersiveNlpApiClient.CheckSentenceResponse
• CloudmersiveNlpApiClient.CheckWordRequest
• CloudmersiveNlpApiClient.CheckWordResponse
• CloudmersiveNlpApiClient.CorrectWordInSentence
• CloudmersiveNlpApiClient.Entity
• CloudmersiveNlpApiClient.ExtractEntitiesRequest
• CloudmersiveNlpApiClient.ExtractEntitiesResponse
• CloudmersiveNlpApiClient.GetWordsRequest
• CloudmersiveNlpApiClient.GetWordsResponse
• CloudmersiveNlpApiClient.HateSpeechAnalysisRequest
• CloudmersiveNlpApiClient.HateSpeechAnalysisResponse
• CloudmersiveNlpApiClient.LanguageDetectionRequest
• CloudmersiveNlpApiClient.LanguageDetectionResponse
• CloudmersiveNlpApiClient.LanguageTranslationRequest
• CloudmersiveNlpApiClient.LanguageTranslationResponse
• CloudmersiveNlpApiClient.ParseRequest
• CloudmersiveNlpApiClient.ParseResponse
• CloudmersiveNlpApiClient.PosRequest
• CloudmersiveNlpApiClient.PosResponse
• CloudmersiveNlpApiClient.PosSentence
• CloudmersiveNlpApiClient.PosTaggedWord
• CloudmersiveNlpApiClient.ProfanityAnalysisRequest
• CloudmersiveNlpApiClient.ProfanityAnalysisResponse
• CloudmersiveNlpApiClient.RephraseRequest
• CloudmersiveNlpApiClient.RephraseResponse
• CloudmersiveNlpApiClient.RephrasedSentence
• CloudmersiveNlpApiClient.RephrasedSentenceOption
• CloudmersiveNlpApiClient.SentenceSegmentationRequest
• CloudmersiveNlpApiClient.SentenceSegmentationResponse
• CloudmersiveNlpApiClient.SentimentAnalysisRequest
• CloudmersiveNlpApiClient.SentimentAnalysisResponse
• CloudmersiveNlpApiClient.SimilarityAnalysisRequest
• CloudmersiveNlpApiClient.SimilarityAnalysisResponse
• CloudmersiveNlpApiClient.SubjectivityAnalysisRequest
• CloudmersiveNlpApiClient.SubjectivityAnalysisResponse
• CloudmersiveNlpApiClient.WordPosition

Documentation for Authorization

Apikey

• Type: API key
• API key parameter name: Apikey
• Location: HTTP header