Detect federal identifications such as U.S. SSN, Canada SIN, UK NINo and Costa Rica cédula.
Operates On: Lexical Items with TOKEN and possibly other flags as specified below.
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
Example Output
The following shows sample output of the following formats.
V-------------------123-45-6788 123-456-782 AA123456C 1-1234-1234 001-01-0001 899-99-9999 000-000-000 999-999-998 123456782 112341234]------------------------V
^--[123-45-6788]--V--[123-456-782]--V-[AA123456C]-V--[1-1234-1234]--V--[001-01-0001]--V--[899-99-9999]--V--[000-000-000]--V--[999-999-998]--V---[112341234]---^
^-----[{SSN}]-----^-----[{SSN}]-----^---[{SSN}]---^-----[{SSN}]-----^-----[{SSN}]-----^-----[{SSN}]-----^-----[{SSN}]-----^-----[{SSN}]-----^-----[{SSN}]-----^
Output Flags
Lex-Item Flags:
- SSN - Identifies a Federal ID number
- SEMANTIC_TAG - Identifies all lexical items which are semantic tags.
Vertex Flags: