This stage maintains a list tokens used to identify possible subjects of interest and suggest a URL reference along with "title" and "description". The title and description fields are used as display data.

Operates On:  Lexical Items with TOKEN and possibly other flags as specified below.

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


This stage extends from the Dictionary Tagger Stage.

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

  • partialMatchPercent ( type=integer | default=50 | optional ) - Use to matching only a percentage of the words present in the pattern, only if active on the pattern.

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

Example Output

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

Output Flags

Lex-Item Flags:

  • BESTBET - Identifies that the token as a possible reference to a subject to which Saga has a link for.
  • SEMANTIC_TAG - Identifies all lexical items which are semantic tags.

Vertex Flags:

No vertices are created in this stage


Resource Data

The pattern database is a series of JSON records, typically indexed by "pattern block ID".  Each JSON record represents a block of patterns (one or more) that all produce the same semantic tag.  The format is as follows: $action.getHelper().renderConfluenceMacro("$codeS$body$codeE")

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}

  • patterns ( type=string array | optional ) - A list of patterns to match in the content
    • Patterns will be tokenized and there may be multiple variations which can match.
  • title ( type=string | required ) - this text will appear as the hit title in the search results page in ESUI
  • description ( type=string | required ) - This text will appear as the hit description in the search results page in ESUI 
  • url ( type=string | required ) - The URL where ESUI will navigate to when the user click the title in the search results page in ESUI
  • usePartialMatch ( type=boolean | default=false | optional ) - 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 ( type=string | optional ) - What to show the user when browsing this entity
  • context ( type=string | optional ) - A context vector that can help disambiguate this entity from others with the same pattern

  • _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