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:

NameDescription
BRANDSVehicles, weapons, foods, etc. (not services).
LAWSNamed documents made into laws.
QUANTITYMeasurements, as of weight or distance.
LANGUAGESAny named language (language name occure in article/text).
ART NAMETitles of books, songs, etc.
GROUPSNationalities or religious or political groups.
DATESGet date terms, Absolute or relative dates or periods.
PERCENTSPercentage (including "%").
PEOPLEName of People, including fictional.
PEOPLE WITH KNOWLEDGE BASEPeople Entity with some additional information like - Person Category there upcoming and latest events. Ref- People With Knowledge Base.
TIMESGet time terms, Times smaller than a day.
MONEYMonetary values, including unit.
ORGANIZATIONSName of Companies, agencies, institutions, Organization etc.
LOCATIONSName of Location, Place, Country, city etc.
EVENTSNamed hurricanes, battles, wars, sports events, etc.
CARDINALNumerals that do not fall under another type.
ORDINALOrdinals (e.g., "first", "1st").
EMAILGet email Id from article text.
LINKGet URL/Link from article text.

Entities Using Catalyst UI


  • Login to AmplifyReach Catalyst platform https://apps.amplifyreach.com/catalyst/
  • Using navigation sidebar, locate Core Services > Text Analysis.
  • Use URL to analyze any URL for entities or Use Text for analyzing text.

  • Press Analyze button.
  • Upon successful run, it will append results after Analyze button.

  • Results show all available entities that Catalyst could detect (please let us know bugs or improvements at support@amplifyreach.com)
  • For Developers, you can view JSON by clicking </> View JSON on right corner.

Entities Using Catalyst API


Tip: Register your account through https://apps.amplifyreach.com/catalyst/ or contact us at kick-start@amplifyreach.com

URL & Objects


The following URLs are available.

URLDescription
POST /textanalysis/v1/entitiesGet Entities from URL, Articles or Text.

POST /textanalysis/v1/entities


POST https://apps.amplifyreach.com/textanalysis/v1/entities
Headers
Content-Typeapplication/json
authTokenYOUR_DEVELOPER_ACCESS_TOKEN
cidYOUR_DEVELOPER_ID
POST body [Reference API Request Object]
{
    "url": "<SAMPLE_URL>"
}
OR
{
    "text": "<SAMPLE_TEXT>"
}

The successful response is Entity Object.

cURL Request for URL Request


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

cURL Request for Text Request


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

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.

NameTypeDescription
statusStringRequest Status (Reference:  Status & Error Codes )
entitiesJSONObjectContains multiple entity object. Like- People, Location, Date etc.
entities.brandsJSONArray StringVehicles, weapons, foods, etc. (not services).
entities.lawsJSONArray StringNamed documents made into laws.
entities.quantityJSONArray StringMeasurements, as of weight or distance.
entities.languagesJSONArray StringAny named language (language name occure in article/text).
entities.artNameJSONArray StringTitles of books, songs, etc.
entities.groupsJSONArray StringNationalities or religious or political groups.
entities.datesJSONArray StringGet date terms, Absolute or relative dates or periods.
entities.percentsJSONArray StringPercentage (including "%").
entities.peopleJSONArray StringName of People, including fictional.
entities.peopleWithKnowledgeBaseJSONArray People With KnowledgeBaseRef: People With Knowledge Base.
entities.timesJSONArray StringGet time terms, Times smaller than a day.
entities.moneyJSONArray StringMonetary values, including unit.
entities.organizationsJSONArray StringName of Companies, agencies, institutions, Organization etc.
entities.locationsJSONArray StringName of Location, Place, Country, city etc.
entities.eventsJSONArray StringNamed hurricanes, battles, wars, sports events, etc.
entities.cardinalJSONArray StringNumerals that do not fall under another type.
entities.ordinalJSONArray StringOrdinals (e.g., "first", "1st").
entities.emailJSONArray StringGet email Id from article text.
entities.linkJSONArray StringGet URL/Link from article text.

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":[],
      "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"
  
}

People 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).
People With Knowledge Base response JSON structure.

NameTypeDescription
nameStringPerson name
categoryStringRelated Profession/Category
eventsJSONArray StringUpcoming and Latest event of person.

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",
 }]
}