entity_annotation

Prev Next

entity_annotation

usage: uncommon - datatype: array


The entity_annotation attribute allows users to specify categorical and numeric information to be returned with every entity pertinent to the analysis result for each analysis_variable. The entity_annotation attribute takes an array including one or more variable objects representing collections. If the entity_annotation attribute is an empty array, the only information returned for each entity will be its Tag.cortex unique ID.

"entity_annotation": [
  {
    "variable_type": "numeric",
    "collection": "ccc1" //Where "ccc1" is a collection of numeric variables in tag.cortex
  },
  {
    "variable_type": "categorical",
    "collection": "ccc2" //Where "ccc2" is a collection of categorical variables in tag.cortex
  },
  ...
]