Overview
This toolkit element enables the generation of one or more types of entity based on the document or content metadata. The expressions default to replacement strings, or $SCRIPT(...) can be used to return a string using javascript.
TODO
Format
{
"display": string,
"entities": [
{
"iterateOver" : "string", // OPTIONAL: If specified, a metadata field (nesting supported using dot notation) which is looped over to generate calls with _value/_iterator/_index
"disambiguated_name" : "string", // MANDATORY: String/script, the disambiguated name of the entity
"actual_name" : "string", // OPTIONAL: String/script, the actual name of the entity if different to the disambiguated name
"dimension" : "string", // MANDATORY: String/script: Must be/return one of "Who", "What", "Where"
"type" : "string", // MANDATORY: String/script: It is recommended to use a type from the
// OpenCyc, AlchemyAPI, or OpenCalais ontologies, for compatibility with future Infinit.e features
"linkdata": "string", // OPTIONAL: if present should return a comma-separated list of URLs (commas should be URL-encoded)
"relevance" : "string", // OPTIONAL: String/script: Must specify/return a double/string-parsable-into-a-double
"sentiment" : "string", // OPTIONAL: String/script: Must specify/return a double/string-parsable-into-a-double, by convention this is between -1.0 and 1.0.
"frequency" : "string", // OPTIONAL: Must specify/return a long/string-parsable-into-a-long
"geotag" : { // OPTIONAL: Format is identical to the docGeo format specified above
"lat": "string", "lon": "string,
"city": "string", "stateProvince": "string, "country": "string", "countryCode": "string
},
"ontology_type": "string", // OPTIONAL: String/script: Only used if geotag is specified:
// allows specification of the scale of the geographic entity (see below for useful link), defaults to "point"
"useDocGeo": "boolean", // OPTIONAL: If true, uses any lat/long generated from the top level "docGeo" specification, defaults to false
"creationCriteriaScript" : "string", // OPTIONAL: script: If populated, runs a user script function and if return value is false doesn't create the object
}
]
}
Description
Entities are the who, what, and where's contained within a record (i.e. people, places, and things).
Data is extracted from the source using the $ operator.
Extracting Entities From Arrays
You can use manual entities with iterateOver to create an entity for each object in the array, when the document metadata contains an array for a specific metadata field.
Source
In the example below, the source for entities has been configured to iterateOver the document metadata "victims."
},
{
"dimension": "Who",
"disambiguated_name": "$FUNC( getVictim(); )",
"frequency": "$FUNC( getVictimCount(); )",
"type": "VictimType",
"useDocGeo": false,
"iterateOver": "victim"
},
{
"dimension": "Who",
"disambiguated_name": "$FUNC( getVictim(); )",
"frequency": "$hostagecount",
"type": "HostageType",
"useDocGeo": false,
"iterateOver": "victim"
}
]
},
Sample Output
In the sample output you can see some of the entities outputted based on the example source. The entities have been created based on the array that was returned for the metadata field "victim."
},
{
"actual_name": "Targeted, Civilian, Adult from Afghanistan",
"dimension": "Who",
"disambiguated_name": "Targeted, Civilian, Adult from Afghanistan",
"doccount": 0,
"frequency": 5,
"index": "targeted, civilian, adult from afghanistan/victimtype",
"relevance": 0,
"totalfrequency": -1,
"type": "VictimType"
},
{
"actual_name": "Targeted, Civilian, Child from Afghanistan",
"dimension": "Who",
"disambiguated_name": "Targeted, Civilian, Child from Afghanistan",
"doccount": 0,
"frequency": 2,
"index": "targeted, civilian, child from afghanistan/victimtype",
"relevance": 0,
"totalfrequency": -1,
"type": "VictimType"
},
Metadata
The metadata was used by Manual entities to create the two entities for metadata value "victim."
"victim": [
{
"child": "No",
"combatant": "No",
"deadcount": "1",
"definingcharacteristic": "Unknown",
"hostagecount": "0",
"indicator": "Targeted",
"nationality": "Afghanistan",
"targetedcharacteristic": "Unknown",
"victimtype": "Civilian",
"woundedcount": "4"
},
{
"child": "Yes",
"combatant": "No",
"deadcount": "2",
"definingcharacteristic": "Unknown",
"hostagecount": "0",
"indicator": "Targeted",
"nationality": "Afghanistan",
"targetedcharacteristic": "Unknown",
"victimtype": "Civilian",
"woundedcount": "0"
}
],