CharacterSplitter Stage

Splits tokens on specified characters, typically punctuation. Multiple split characters in a row will create a single split (not multiple splits).

Operates On: Lexical Items with TOKEN

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

splitChars (string, optional) - List of characters which should be used to split tokens.
- If not present, then tokens are split on any sequence of punctuation.
dontSplitChars (string, optional) - List of characters which will NOT be used to split tokens.
- This is typically used to identify exceptions (characters which are not used to split tokens) when splitChars is missing.
- These characters are included in the produced tokens.
splitFlag (string, optional) - The flag to be put on the vertex between the two tokens.
- If missing, defaults to ALL_PUNCTUATION.

Examples

Example Configuration 1

{
 "type":"CharacterSplitter",
 "dontSplitChars":"."
}

Splits on all punctuation, except periods.

For example, the token: "SagaToolkit-1.0" will produce the following graph:

V-------[SagaToolkit-1.0]-------V
 ^---[SagaToolkit]--V--[1.0]----^

Example Configuration 1

{
  "type":"CharacterSplitter",
  "splitChars":"-",
  "splitFlag":"DASH_SPLIT"
}

(splits tokens dashes)

Output Flags

Lex-Item Flags:

TOKEN - All tokens produced are tagged as TOKEN

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)

Example

With Defaults

V-----[Abe-Lincoln]-----V--[likes]--V--[the]--V-----[iPhone-*&@#*&7.0]-----V
^--[Abe]--V--[Lincoln]--^                     ^--[iPhone]--V--[7]--V--[0]--^

With Don't Split Param

{
	"type":"CharacterSplitter",
	"dontSplitChars": "."
}

V-----[Abe-Lincoln]-----V--[likes]--V--[the]--V--[iPhone-*&@#*&7.0]--V
^--[Abe]--V--[Lincoln]--^                     ^--[iPhone]--V--[7.0]--^

With Split Chars Param

{
	"type":"CharacterSplitter",
	"splitChars": "-#."
	"dontSplitChars": "."
}

V-----[Abe-Lincoln]-----V--[likes]--V--[the]--V--------[iPhone-*&@#*&7.0]--------V
^--[Abe]--V--[Lincoln]--^                     ^--[iPhone]--V--[*&@]--V--[*&7.0]--^

Page tree