Page History

...

• Parameter
  summary Identifies the entity by unique ID. This identifier must be unique across all entries (across all dictionaries). name id required true

  
  
  • Typically, this is an identifier with meaning to the larger application that is using the Language Processing Toolkit.

• Parameter
  summary The list of semantic tags that will be added to the interpretation graph whenever any of the patterns are matched. name tags type string array required true

  
  
  • These will be added to the interpretation graph with the SEMANTIC_TAG flag.

• Parameter
  summary A list of patterns to match in the content. name patterns type string array required true

  
  

• Parameter
  summary When this flag is specified then the input string that specifies the pattern is treated as a sequence of literal characters. Metacharacters or escape sequences in the input sequence will be given no special meaning. default false name literal

• Parameter
  summary Set to true if the pattern is not case sensitive. default true name caseInsensitive type boolean

• Parameter
  summary Specifies the confidence level of the entity, independent of any patterns matched. name confidence type double

  
  
  • This is the confidence of the entry, in comparison to all of the other entries. Essentially, the likelihood that this entry will be encountered randomly.

Other Optional Fields

• display (optional, string) -

  Parameter
  summary

  What to show the user when browsing the entity.

  name display

• context (optional, object) -

  Parameter
  summary

  A context vector that helps disambiguate the entity from others with the same pattern. name context

  
  
  • Format TBD, but probably a list of weighted words, phrases and tags.

...