Creates a new token from the original but excluding the characters on the "characters" list parameter.

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

Stage can only 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

  • characters ( type=string | default=_‿⁀⁔︳︴﹍﹎﹏＿ | optional ) - Text containing all the character that will be collapse
    • Each character in this text will be omitted in the new lexical item created
  • caseInsensitive ( type=string | default=false | optional ) - Indicates if the characters to collapse are case insensitive


"characters":";-!:",
"caseInsensitive": false

Example Output

 V---------------[e-5s Hello World! We need: one, two, three]---------------V 
 ^-[e-5s]-V-[Hello]-V-[World!]-V-[We]-V-[need:]-V-[one,]-V-[two,]-V-[three]-^ 
 ^-[e5s]--^-[hello]-^-[world!]-^-[we]-^-[need]--^ 
                    ^-[World]--^ 
                    ^-[world]--^

Output Flags

Lex-Item Flags:

  • COLLAPSED - Identifies all lexical items which were created from committing characters.
  • TOKEN - All tokens produced are tagged as TOKEN.
  • ALL_PUNCTUATION - Tokens processed or produced composed only of punctuation characters are tagged as ALL_PUNCTUATION.
  • 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).
  • ALL_DIGITS -  All characters in the token are digits.
  • HAS_LETTER - At least one character is a letter.
  • ALL_LETTERS - All characters in the token are letters.


Vertex Flags:

No vertices are created in this stage

  • No labels