nlpapi API Reference

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.

Swagger OpenAPI Specification | .NET Framework Client | .NET Core Client | Java Client | Node.JS Client | Python Client | Drupal Client

API Endpoint
https://api.cloudmersive.com
Schemes: https
Version: v1

Authentication

Apikey

API Key Authentication

type
apiKey
name
Apikey
in
header

ExtractEntitiesString

Extract entities from string

POST /nlp/ExtractEntitiesString


Extract the named entitites from an input string.



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

LanguageDetection

Detect language of text

POST /nlp/language/detect


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).



Text to detect language of

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Successful": "boolean",
  "DetectedLanguage_ThreeLetterCode": "string",
  "DetectedLanguage_FullName": "string"
}

ParseString

Parse string to syntax tree

POST /nlp/ParseString


Parses the input string into a Penn Treebank syntax tree



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

PosTaggerJson

Part-of-speech tag a string

POST /nlp/PosTaggerJson


Part-of-speech (POS) tag a string and return result as JSON



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "InputText": "string"
}
200 OK

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "TaggedSentences": [
    {
      "Words": [
        {
          "Word": "object",
          "Tag": "object"
        }
      ]
    }
  ]
}

PosTaggerString

Part-of-speech tag a string

POST /nlp/PosTaggerString


Perform a part-of-speech (POS) tagging on the input string.



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

Sentences

Extract sentences from string

POST /nlp/get/sentences/string


Segment an input string into separate sentences, output result as a string.



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

SpellCheck

Spell check a word

POST /nlp/spellcheck/check/word/string


Check if a word is spelled correctly



Input string word

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
boolean
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"boolean"

Spell check a sentence

POST /nlp/spellcheck/check/sentence/string


Check if a sentence is spelled correctly



Input sentence word

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
boolean
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"boolean"

Check if sentence is spelled correctly

POST /nlp/spellcheck/check/sentence/json


Checks whether the sentence is spelled correctly and returns the result as JSON



Input sentence

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "IncorrectCount": "integer (int32)",
  "Words": [
    {
      "Word": {
        "Word": "string",
        "WordIndex": "integer (int32)",
        "StartPosition": "integer (int32)",
        "EndPosition": "integer (int32)"
      },
      "Correct": "boolean",
      "Suggestions": [
        "string"
      ]
    }
  ]
}

Spell check word

POST /nlp/spellcheck/check/word/json


Spell check a word as JSON



Input sentence

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Correct": "boolean"
}

Find spelling corrections

POST /nlp/spellcheck/correct/word/string


Find the spelling corrections for a word



Input word

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

Find spelling corrections

POST /nlp/spellcheck/correct/word/json


Find spelling correction suggestions and return result as JSON



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Correct": "boolean",
  "Suggestions": [
    "string"
  ]
}

Words

Get words from string

POST /nlp/get/words/string


Segment an input string into its component words



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

Get words in input string (JSON)

POST /nlp/get/words/json


Get the component words in an input string, formatted as JSON



String to process

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Words": [
    {
      "Word": "string",
      "WordIndex": "integer (int32)",
      "StartPosition": "integer (int32)",
      "EndPosition": "integer (int32)"
    }
  ]
}

Get the verbs in a string

POST /nlp/get/words/verbs/string


Get all of the verbs in the input string.



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

Get proper nouns in a string

POST /nlp/get/words/properNouns/string


Returns all of the proper nouns in a string. Proper nouns are named entities such as "Hilton".



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

Get nouns in string

POST /nlp/get/words/nouns/string


Returns all of the nouns in the input string



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

Get adverbs in input string

POST /nlp/get/words/adverbs/string


Returns all adverb words in the input string



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

Returns all pronounts in string

POST /nlp/get/words/pronouns/string


Returns all pronouns in the input string



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

Get adjectives in string

POST /nlp/get/words/adjectives/string


Retrieves all adjectives in input string



Input string

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
"string"

Schema Definitions

LanguageDetectionResponse: object

Output of a language detection operation

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

Example
{
  "Successful": "boolean",
  "DetectedLanguage_ThreeLetterCode": "string",
  "DetectedLanguage_FullName": "string"
}

PosRequest: object

Part of speech tagging request

InputText: string

Input text string

Example
{
  "InputText": "string"
}

PosResponse: object

Part of speech tag result

TaggedSentences: PosSentence

Sentences in the string

PosSentence
Example
{
  "TaggedSentences": [
    {
      "Words": [
        {
          "Word": "object",
          "Tag": "object"
        }
      ]
    }
  ]
}

PosSentence: object

Sentence in a POS tag result

Words: PosTaggedWord

Words in the sentence

PosTaggedWord
Example
{
  "Words": [
    {
      "Word": "object",
      "Tag": "object"
    }
  ]
}

PosTaggedWord: object

Word tagged in a POS tag

Word: object

Word that was tagged

Tag: object

Penn Treebank tag applied to the word

Example
{
  "Word": "object",
  "Tag": "object"
}

CheckSentenceJsonResponse: object

Result of spell checking a sentence

IncorrectCount: integer (int32)

Number of incorrect words

Words: CorrectWordInSentenceJsonResponse

Words in the sentence, both correct and incorrect

CorrectWordInSentenceJsonResponse
Example
{
  "IncorrectCount": "integer (int32)",
  "Words": [
    {
      "Word": {
        "Word": "string",
        "WordIndex": "integer (int32)",
        "StartPosition": "integer (int32)",
        "EndPosition": "integer (int32)"
      },
      "Correct": "boolean",
      "Suggestions": [
        "string"
      ]
    }
  ]
}

CorrectWordInSentenceJsonResponse: object

A word in a sentence

Word: WordPosition

Position of the word

Correct: boolean

True if the word is spelled correctly, false otherwise

Suggestions: string[]

Suggested spelling improvements

string
Example
{
  "Word": {
    "Word": "string",
    "WordIndex": "integer (int32)",
    "StartPosition": "integer (int32)",
    "EndPosition": "integer (int32)"
  },
  "Correct": "boolean",
  "Suggestions": [
    "string"
  ]
}

WordPosition: object

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

Example
{
  "Word": "string",
  "WordIndex": "integer (int32)",
  "StartPosition": "integer (int32)",
  "EndPosition": "integer (int32)"
}

CheckJsonResponse: object

Spell check result

Correct: boolean

True if spellected correctly, false otherwise

Example
{
  "Correct": "boolean"
}

CorrectJsonResponse: object

Spelling correction check result

Correct: boolean

True if the word is spelled correctly, false otherwise

Suggestions: string[]

Suggested spelling corrections

string
Example
{
  "Correct": "boolean",
  "Suggestions": [
    "string"
  ]
}

GetWordsJsonResponse: object

Words in input string

Words: WordPosition

Array of words

WordPosition
Example
{
  "Words": [
    {
      "Word": "string",
      "WordIndex": "integer (int32)",
      "StartPosition": "integer (int32)",
      "EndPosition": "integer (int32)"
    }
  ]
}