NLP-API API documentation version 2

https://54.171.58.131:5000

NLP-API

Created June 2015

Extract URL

Extract text from URL

get post

get
post

Query Parameters

  • URL: (string )

    URL to extract

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Text extracted from URL",
  "text": "Example text",
  "title": "Example title"}

Body

Type: application/json

Schema:

{
  "type": "object",
  "description": "url containing the doc",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "url": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Text extracted from URL" ,
  "text": "Example text",
  "title": "Example title"}

Language extraction

Returns language (ISO 639-1)

get post

get
post

Query Parameters

  • url: (string )

    URL containing the text

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Language extracted from text" ,
  "language": "en"}

Body

Type: application/json

Schema:

{
  "type": "object",
  "description": "text extracted or URL containing text",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "text": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Language extracted from text" ,
  "language": "en"}

Entity extraction

Extracts named entities, addresses, telephones, e-mail, social id, hashtags and dates from text. Supported english and spanish.

get post

get
post

Query Parameters

  • url: (string )

    URL containing the text

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Entities extracted from text" ,
  "entitites": [
    {"count": 1, "category": "person", "name": "Steve Jobs"}
    {"count": 1, "category": "location", "name":  "Palo Alto, CA"},
    {"count": 3, "category": "organization", "name":  "Apple"},
    {"count": 1, "category": "date", "name":  "Monday"},
    {"count": 1, "category": "email", "name":  "contact@apple.com"},
    {"count": 1, "category": "telephone", "name":  "+44657892456"}                             
  ]
}

Body

Type: application/json

Schema:

{
  "type": "object",
  "description": "text extracted or URL containing text",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "text": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Entities extracted from text" ,
  "entitites": [
    {"count": 1, "category": "person", "name": "Steve Jobs"}
    {"count": 1, "category": "location", "name":  "Palo Alto, CA"},
    {"count": 3, "category": "organization", "name":  "Apple"},
    {"count": 1, "category": "date", "name":  "Monday"},
    {"count": 1, "category": "email", "name":  "contact@apple.com"},
    {"count": 1, "category": "telephone", "name":  "+44657892456"}                             
  ]
}

Keyword extraction

Extracts most relevant words in text (tf-idf). Supported english and spanish.

get post

get
post

Query Parameters

  • url: (string )

    URL containing the text

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Keywords extracted from text" ,
  "keywords": [
    {"name" : "innovation", "score": 02351},
    {"name" : "smartphone", "score": 0.19011},
    {"name" : "applications", "score": 0.1233},
    {"name" : "store", "score": 0.0660}                      
  ]
}

Body

Type: application/json

Schema:

{
  "type": "object",
  "description": "text extracted or URL containing text",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "text": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Keywords extracted from text" ,
  "keywords": [
    {"name" : "innovation", "score": 02351},
    {"name" : "smartphone", "score": 0.19011},
    {"name" : "applications", "score": 0.1233},
    {"name" : "store", "score": 0.0660}                      
  ]
}

Concept extraction

Extracts concepts (Linked Data entity + semantic type).

get post

get
post

Query Parameters

  • url: (string )

    URL containing the text

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Concepts extracted from text" ,
  "concepts": [
    {"concept": 
      {"lang": "en", 
      "name": "Christopher Lee", 
      "notable": 
        {"name": "Actor", 
        "id": "/m/02hrh1q"}, 
      "mid": "/m/0f0kz", 
      "score": "693.999817", 
      "id": "/en/chistopher_lee"}, 
    "name": "Christopher Lee"},
    {"concept": "https://twitter.com/mayoroflondon", 
    "name": "@mayoroflondon"}, 
    {"concept": "https://twitter.com/hashtag/christopherlee", 
    "name": "#christopherlee"}                    
  ]
}

Body

Type: application/json

Schema:

{
  "type": "object",
  "description": "text extracted or URL containing text",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "text": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Concepts extracted from text" ,
  "concepts": [
    {"concept": 
      {"lang": "en", 
      "name": "Christopher Lee", 
      "notable": 
        {"name": "Actor", 
        "id": "/m/02hrh1q"}, 
      "mid": "/m/0f0kz", 
      "score": "693.999817", 
      "id": "/en/chistopher_lee"}, 
    "name": "Christopher Lee"},
    {"concept": "https://twitter.com/mayoroflondon", 
    "name": "@mayoroflondon"}, 
    {"concept": "https://twitter.com/hashtag/christopherlee", 
    "name": "#christopherlee"}                    
  ]
}

Related words extraction

