Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Include Page
Generic Configuration Parameters
Generic Configuration Parameters

Configuration Parameters

  • patterns (string, required) -
    Parameter
    summary
    The resource containing the pattern database
    .
    • See below for the format.
    namepatterns
    requiredtrue
    • For the format see below.


Saga_config_stage
"
Code Block
languagejs
themeEclipse
titleExample Configuration
{
 "type":"SimpleRegex",
 "patterns":"regex-provider:patterns"
}

Example Output

In the following example, "number" is in the dictionary as a regex for using "[0-9]+" and "[0-9]+\\.[0-9]+" :

...

Each JSON record represents an entity. The format is as follows:

Saga_json
Code Block
languagejs
themeEclipse
titleEntity JSON Format
{
    "_id" : "ca84KGAAJGsBemSwA0nZTLXA",
    "tagstag" : [ 
        "number"
    ],
    "patternspattern" : [ 
        "[0-9]+", 
        "[0-9]+\\.[0-9]+",
"options" :   ],{
    "confidencecaseInsensitive" : 0.95
	true,
  "literal" : false
},
	"caseInsensitiveconfAdjust": true
}0.95
. . . additional fields as needed go here . . .

Notes

  1. Multiple patterns can have the same entry.
  2. Additional fielded data can be added to the record.
    • As needed by downstream processes.

...

  • Parameter
    summaryIdentifies the entity by unique ID. This identifier must be unique across all entries (across all dictionaries).
    name_id
    requiredtrue
    Typically, this is an identifier with meaning to the larger application that is using the Language Processing Toolkit.
  • Parameter
    summaryThe list of semantic tags that will be added to the interpretation graph whenever any of the patterns are matched.Tag which will identify any match in the graph, as an interpretation
    nametagstag
    typestring array
    requiredtrue

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

      Tip

      Tags are hierarchical representations of the same intent. For example, {city} → {administrative-area} → {geographical-area}

  • Parameter
    summary

    A list of patterns

    Pattern to match in the content

    .

    name

    patterns

    pattern

    typestring array

    requiredtrue

  • Options
    • Parameter
      summaryWhen 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.
      defaultfalse
      nameliteral
    • Parameter
      summarySet to true if the pattern is not case sensitive.
      defaulttrue
      namecaseInsensitive
      typeboolean
    parameter

Include Page

...

summarySpecifies the confidence level of the entity, independent of any patterns matched.
nameconfidence
typedouble
  • 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.

Generic Resource Fields
Generic Resource Fields

Other Optional Fields

...

Parameter
summaryWhat to show the user when browsing the entity.
namedisplay
Parameter
summaryA context vector that helps disambiguate the entity from others with the same pattern.
namecontext

...