Connectors Reference
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.
|
Status: Preview |
Tier: Premium |
Version: v1 |
|
Name |
Summary |
|
Perform Sentiment Analysis and Classification on Text |
|
|
Perform Profanity and Obscene Language Analysis and Detection on Text |
|
|
Perform Subjectivity and Objectivity Analysis on Text |
|
|
Extract entities from string |
|
|
LanguageDetection_getLanguage (LanguageDetectionRequest input) |
Detect language of text |
|
LanguageTranslation_TranslateDeuToEng (LanguageTranslationRequest input) |
Translate German to English text with Deep Learning AI |
|
LanguageTranslation_TranslateEngToDeu (LanguageTranslationRequest input) |
Translate English to German text with Deep Learning AI |
|
LanguageTranslation_TranslateRusToEng (LanguageTranslationRequest input) |
Translate Russian to English text with Deep Learning AI |
|
LanguageTranslation_TranslateEngToRus (LanguageTranslationRequest input) |
Translate English to Russian text with Deep Learning AI |
|
Parse string to syntax tree |
|
|
Part-of-speech tag a string |
|
|
Part-of-speech tag a string, filter to verbs |
|
|
Part-of-speech tag a string, filter to nouns |
|
|
Part-of-speech tag a string, filter to adjectives |
|
|
Part-of-speech tag a string, filter to adverbs |
|
|
Part-of-speech tag a string, filter to pronouns |
|
|
Rephrase_EnglishRephrase_SentenceBySentence (RephraseRequest input) |
Rephrase, paraphrase English text sentence-by-sentence using Deep Learning AI |
|
Segmentation_GetSentences (SentenceSegmentationRequest input) |
Extract sentences from string |
|
Get words in input string |
|
|
Find spelling corrections |
|
|
Check if sentence is spelled correctly |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Perform Sentiment Analysis and Classification on Text
Description: 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.
Syntax:
CloudmersiveNLP.Analytics_Sentiment (SentimentAnalysisRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Input to a sentiment analysis operation |
True |
Returns:
Type:SentimentAnalysisResponse
Description: Output of a sentiment analysis operation
Summary: Perform Profanity and Obscene Language Analysis and Detection on Text
Description: 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.
Syntax:
CloudmersiveNLP.Analytics_Profanity (ProfanityAnalysisRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Input to a profanity analysis operation |
True |
Returns:
Type:ProfanityAnalysisResponse
Description: Output of a profanity analysis operation
Summary: Perform Subjectivity and Objectivity Analysis on Text
Description: 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.
Syntax:
CloudmersiveNLP.Analytics_Subjectivity (SubjectivityAnalysisRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Input to a subjectivity analysis operation |
True |
Returns:
Type:SubjectivityAnalysisResponse
Description: Output of a subjectivity analysis operation
Summary: Extract entities from string
Description: Extract the named entitites from an input string.
Syntax:
CloudmersiveNLP.ExtractEntities_Post (ExtractEntitiesRequest value)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
value |
|
Request to extract named entities |
True |
Returns:
Description: Result of performing an extract entities operation
Summary: Detect language of text
Description: 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).
Syntax:
CloudmersiveNLP.LanguageDetection_getLanguage (LanguageDetectionRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Input to a language detection operation |
True |
Returns:
Type:LanguageDetectionResponse
Description: Output of a language detection operation
Summary: Translate German to English text with Deep Learning AI
Description: 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.
Syntax:
CloudmersiveNLP.LanguageTranslation_TranslateDeuToEng (LanguageTranslationRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Input to a language translation operation |
True |
Returns:
Type:LanguageTranslationResponse
Description: Output of a language translation operation
Summary: Translate English to German text with Deep Learning AI
Description: 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.
Syntax:
CloudmersiveNLP.LanguageTranslation_TranslateEngToDeu (LanguageTranslationRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Input to a language translation operation |
True |
Returns:
Type:LanguageTranslationResponse
Description: Output of a language translation operation
Summary: Translate Russian to English text with Deep Learning AI
Description: 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.
Syntax:
CloudmersiveNLP.LanguageTranslation_TranslateRusToEng (LanguageTranslationRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Input to a language translation operation |
True |
Returns:
Type:LanguageTranslationResponse
Description: Output of a language translation operation
Summary: Translate English to Russian text with Deep Learning AI
Description: 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.
Syntax:
CloudmersiveNLP.LanguageTranslation_TranslateEngToRus (LanguageTranslationRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Input to a language translation operation |
True |
Returns:
Type:LanguageTranslationResponse
Description: Output of a language translation operation
Summary: Parse string to syntax tree
Description: Parses the input string into a Penn Treebank syntax tree
Syntax:
CloudmersiveNLP.Parse_ParseString (ParseRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Linguistic parse request |
True |
Returns:
Type:ParseResponse
Description: Result of linguistic parse operation
Summary: Part-of-speech tag a string
Description: Part-of-speech (POS) tag a string and return result as JSON
Syntax:
CloudmersiveNLP.PosTagger_TagSentence (PosRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Part of speech tagging request |
True |
Returns:
Type:PosResponse
Description: Part of speech tag result
Summary: Part-of-speech tag a string, filter to verbs
Description: Part-of-speech (POS) tag a string, find the verbs, and return result as JSON
Syntax:
CloudmersiveNLP.PosTagger_TagVerbs (PosRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Part of speech tagging request |
True |
Returns:
Type:PosResponse
Description: Part of speech tag result
Summary: Part-of-speech tag a string, filter to nouns
Description: Part-of-speech (POS) tag a string, find the nouns, and return result as JSON
Syntax:
CloudmersiveNLP.PosTagger_TagNouns (PosRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Part of speech tagging request |
True |
Returns:
Type:PosResponse
Description: Part of speech tag result
Summary: Part-of-speech tag a string, filter to adjectives
Description: Part-of-speech (POS) tag a string, find the adjectives, and return result as JSON
Syntax:
CloudmersiveNLP.PosTagger_TagAdjectives (PosRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Part of speech tagging request |
True |
Returns:
Type:PosResponse
Description: Part of speech tag result
Summary: Part-of-speech tag a string, filter to adverbs
Description: Part-of-speech (POS) tag a string, find the adverbs, and return result as JSON
Syntax:
CloudmersiveNLP.PosTagger_TagAdverbs (PosRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Part of speech tagging request |
True |
Returns:
Type:PosResponse
Description: Part of speech tag result
Summary: Part-of-speech tag a string, filter to pronouns
Description: Part-of-speech (POS) tag a string, find the pronouns, and return result as JSON
Syntax:
CloudmersiveNLP.PosTagger_TagPronouns (PosRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Part of speech tagging request |
True |
Returns:
Type:PosResponse
Description: Part of speech tag result
Summary: Rephrase, paraphrase English text sentence-by-sentence using Deep Learning AI
Description: 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.
Syntax:
CloudmersiveNLP.Rephrase_EnglishRephrase_SentenceBySentence (RephraseRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Input to a text rephrasing operation |
True |
Returns:
Type:RephraseResponse
Description: Output of a text rephrasing operation
Summary: Extract sentences from string
Description: Segment an input string into separate sentences, output result as a string.
Syntax:
CloudmersiveNLP.Segmentation_GetSentences (SentenceSegmentationRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
|
True |
Returns:
Type:SentenceSegmentationResponse
Summary: Get words in input string
Description: Get the component words in an input string
Syntax:
CloudmersiveNLP.Segmentation_GetWords (GetWordsRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
|
True |
Returns:
Type:GetWordsResponse
Description: Words in input string
Summary: Find spelling corrections
Description: Find spelling correction suggestions and return result as JSON
Syntax:
CloudmersiveNLP.Spellcheck_CorrectJson (CheckWordRequest value)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
value |
|
|
True |
Returns:
Type:CheckWordResponse
Description: Spelling correction check result
Summary: Check if sentence is spelled correctly
Description: Checks whether the sentence is spelled correctly and returns the result as JSON
Syntax:
CloudmersiveNLP.Spellcheck_CheckSentence (CheckSentenceRequest value)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
value |
|
Input object for spell checking |
True |
Returns:
Description: Result of spell checking a sentence
Summary:
Description: Input object for spell checking
Properties:
|
Name |
Type |
Summary |
|
Sentence |
string
|
Input sentence for spell check |
Summary:
Description: Result of spell checking a sentence
Properties:
|
Name |
Type |
Summary |
|
IncorrectCount |
integer(int32)
|
Number of incorrect words |
|
Words |
array of (CorrectWordInSentence)
|
Words in the sentence, both correct and incorrect |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Word |
string
|
|
Summary:
Description: Spelling correction check result
Properties:
|
Name |
Type |
Summary |
|
Correct |
boolean
|
True if the word is spelled correctly, false otherwise |
|
Suggestions |
array of (string)
|
Suggested spelling corrections |
Summary:
Description: A word in a sentence
Properties:
|
Name |
Type |
Summary |
|
Word |
|
|
|
Correct |
boolean
|
True if the word is spelled correctly, false otherwise |
|
Suggestions |
array of (string)
|
Suggested spelling improvements |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
EntityType |
string
|
|
|
EntityText |
string
|
|
Summary:
Description: Request to extract named entities
Properties:
|
Name |
Type |
Summary |
|
InputString |
string
|
Input string to extract entities from |
Summary:
Description: Result of performing an extract entities operation
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
|
Entities |
array of (Entity)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
InputText |
string
|
|
Summary:
Description: Words in input string
Properties:
|
Name |
Type |
Summary |
|
Words |
array of (WordPosition)
|
Array of words |
Summary:
Description: Input to a language detection operation
Properties:
|
Name |
Type |
Summary |
|
textToDetect |
string
|
Text to detect the language of |
Summary:
Description: Output of a language detection operation
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the language detection operation was successful, false otherwise |
|
DetectedLanguage_ThreeLetterCode |
string
|
ISO 639 three letter language code |
|
DetectedLanguage_FullName |
string
|
The full name (in English) of the detected language |
Summary:
Description: Input to a language translation operation
Properties:
|
Name |
Type |
Summary |
|
TextToTranslate |
string
|
Text to translate |
Summary:
Description: Output of a language translation operation
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the language detection operation was successful, false otherwise |
|
TranslatedTextResult |
string
|
Translated text in target language |
|
SentenceCount |
integer(int32)
|
Number of sentences in input text |
Summary:
Description: Linguistic parse request
Properties:
|
Name |
Type |
Summary |
|
InputString |
string
|
Input string to linguistically parse |
Summary:
Description: Result of linguistic parse operation
Properties:
|
Name |
Type |
Summary |
|
ParseTree |
string
|
Parse tree in Penn Treebank syntax tree format |
Summary:
Description: Part of speech tagging request
Properties:
|
Name |
Type |
Summary |
|
InputText |
string
|
Input text string |
Summary:
Description: Part of speech tag result
Properties:
|
Name |
Type |
Summary |
|
TaggedSentences |
array of (PosSentence)
|
Sentences in the string |
Summary:
Description: Sentence in a POS tag result
Properties:
|
Name |
Type |
Summary |
|
Words |
array of (PosTaggedWord)
|
Words in the sentence |
Summary:
Description: Word tagged in a POS tag
Properties:
|
Name |
Type |
Summary |
|
Word |
|
Word that was tagged |
|
Tag |
|
Penn Treebank tag applied to the word |
Summary:
Description: Word that was tagged
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Penn Treebank tag applied to the word
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Input to a profanity analysis operation
Properties:
|
Name |
Type |
Summary |
|
TextToAnalyze |
string
|
Text to analyze |
Summary:
Description: Output of a profanity analysis operation
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the profanity detection operation was successful, false otherwise |
|
ProfanityScoreResult |
number(double)
|
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. |
|
SentenceCount |
integer(int32)
|
Number of sentences in input text |
Summary:
Description: One input sentence and associated rephrasing results
Properties:
|
Name |
Type |
Summary |
|
SentenceIndex |
integer(int32)
|
Index of the sentence, 1-based, ordered |
|
OriginalSentenceText |
string
|
Original input sentence text |
|
Rephrasings |
array of (RephrasedSentenceOption)
|
Rephrasing text options, candidates of the original input sentence, in order - with best candidate first |
Summary:
Description: One rephrasing of an original input sentence
Properties:
|
Name |
Type |
Summary |
|
RephrasedOptionIndex |
integer(int32)
|
Ordered index of the rephrasing option, 1-based, with 1 being the best option |
|
RephrasedSentenceText |
string
|
One sentence of output rephrased text of original input sentence |
Summary:
Description: Input to a text rephrasing operation
Properties:
|
Name |
Type |
Summary |
|
TextToTranslate |
string
|
Text to rephrase |
|
TargetRephrasingCount |
integer(int32)
|
The number of rephrasing output options you would like per sentence; possible values are 1 to 10. Default is 2. |
Summary:
Description: Output of a text rephrasing operation
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the language detection operation was successful, false otherwise |
|
RephrasedResults |
array of (RephrasedSentence)
|
Results of the rephrasing, paraphrasing operation, in the order of the input sentences |
|
SentenceCount |
integer(int32)
|
Number of sentences in input text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
InputString |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
|
|
Sentences |
array of (string)
|
|
|
SentenceCount |
integer(int32)
|
|
Summary:
Description: Input to a sentiment analysis operation
Properties:
|
Name |
Type |
Summary |
|
TextToAnalyze |
string
|
Text to analyze |
Summary:
Description: Output of a sentiment analysis operation
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the sentiment analysis operation was successful, false otherwise |
|
SentimentClassificationResult |
string
|
Classification of input text into a sentiment classification; possible values are "Positive", "Negative" or "Neutral" |
|
SentimentScoreResult |
number(double)
|
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. |
|
SentenceCount |
integer(int32)
|
Number of sentences in input text |
Summary:
Description: Input to a subjectivity analysis operation
Properties:
|
Name |
Type |
Summary |
|
TextToAnalyze |
string
|
Text to analyze |
Summary:
Description: Output of a subjectivity analysis operation
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the subjectivity analysis operation was successful, false otherwise |
|
SubjectivityScoreResult |
number(double)
|
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. |
|
SentenceCount |
integer(int32)
|
Number of sentences in input text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Word |
string
|
Word as a string |
|
WordIndex |
integer(int32)
|
Zero-based index of the word; first word has index 0, second word has index 1 and so on |
|
StartPosition |
integer(int32)
|
Zero-based character offset at which the word begins in the input string |
|
EndPosition |
integer(int32)
|
Zero-based character offset at which the word ends in the input string |