Identifies patterns with a combination of any number of specified tokens, regardless of the surrounding tokens.


Operates On:  Lexical Items with TOKEN or SEMANTIC_TAG and other possible flags as specified below, but not on TEXT_BLOCK.

Stage is a Recognizer for Saga Solution, and can also be used as part of a manual pipeline or a base pipeline


Generic Configuration Parameters

  • boundaryFlags ( type=string array | optional ) - List of vertex flags that indicate the beginning and end of a text block.
    Tokens to process must be inside two vertices marked with this flag (e.g ["TEXT_BLOCK_SPLIT"])
  • skipFlags ( type=string array | optional ) - Flags to be skipped by this stage.
    Tokens marked with this flag will be ignored by this stage, and no processing will be performed.
  • requiredFlags ( type=string array | optional ) - Lex items flags required by every token to be processed.
    Tokens need to have all of the specified flags in order to be processed.
  • atLeastOneFlag ( type=string array | optional ) - Lex items flags needed by every token to be processed.
    Tokens will need at least one of the flags specified in this array.
  • confidenceAdjustment ( type=double | default=1 | required ) - Adjustment factor to apply to the confidence value of 0.0 to 2.0 from (Applies for every pattern match).
    • 0.0 to < 1.0  decreases confidence value
    • 1.0 confidence value remains the same
    • > 1.0 to  2.0 increases confidence value
  • debug ( type=boolean | default=false | optional ) - Enable all debug log functionality for the stage, if any.
  • enable ( type=boolean | default=true | optional ) - Indicates if the current stage should be consider for the Pipeline Manager
    • Only applies for automatic pipeline building

Configuration Parameters

  • patterns ( type=string | required ) - The resource that contains the pattern database.

In version 1.2.2 this parameter was added:

  • preferLarge ( type=boolean | default=true | optional ) - If true the stage will prefer larger patterns

$action.getHelper().renderConfluenceMacro("$codeS$body$codeE")

Example Output

$action.getHelper().renderConfluenceMacro("$codeS$body$codeE")

Output Flags

Lex-Item Flags:

  • SEMANTIC_TAG - Identifies all lexical items that are semantic tags.
  • FRAGMENT- Identifies all lexical items that were created from a fragmentation pattern.

Vertex Flags:

No vertices are created in this stage


Resource Data

The resource data is a database of fragmented patterns, and the resulting semantic tags they produce.

Resource Format

The only required file is the entity dictionary. It is a series of JSON records, typically indexed by entity ID.

Description of entity

Entity JSON Format 

$action.getHelper().renderConfluenceMacro("$codeS$body$codeE")

Entity JSON Format
"_id" : "KGAAJGsBemSwA0nZTLXA",
"tag":["recipe"],
"pattern": "{number} {ingredient}",
"options": {
  "minTokens": 3,
  "maxTokens": 2,
  "combination": true
}
"confAdjust":0.95
 
. . . additional fields as needed go here . . .
  • Multiple entries can have the same pattern. If the pattern is matched, then it will be tagged with multiple (ambiguous) entry IDs.
  • Additional fielded data can be added to the record; as needed by downstream processes.


Fields

  • tag ( type=string | required ) - Tag which will identify any match in the graph, as an interpretation

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

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

  • pattern ( type=string | required ) - Pattern to match in the content

  • options ( type=json | optional ) - Object with options applicable for this entity
    • minTokens ( type=integer | optional ) - Minimum number of tokens the match must contains to be valid. The default is the number of tokens contained in each pattern.
    • maxTokens ( type=integer | optional ) - Maximum number of tokens the match must contain to be valid. The default is the number of tokens contained in each pattern
    • combination ( type=string | default=true | optional ) - ndicates if the given tokens can be matched in any order as long as all appear in the match. If false, the tokens must be in the order provided.

  • _id ( type=string | required ) - Identifies the entity by unique ID. This identifier must be unique across all entries (across all dictionaries).

  • confAdjust ( type=boolean | required ) - Adjustment factor to apply to the confidence value of 0.0 to 2.0

    • This is the confidence of the entry, in comparison to all of the other entries. (Essentially, the likelihood that this entity will be randomly encountered.)
    • 0.0 to < 1.0  decreases confidence value
    • 1.0 confidence value remains the same
    • > 1.0 to  2.0 increases confidence value
  • updatedAt ( type=date epoch | required ) - Date in milliseconds of the last time the entry was updated
  • createdAt ( type=date epoch | required ) - Date in milliseconds of the creation time of the entry

  • No labels