{
  "swagger": "2.0",
  "info": {
    "version": "v1",
    "title": "nlpapi",
    "description": "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."
  },
  "host": "localhost",
  "schemes": [
    "https"
  ],
  "paths": {
    "/nlp/ExtractEntitiesString": {
      "post": {
        "tags": [
          "ExtractEntitiesString"
        ],
        "summary": "Extract entities from string",
        "description": "Extract the named entitites from an input string.",
        "operationId": "ExtractEntitiesString_Post",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "value",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/language/detect": {
      "post": {
        "tags": [
          "LanguageDetection"
        ],
        "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).",
        "operationId": "LanguageDetection_Post",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "textToDetect",
            "in": "body",
            "description": "Text to detect language of",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/LanguageDetectionResponse"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp-v2/ParseString": {
      "post": {
        "tags": [
          "ParseString"
        ],
        "summary": "Parse string to syntax tree",
        "description": "Parses the input string into a Penn Treebank syntax tree",
        "operationId": "ParseString_Post",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "input",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/PosTaggerJson": {
      "post": {
        "tags": [
          "PosTaggerJson"
        ],
        "summary": "Part-of-speech tag a string",
        "description": "Part-of-speech (POS) tag a string and return result as JSON",
        "operationId": "PosTaggerJson_Post",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "$ref": "#/definitions/PosRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/PosResponse"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/PosTaggerString": {
      "post": {
        "tags": [
          "PosTaggerString"
        ],
        "summary": "Part-of-speech tag a string",
        "description": "Perform a part-of-speech (POS) tagging on the input string.",
        "operationId": "PosTaggerString_Post",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "input",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/spellcheck/check/word/string": {
      "post": {
        "tags": [
          "SpellCheck"
        ],
        "summary": "Spell check a word",
        "description": "Check if a word is spelled correctly",
        "operationId": "SpellCheck_Post",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "value",
            "in": "body",
            "description": "Input string word",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "boolean"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/spellcheck/check/sentence/string": {
      "post": {
        "tags": [
          "SpellCheck"
        ],
        "summary": "Spell check a sentence",
        "description": "Check if a sentence is spelled correctly",
        "operationId": "SpellCheck_CheckSentenceString",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "value",
            "in": "body",
            "description": "Input sentence word",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "boolean"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/spellcheck/check/sentence/json": {
      "post": {
        "tags": [
          "SpellCheck"
        ],
        "summary": "Check if sentence is spelled correctly",
        "description": "Checks whether the sentence is spelled correctly and returns the result as JSON",
        "operationId": "SpellCheck_CheckSentenceJson",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "value",
            "in": "body",
            "description": "Input sentence",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CheckSentenceJsonResponse"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/spellcheck/check/word/json": {
      "post": {
        "tags": [
          "SpellCheck"
        ],
        "summary": "Spell check word",
        "description": "Spell check a word as JSON",
        "operationId": "SpellCheck_CheckJson",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "value",
            "in": "body",
            "description": "Input sentence",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CheckJsonResponse"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/spellcheck/correct/word/string": {
      "post": {
        "tags": [
          "SpellCheck"
        ],
        "summary": "Find spelling corrections",
        "description": "Find the spelling corrections for a word",
        "operationId": "SpellCheck_Correct",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "value",
            "in": "body",
            "description": "Input word",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/spellcheck/correct/word/json": {
      "post": {
        "tags": [
          "SpellCheck"
        ],
        "summary": "Find spelling corrections",
        "description": "Find spelling correction suggestions and return result as JSON",
        "operationId": "SpellCheck_CorrectJson",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "value",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CorrectJsonResponse"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/get/words/string": {
      "post": {
        "tags": [
          "Words"
        ],
        "summary": "Get words from string",
        "description": "Segment an input string into its component words",
        "operationId": "Words_GetWordsString",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "input",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/get/words/json": {
      "post": {
        "tags": [
          "Words"
        ],
        "summary": "Get words in input string (JSON)",
        "description": "Get the component words in an input string, formatted as JSON",
        "operationId": "Words_GetWordsJson",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "input",
            "in": "body",
            "description": "String to process",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/GetWordsJsonResponse"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/get/words/verbs/string": {
      "post": {
        "tags": [
          "Words"
        ],
        "summary": "Get the verbs in a string",
        "description": "Get all of the verbs in the input string.",
        "operationId": "Words_Post",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "input",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/get/words/properNouns/string": {
      "post": {
        "tags": [
          "Words"
        ],
        "summary": "Get proper nouns in a string",
        "description": "Returns all of the proper nouns in a string.  Proper nouns are named entities such as \"Hilton\".",
        "operationId": "Words_ProperNouns",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "input",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/get/words/nouns/string": {
      "post": {
        "tags": [
          "Words"
        ],
        "summary": "Get nouns in string",
        "description": "Returns all of the nouns in the input string",
        "operationId": "Words_Nouns",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "input",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/get/words/adverbs/string": {
      "post": {
        "tags": [
          "Words"
        ],
        "summary": "Get adverbs in input string",
        "description": "Returns all adverb words in the input string",
        "operationId": "Words_Adverbs",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "input",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/get/words/pronouns/string": {
      "post": {
        "tags": [
          "Words"
        ],
        "summary": "Returns all pronounts in string",
        "description": "Returns all pronouns in the input string",
        "operationId": "Words_Pronouns",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "input",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    },
    "/nlp/get/words/adjectives/string": {
      "post": {
        "tags": [
          "Words"
        ],
        "summary": "Get adjectives in string",
        "description": "Retrieves all adjectives in input string",
        "operationId": "Words_Adjectives",
        "consumes": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "input",
            "in": "body",
            "description": "Input string",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          }
        },
        "security": [
          {
            "Apikey": []
          }
        ]
      }
    }
  },
  "definitions": {
    "LanguageDetectionResponse": {
      "description": "Output of a language detection operation",
      "type": "object",
      "properties": {
        "Successful": {
          "description": "True if the language detection operation was successful, false otherwise",
          "type": "boolean"
        },
        "DetectedLanguage_ThreeLetterCode": {
          "description": "ISO 639 three letter language code",
          "type": "string"
        },
        "DetectedLanguage_FullName": {
          "description": "The full name (in English) of the detected language",
          "type": "string"
        }
      }
    },
    "PosRequest": {
      "description": "Part of speech tagging request",
      "type": "object",
      "properties": {
        "InputText": {
          "description": "Input text string",
          "type": "string"
        }
      }
    },
    "PosResponse": {
      "description": "Part of speech tag result",
      "type": "object",
      "properties": {
        "TaggedSentences": {
          "description": "Sentences in the string",
          "type": "array",
          "items": {
            "$ref": "#/definitions/PosSentence"
          }
        }
      }
    },
    "PosSentence": {
      "description": "Sentence in a POS tag result",
      "type": "object",
      "properties": {
        "Words": {
          "description": "Words in the sentence",
          "type": "array",
          "items": {
            "$ref": "#/definitions/PosTaggedWord"
          }
        }
      }
    },
    "PosTaggedWord": {
      "description": "Word tagged in a POS tag",
      "type": "object",
      "properties": {
        "Word": {
          "description": "Word that was tagged",
          "type": "object"
        },
        "Tag": {
          "description": "Penn Treebank tag applied to the word",
          "type": "object"
        }
      }
    },
    "CheckSentenceJsonResponse": {
      "description": "Result of spell checking a sentence",
      "type": "object",
      "properties": {
        "IncorrectCount": {
          "format": "int32",
          "description": "Number of incorrect words",
          "type": "integer"
        },
        "Words": {
          "description": "Words in the sentence, both correct and incorrect",
          "type": "array",
          "items": {
            "$ref": "#/definitions/CorrectWordInSentenceJsonResponse"
          }
        }
      }
    },
    "CorrectWordInSentenceJsonResponse": {
      "description": "A word in a sentence",
      "type": "object",
      "properties": {
        "Word": {
          "$ref": "#/definitions/WordPosition",
          "description": "Position of the word"
        },
        "Correct": {
          "description": "True if the word is spelled correctly, false otherwise",
          "type": "boolean"
        },
        "Suggestions": {
          "description": "Suggested spelling improvements",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "WordPosition": {
      "type": "object",
      "properties": {
        "Word": {
          "description": "Word as a string",
          "type": "string"
        },
        "WordIndex": {
          "format": "int32",
          "description": "Zero-based index of the word; first word has index 0, second word has index 1 and so on",
          "type": "integer"
        },
        "StartPosition": {
          "format": "int32",
          "description": "Zero-based character offset at which the word begins in the input string",
          "type": "integer"
        },
        "EndPosition": {
          "format": "int32",
          "description": "Zero-based character offset at which the word ends in the input string",
          "type": "integer"
        }
      }
    },
    "CheckJsonResponse": {
      "description": "Spell check result",
      "type": "object",
      "properties": {
        "Correct": {
          "description": "True if spellected correctly, false otherwise",
          "type": "boolean"
        }
      }
    },
    "CorrectJsonResponse": {
      "description": "Spelling correction check result",
      "type": "object",
      "properties": {
        "Correct": {
          "description": "True if the word is spelled correctly, false otherwise",
          "type": "boolean"
        },
        "Suggestions": {
          "description": "Suggested spelling corrections",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "GetWordsJsonResponse": {
      "description": "Words in input string",
      "type": "object",
      "properties": {
        "Words": {
          "description": "Array of words",
          "type": "array",
          "items": {
            "$ref": "#/definitions/WordPosition"
          }
        }
      }
    }
  },
  "securityDefinitions": {
    "Apikey": {
      "type": "apiKey",
      "description": "API Key Authentication",
      "name": "Apikey",
      "in": "header"
    }
  }
}