Page History

...

• id (required, string) - Identifies the entity by unique ID. This identifier must be unique across all entities (across all dictionaries) regardless of the type.
  • 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 which will be added to the interpretation graph whenever any of the patterns are matched.
  • These will all be matched with the SEMANTIC_TAG flag.
• 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.
    (details TBD)
    • NOTE:  Currenty, tokens are separated on simple white-space and punctuation, and then reduced to lowercase.
    • TODO:  This will need to be improved in the future, perhaps by specifying a pipeline to perform the tokenization and to allow for multiple variations.
  • 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.

  ...

  To improve performance especially for every large databases of entities, the entity dictionary is inverted and indexed.

  This currently happens in RAM inside the DictionaryTagger stage. An off-line option for pre-inverting the dictionary will be provided in the future.