Returns words related to entities and most relevant words in text. Supported english and spanish.

get post

get
post

Query Parameters

  • url: (string )

    URL containing the text

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Related words extracted from text" ,
  "relatedwords": [
    {"word": "dracula", 
    "similarwords": [
      {"name": "stoker", "similarity": 0.6398248076438904}, 
      {"name": "bram", "similarity": 0.6193088293075562}, 
      {"name": "vampire", "similarity": 0.6130403280258179}, 
      {"name": "frankenstein", "similarity": 0.6062221527099609}, 
      {"name": "lugosi", "similarity": 0.5823888182640076}
    ]
    }                      
  ]
}

Body

Type: application/json

Schema:

{
  "type": "object",
  "description": "text extracted or URL containing text",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "text": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Related words extracted from text" ,
  "relatedwords": [
    {"word": "dracula", 
    "similarwords": [
      {"name": "stoker", "similarity": 0.6398248076438904}, 
      {"name": "bram", "similarity": 0.6193088293075562}, 
      {"name": "vampire", "similarity": 0.6130403280258179}, 
      {"name": "frankenstein", "similarity": 0.6062221527099609}, 
      {"name": "lugosi", "similarity": 0.5823888182640076}
    ]
    }                      
  ]
}

Relation extraction

Extracts things related to other things in a sentence, that is, extracts the subject, object and verb in a sentence. Supported english and spanish.

get post

get
post

Query Parameters

  • url: (string )

    URL containing the text

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Relation extraction" ,
  "relations": [
    {"verb": "has died", "object": "at the age after being hospitalised for respiratory problems", "subject": "Sir Christopher Lee"}
  ]
}

Body

Type: application/json

Schema:

{
  "type": "object",
  "description": "text extracted or URL containing text",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "text": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Relation extraction" ,
  "relations": [
    {"verb": "has died", "object": "at the age after being hospitalised for respiratory problems", "subject": "Sir Christopher Lee"}
  ]
}

Emojis extraction

Extracts emojis in a sentence.

get post

get
post

Query Parameters

  • url: (string )

    URL containing the text

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Emojis extraction" ,
  "emojis": [
    {"count": 2, "description": [{"category": "People", "name": "VICTORY HAND"}], "emoji": "\u270c"}
  ]
}

Body

Type: application/json

Schema:

{
  "type": "object",
  "description": "text extracted or URL containing text",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "text": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Emojis extraction" ,
  "emojis": [
    {"count": 2, "description": [{"category": "People", "name": "VICTORY HAND"}], "emoji": "\u270c"}
  ]
}

Hashtags and social ids extraction

Extracts hashtags and ids from Twitter and Instagram in a sentence.

get post

get
post

Query Parameters

  • url: (string )

    URL containing the text

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Social information extraction" ,
  {"social": 
    {
      "hashtags": 
        [{"count": 1, "link": "https://twitter.com/hashtag/legend", "type": "twitter", "name": "#legend"}, {"count": 1, "link": "https://twitter.com/hashtag/christopherlee", "type": "twitter", "name": "#christopherlee"}], 
      "users": 
        [{"count": 1, "link": "https://twitter.com/omid9", "type": "twitter", "name": "@omid9"}, {"count": 1, "link": "https://twitter.com/domswildthings", "type": "twitter", "name": "@domswildthings"}, {"count": 1, "link": "https://twitter.com/woodelijah", "type": "twitter", "name": "@woodelijah"}]
    }
  }
}

Body

Type: application/json

Schema:

{
  "type": "object",
  "description": "text extracted or URL containing text",
  "$schema": "http://json-schema.org/draft-03/schema",
  "required": true,
  "properties": {
    "text": {
      "type": "string",
      "required": true
    }
  }
}

HTTP status code 200

Body

Type: application/json

Example:

{ "message": "Social information extraction" ,
  {"social": 
    {
      "hashtags": 
        [{"count": 1, "link": "https://twitter.com/hashtag/legend", "type": "twitter", "name": "#legend"}, {"count": 1, "link": "https://twitter.com/hashtag/christopherlee", "type": "twitter", "name": "#christopherlee"}], 
      "users": 
        [{"count": 1, "link": "https://twitter.com/omid9", "type": "twitter", "name": "@omid9"}, {"count": 1, "link": "https://twitter.com/domswildthings", "type": "twitter", "name": "@domswildthings"}, {"count": 1, "link": "https://twitter.com/woodelijah", "type": "twitter", "name": "@woodelijah"}]
    }
  }
}