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:
Name | Description |
---|---|
BRANDS | Vehicles, weapons, foods, etc. (not services). |
BRANDS WITH KNOWLEDGE BASE | Brand Entity with some additional information like – Brand Category With Knowledge Base. |
LAWS | Named documents made into laws. |
QUANTITY | Measurements, as of weight or distance. |
LANGUAGES | Any named language (language name occure in article/text). |
ART NAME | Titles of books, songs, etc. |
GROUPS | Nationalities or religious or political groups. |
DATES | Get date terms, Absolute or relative dates or periods. |
PERCENTS | Percentage (including “%”). |
PEOPLE | Name of People, including fictional. |
PEOPLE WITH KNOWLEDGE BASE | People Entity with some additional information like – Person Category there upcoming and latest events. Ref- People With Knowledge Base. |
TIMES | Get time terms, Times smaller than a day. |
MONEY | Monetary values, including unit. |
ORGANIZATIONS | Name of Companies, agencies, institutions, Organization etc. |
ORGANIZATIONS WITH KNOWLEDGE BASE | Organization Entity with some additional information like – Organization Category With Knowledge Base. |
LOCATIONS | Name of Location, Place, Country, city etc. |
LOCATIONS WITH KNOWLEDGE BASE | Location Entity with some additional information like – Location Category With Knowledge Base. |
EVENTS | Named hurricanes, battles, wars, sports events, etc. |
CARDINAL | Numerals that do not fall under another type. |
ORDINAL | Ordinals (e.g., “first”, “1st”). |
Get email Id from article text. | |
LINK | Get URL/Link from article text. |
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.
URL | Description |
---|---|
PUT /textanalysis/v1/entities | Put URL, Articles or Text for entity analysis. |
GET /textanalysis/v1/entities/{UID} | Get Entities from URL, Articles or Text. |
PUT /textanalysis/v1/entities
PUT https://launch.amplifyreach.com/textanalysis/v1/entities
Headers:
Name | Description |
---|---|
Content-Type | application/json |
authToken | YOUR_DEVELOPER_ACCESS_TOKEN |
cid | YOUR_DEVELOPER_ID |
Body:
|
OR |
|
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.
Name | Type | Description |
---|---|---|
status | String | Request Status (Reference: Status & Error Codes article) |
uid | String | UID is unique request identifier ID which to get result in Get API. |
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
Content-Type | application/json |
authToken | YOUR_DEVELOPER_ACCESS_TOKEN |
cid | YOUR_DEVELOPER_ID |
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.
Name | Type | Description |
---|---|---|
status | String | Request Status (Reference: Status & Error Codes ) |
entities | JSONObject | Contains multiple entity object. Like- People, Location, Date etc. |
entities.brands | JSONArray String | Vehicles, weapons, foods, etc. (not services). |
entities.laws | JSONArray String | Named documents made into laws. |
entities.quantity | JSONArray String | Measurements, as of weight or distance. |
entities.languages | JSONArray String | Any named language (language name occure in article/text). |
entities.artName | JSONArray String | Titles of books, songs, etc. |
entities.groups | JSONArray String | Nationalities or religious or political groups. |
entities.dates | JSONArray String | Get date terms, Absolute or relative dates or periods. |
entities.percents | JSONArray String | Percentage (including “%”). |
entities.people | JSONArray String | Name of People, including fictional. |
entities.peopleWithKnowledgeBase | JSONArray People With KnowledgeBase | Ref: People With Knowledge Base. |
entities.locationWithKnowledgeBase | JSONArray Object | Location With Knowledge Base. |
entities.orgWithKnowledgeBase | JSONArray Object | Organization With Knowledge Base. |
entities.brandWithKnowledgeBase | JSONArray Object | Brand With Knowledge Base. |
entities.times | JSONArray String | Get time terms, Times smaller than a day. |
entities.money | JSONArray String | Monetary values, including unit. |
entities.organizations | JSONArray String | Name of Companies, agencies, institutions, Organization etc. |
entities.locations | JSONArray String | Name of Location, Place, Country, city etc. |
entities.events | JSONArray String | Named hurricanes, battles, wars, sports events, etc. |
entities.cardinal | JSONArray String | Numerals that do not fall under another type. |
entities.ordinal | JSONArray String | Ordinals (e.g., “first”, “1st”). |
entities.email | JSONArray String | Get email Id from article text. |
entities.link | JSONArray String | Get 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":[],
"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.
Name | Type | Description |
---|---|---|
name | String | Person name |
category | String | Related Profession/Category |
events | JSONArray String | Upcoming 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",
}]
}