Page History

...

• id(required, string) - Identifies the entity by unique ID. This identifier must be unique across all entities (across all dictionaries).
  • Typically, this is an identifier with meaning to the larger application which is using the Language Processing Toolkit.
• tags(required, array of string) - The list of semantic tags that will be added to the interpretation graph whenever any of the patterns are matched.
  • These will all be added to the interpretation graph with the SEMANTIC_TAG flag.
  • Typically, multiple tags are hierarchical representations of the same intent.  For example, {city} → {administrative-area} → {geographical-area}
• patterns(required, array of string) - A list of patterns to match in the content.
  • Patterns will be tokenized and there may be multiple variations which can match.
• confidence(optional, float) - Specifies the confidence level of the entity, independent of any patterns matched.
  • This is the confidence of the entity, in comparison to all of the other entities. Essentially, the likelihood that this entity will be randomly encountered.
• Title: this text will appear as the hit title in the search results page in ESUI
• Description: this text will appear as the hit description in the search results page in ESUI
• URL: the URL where ESUI will navigate to when the user click the title in the search results page in ESUI
• Use partial matching: If true, when a pattern is composed of several words, the matching will only use a percentage of the words present in the pattern.  This percentage can be configured in the recognizer settings, by default is set to 50%.

...

• display(optional, string) - What to show the user when browsing this entity.context(optional, object) - A context vector that can help disambiguate this entity from others with the same pattern.
• Format TBD, but probably a list of weighted words, phrases and tags.