Overview
TODO
Format
Code Block |
---|
TODO |
Legacy documentation:
...
This toolkit element enables the generation of one of more types of associaton between existing entities 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
Code Block |
---|
{
"display": string,
"associations": [
{
"iterateOver" : "string", // OPTIONAL: If specified as a list of entity types, steps over entities with matching types (again, lock step or combinatorially)
// Can also specify a metadata field (nesting supported using dot notation), in which case they are looped over to generate calls with _value/_iterator/_index
"entity1" : "string", // OPTIONAL: String/script: In "iterateOver"/type cases, the disambiguated name of the entity type; otherwise using entity1_index is preferred.
"entity1_index" : "string", // OPTIONAL: String/script: should return the 'disambiguated_name/type' string, must resolve to an entity or is discarded
"entity2" : "string", // OPTIONAL: String/script: In "iterateOver"/type cases, the disambiguated name of the entity type; otherwise using entity1_index is preferred.
"entity2_index" : "string", // OPTIONAL: String/script: should return the 'disambiguated_name/type' string, must resolve to an entity or is discarded
"verb" : "string", // MANDATORY: String/script
"verb_category" : "string", // MANDATORY: String/script
"assoc_type" : "string", // MANDATORY: Must specify/return one of "Fact", "Event", "Summary" and be overridden (eg converted to summary if there is only 1 index)
// (if left blank, the Structured Analysis Handler will auto-generate this field reasonably accurately based on the contents)
"time_start" : "string", // OPTIONAL: String/script: Must specify/return a time in ISO date format ("yyyy-MM-dd'T'HH:mm:ss") or Javascript time format
"time_end" : "string", // OPTIONAL: String/script: Must specify/return a time in ISO date format ("yyyy-MM-dd'T'HH:mm:ss") or Javascript time format
"geo_index" : "string", // OPTIONAL: String/script: The entity index corresponding to the "geotag" below (or the Type in "iterateOver" cases)
"geotag" : { // OPTIONAL: Format is identical to the docGeo format specified above
"lat": "string", "lon": "string,
"city": "string", "stateProvince": "string, "country": "string", "countryCode": "string
},
//(note the ontology_type for associations is always "point" - use geo_index to specify larger areas)
"creationCriteriaScript" : "string", // // OPTIONAL: script: If populated, runs a user script function and if return value is false doesn't create the object
}
]
} |
Legacy documentation:
- StructuredAnalysis object (under "Associations")
TODO
Description
Legacy documentation:
TODO
Examples
TODO