Versions Compared

Key

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

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

Note

This stage extends from the Dictionary Tagger Stage.


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

Saga_is_recognizer

Note

This stage extends from the Dictionary Tagger Stage.

Include Page
Generic Configuration Parameters
Generic Configuration Parameters

Configuration Parameters

  • Parameter
    summary Use

...

  • to matching only a percentage of the words present in the pattern, only if active on the pattern.
    default50
    namepartialMatchPercent
    typeinteger
Saga_config_stage
skip
boundaryFlagstext block split
requiredFlagstoken, semantic tag
titleskipFlagsDefault ConfigskipFlagsstop word
"partialMatchPercent": 50

Example Output

Description

Saga_graph
V-------[Welcome to Accenture.]--------V 
^-----[Welcome to Accenture]------V-[]-^ 
^-[Welcome]-V-[to]-V-[Accenture]--^      
^-[welcome]-^      ^-[accenture]--^      
                   ^-[{bestbets}]-^      

Output Flags

Lex-Item Flags:

...

  • PROCESSED - Placed on all the tokens which composed the semantic tag.
  • 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:

Info

No vertices are created in this stage


Resource Data

This stage is an extension of a Dictionary Tagger Stage and so the resource structure behaves in the same way.

Fields

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:

Saga_json
TitleEntity Json Format
"usePartialMatch": true,
"patterns": "something1, something2, somnething3",
"description": "Description of the bestbets",
"tag": "search-bet",
"title": "the best bet title",
"url": "http://accenture.enterpricesearch.org",
"confAdjust": 1
. . . additional fields as needed go here . . . 

Fields

  • Parameter
    summaryTag which will identify any match in the graph, as an interpretation
    nametag
    requiredtrue
  • id(required, string) - Identifies the entity by unique ID. This identifier must be unique across all entities (across all dictionaries).
    • 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 that will be added to the interpretation graph whenever any of the patterns are matched.
    • These will all be added to the interpretation graph with the SEMANTIC_TAG flag.

      Typically, multiple tags
      Tip

      Tags are hierarchical representations of the same intent.

       

      For example, {city} → {administrative-area} → {geographical-area}

  • patterns(required, array of string) -
    Parameter
    summary
    A list of patterns to match in the content
    .
    namepatterns
    typestring array
    • Patterns will be tokenized and there may be multiple variations which can match.
  • 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.
  • Title:
    Parameter
    summary
    this text will appear as the hit title in the search results page in ESUI
    Description: this
    nametitle
    requiredtrue
  • Parameter
    summaryThis text will appear as the hit description in the search results page in ESUI
    namedescription
    requiredtrue
     
  • Parameter
    summaryThe URL
    URL: the URL
    where ESUI will navigate to when the user click the title in the search results page in ESUI
    nameurl
    requiredtrue
  • Use partial matching:
    Parameter
    summary
    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%.

Other, Optional Fields

  • defaultfalse
    nameusePartialMatch
    typeboolean
  • display(optional, string) -
    Parameter
    summary
    What to show the user when browsing this entity
    .context(optional, object) -
    namedisplay
  • Parameter
    summaryA context vector that can help disambiguate this entity from others with the same pattern
    .
    namecontext

Include Page
Generic Resource Fields
Generic Resource Fields