This stage identifies tokens that look like postal codes and flag them as "POSTCODE". The stage support codes up to 5 characters length, so this includes US, UK and Canada, as well as any other country with similar standards.
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
-
countries ( type=string array
| default=["us", "uk", "ca"]
| optional
)
- List of country codes separated by white space
"countries" : ["us", "uk", "ca"]
Example Output
V---------------------[Send the package to 32830 near the amusement parks.]----------------------V
^-------------------[Send the package to 32830 near the amusement parks]--------------------V-[]-^
^-[Send]-V-[the]-V-[package]-V-[to]-V----[32830]---V-[near]-V-[the]-V-[amusement]-V-[parks]-^
^-[send]-^ ^-[{postcode}]-^
V-----------------[301 Front St W, Toronto, ON M5V 2T6, Canada]-----------------V
^-[301]-V-[Front]-V-[St]-V-[W,]-V-[Toronto,]-V-[ON]-V-[M5V]-V-[2T6,]-V-[Canada]-^
^-[W]--^-[Toronto]--^ ^-[2T6]--^
^--[{postcode}]--^
Output Flags
Lex-Item Flags:
- SEMANTIC_TAG - Identifies all lexical items which are semantic tags.
- POSTCODE - Identifies the token as a postcode.
Vertex Flags: