Page History

Operates On:  Lexical Items with TOKEN and TEXT_BLOCK.

Configuration Parameters

• Parameter
  summary Model name registered in the python bridge name modelName required true

• Parameter
  summary Model version registered in the python wrapper to query default latest name modelVersion

• Parameter
  summary Model method to call for the model name modelMethod required true

• Parameter
  summary Python server communication hostname default localhost name hostname

• Parameter
  summary Python server communication port default 5000 name port

• Parameter
  summary Expected content for this model are tokens default false name sendTokens type boolean

• Parameter
  summary Include text of tokens flagged as vertices default false name includeVertexText type boolean

"dependencyTags": [],
"modelName": "bert-base-nli-stsb-mean-tokens",
"modelVersion": "1",
"modelMethod": "predict",
"normalizeTags": false,
"hostname": "localhost",
"port": 5000,    

Example Output

The output of the Watcher Stage is at the metadata of the vertex flagged as the trigger, for this example it is the EOF but it could be configured to work with TEXT_BLOCK_SPLIT or any other flag.

V--------------[abraham lincoln likes macaroni and cheese]--------------------V <=== EOF, at this vertex's metadata is the embedded vector
^--[abraham]--V--[lincoln]--V--[likes]--V--[macaroni]--V--[and]--V--[cheese]--^
              ^---{place}---^           ^----{food}----^         ^---{food}---^
^----------{person}---------^           ^-----------------{food}--------------^

Output Flags

Lex-Item Flags:

• SEMANTIC_TAG - Identifies all lexical items which that are semantic tags.
• PROCESSED - Placed on all the tokens which composed the semantic tag.
• ALL_LOWER_CASE - All of the characters in the token are lower-case characters.
• ALL_UPPER_CASE - All of the characters in the token are upper-case characters (for example, acronyms).
• ALL_DIGITS - All of the characters in the token are digits (0-9)
• TITLE_CASE - The first character is upper case, all of the other characters are lower case.
• MIXED_CASE - Handles any mixed upper & lower case scenario not covered above.
• TOKEN - All tokens produced are tagged as TOKEN 
• CHAR_CHANGE -  Identifies the vertex as a change between character formats
• HAS_DIGIT - Tokens produced with at least one digit character are tagged as HAS_DIGIT 
• HAS_PUNCTUATION - Tokens produced with at least one punctuation character are tagged as HAS_PUNCTUATION. (ALL_PUNCTUATION will not be tagged as HAS_PUNCTUATION)
• LEMMATIZE- All words retrieved will be marked as LEMMATIZE
• NUMBER - Flagged on all tokens which are numbers according to the rules above.
• ML_PREDICT- Result from a machine learning algorithm for prediction
• ML_CLASSIFY- Result from a machine learning algorithm for classification
• ML_REGRESS- Result from a machine learning algorithm for regression
• TEXT_BLOCK - Flags all text blocks.
• STOP_WORD- All matched stop words will be marked as STOP_WORD
• WEIGHT_VECTOR - Identifies the tag as a weight vector representation of a sentence
• BANK- Identifies a Bank account number.
• ABA- Account number with ABA format.
• BIC- Account number with BIC format.
• IBAN- Account number with IBAN format.
• ORIGINAL - Identifies that the Lex-Items produced by this stage are the original, as written, representation of every token (e.g. before normalization)
• SSN - Identifies a Federal ID number
• GEONAME - Identifies a geographical location name

Vertex Flags:

• ALL_PUNCTUATION - Identifies the vertex as all token
  • The default flag if no "splitFlag" is present.
• <splitFlag> - Defines an alternative flag to ALL_PUNCTUATION, if desired (see above)
• CHAR_CHANGE -  Identifies the vertex as a change between character formats
• TEXT_BLOCK_SPLIT - Identifies the vertex as a split between text blocks.
• OVERFLOW_SPLIT - Identifies that an entire buffer was read without finding a split between text blocks.
  • The current maximum size of a text block is 64K characters.
  • Text blocks larger than this will be arbitrarily split, and the vertex will be marked with "OVERFLOW_SPLIT"\
• ALL_WHITESPACE - Identifies that the characters spanned by the vertex are all whitespace characters (spaces, tabs, new-lines, carriage returns, etc.)

Resource Data

Description of resource.

Resource Format

"_id" : "KGAAJGsBemSwA0nZTLXA",
"tag": "recipe",
"pattern": "("how many"|"how much") {ingredient} ",
"confAdjust": 0.95

. . . additional fields as needed go here . . . 

Fields

• Parameter
  summary What to show the user when browsing this entity name display required true

• Parameter
  summary Tag which will identify any match in the graph, as an interpretation name tag required true

  • 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 Pattern to match in the content name pattern required true

Generic Resource Fields

• WEIGHT_VECTOR - Identifies the text block related to this vertex as a weight vector representation