Entities

Overview

Named-entity recognition (NER) (also known as entity identification, entity chunking and entity extraction) is a subtask of information extraction that seeks to locate and classify named entities in text into pre-defined categories such as the names of persons, organizations, locations, expressions of times, quantities, monetary values, percentages, etc. 
In simple words you may be interested to extract dates, number, location, currency, units etc.

AmplifyReach Catalyst platform supports following entities:

Entities Using Catalyst UI

• Goto AmplifyReach Dashboard-> BuildBots
• Using navigation sidebar, locate Core Services > Text Analysis.
• Select URL or Text tab to enter the link or text for Text Analysis. 

• Press Analyze button.

• Text Analysis Results will be shown.
• Results show all available entities that Catalyst has detected
• For Developers, you can view JSON by clicking </> View JSON on right corner.

Extracting Entities Using Catalyst API

 Tip: Register your account and contact us at kick-start@amplifyreach.com to get Developer Id and Access Token

URL & Objects

The following URLs are available.

PUT /textanalysis/v1/entities

PUT https://launch.amplifyreach.com/textanalysis/v1/entities

Headers:

Body:

{
    "url": "<SAMPLE_URL>"
}

{
    "text": "<SAMPLE_TEXT>"
}

cURL-PUT Request for URL Request

curl \
-H "Content-Type: application/json" \
-H "cid:<YOUR_DEVELOPER_ID>" \
-H "authtoken:<YOUR_DEVELOPER_ACCESS_TOKEN>" \
-X PUT \
-d '{"url":"<SAMPLE_URL_FOR_ANALYSIS>"}'\
https://apps.amplifyreach.com/textanalysis/v1/entities

cURL-PUT Request for Text Request

curl \
-H "Content-Type: application/json" \
-H "cid:<YOUR_DEVELOPER_ID>" \
-H "authtoken:<YOUR_DEVELOPER_ACCESS_TOKEN>" \
-X PUT \
-d '{"text":"<SAMPLE_TEXT_FOR_ANALYSIS>"}'\
https://apps.amplifyreach.com/textanalysis/v1/entities

Put Response

The taxonomy put API response JSON structure.

Example: PUT Response

{
   "status":"success",
   "uid":"4f057e01d88ff7aa82a8610dc651e8fe",
   "license":"By accessing AmplifyReach or using information generated by AmplifyReachAPI, you are agreeing to be 
    bound by the AmplifyReach Terms of Use."
}

GET /textanalysis/v1/entities/{UID}

Response time: 
Free Trial Account
– For URL as a payload, you can retrieve response after 10 seconds
– For Text as a payload, you can retrieve response after 1 seconds
Paid account: 
– Higher QPS as per applicable plan

GET https://launch.amplifyreach.com/textanalysis/v1/entities/{UID}
Headers

cURL-GET Request for UID Request

curl \
-H "Content-Type: application/json" \
-H "cid:<YOUR_DEVELOPER_ID>" \
-H "authtoken:<YOUR_DEVELOPER_ACCESS_TOKEN>" \
-X GET \
 https://launch.amplifyreach.com/textanalysis/v1/entities/{UID}

Entity Object

The entity analysis JSON contains all information about an entity, including its ID, name, and entries.

The entity object has the following fields.

Example: Entity Object

{
  "license": "By accessing AmplifyReach or using information generated by AmplifyReachAPI, you are agreeing to be bound 
     by the AmplifyReach Terms of Use.",
  "entities":{
      "brands":[],
      "laws":[],
      "quantity": ["350 - km", "240 - kilometre"],
      "languages":[],
      "artNames": [],
      "groups":[],
      "dates": [ "february 9 , 2017 - 15:38","february 9 , 2017 - 15:40"],
      "percents": ["50 percent"],
      "cardinal": ["2,413.68", "one", "two", "three"],
      "people":[],
      "peopleWithKnowledgeBase":[],
      "locationWithKnowledgeBase":[],
      "orgWithKnowledgeBase":[],
      "brandWithKnowledgeBase":[],
      "times": ["14 hours", "around 24 hours"],
      "money":[],
      "organizations":["army", "the ministry of railways", "boost!", "navy",   "union territory", "air force", 
      "silapathar - north lakhimpur - bamey",   "nfr", "ministry of railways"],
      "locations":["andaman",  "tawang", "bamey", "bhalukpong", "diglipur", "nicobar islands", "port blair", 
      "arunachal pradesh",  "india", "pasighat"],
      "events": [],
      "ordinal": [ "first"],
  },
  "status": "success"
  
}

Entity With Knowledge Base

The AmplifyReach have their own knowledge graph with 40 million+ concepts. With the help of this concept graph, We will provide additional information about person (only celebrity), location, brand and organization. 
People With Knowledge Base response JSON structure.

Example: People With Knowledge Base Object

{  
 "peopleWithKnowledge":[{
   "name": "Judi Dench",  
   "category": "Movies",  
   "events": ["Upcoming film Miss Peregrine's Home for Peculiar Children, Released On   2016"]  
 },   
 { 
    "name": "Jeff Pope", 
    "category": "Movies",  
 }]
}