Some of the PII entities extract components as well as whole matches. Components are parts of a match that can provide useful information. For example, the entity for an address can return components for the street and postcode.
NOTE: The post-processing script requires components. The default PII configuration file enables components. If you use a custom configuration file you must set the EnableComponents
parameter to True
to return components.
The following tables list the components available for particular entities.
Component Name | Notes |
---|---|
APARTMENT | |
APARTMENT_BUILDING | tr and za |
APARTMENT_PREFIX | ca only |
BLOCK | br only |
CITY | |
COUNTRY | |
COUNTY | gb only |
FLOOR | ca, us, tr, and za |
INTERSECTING_STREET | za only |
MUNICIPALITY | za only |
NUMBER | |
PO_BOX | |
POSTCODE | |
POST_OFFICE | ca, it, lt, no, nz, pt, and za |
PRIVATE_BAG_AGENCY | za only |
PRIVATE_BAG_BOX_NUMBER | za only |
PRIVATE_BAG_NUMBER | za only |
PROVINCE | ca only |
QUADRANT | br only |
REGION | br and za |
SECTOR | br only |
SITE_ID | za only |
SITE_TYPE | za only |
STATE | us and au |
STREET | |
SUBURB | za only |
TOWN | za only |
TOWNSHIP | za only |
VILLAGE_NAME | za only |
The following examples demonstrate the use of these components.
SHS Quadra 4 Bloco D, 70314-000, Brasília, Brazil
SECTOR: SHS QUADRANT: QUADRA 4 BLOCK: BLOCO D CITY: BRASÍLIA POSTCODE: 70314000 COUNTRY: BRAZIL
Avenida João Jorge, 112, apto. 31, Campinas - SP, 13035-680, Brazil
NUMBER: 112 APARTMENT: APT 31 STREET: AVENIDA JOÃO JORGE CITY: CAMPINAS REGION: SP POSTCODE: 13035680 COUNTRY: BRAZIL
2-400 Steeprock Dr Toronto M3J 2X1, Canada
APARTMENT_PREFIX: 2- NUMBER: 400 STREET: STEEPROCK DR CITY: TORONTO POSTCODE: M3J2X1 COUNTRY: CANADA
Çınar mahallesi. Basefendi sok. Küçükyalı Maltepe Asli apt. No:15 Kat 3, Maltepe, 34841 Istanbul, Turkey
APARTMENT_BUILDING: KÜÇÜKYALI MALTEPE ASLI APT STREET: ÇINAR MAHALLESI BASEFENDI SOK NUMBER: 15 FLOOR: KAT:3 POSTCODE: 34841 CITY: ISTANBUL COUNTRY: TURKEY
PO Box 34, DULUTH MN 55803-0034
PO_BOX: 34 CITY: DULUTH STATE: MN POSTCODE: 558030034
PO BOX 90242, AUCKLAND MAIL CENTRE, AUCKLAND, 1142
PO_BOX: 90242 POST_OFFICE: AUCKLAND MAIL CENTRE CITY: AUCKLAND POSTCODE: 1142
70 Park Street West, Hatfield, City of Tshwane, Gauteng
NUMBER: 70
STREET: PARK STREET WEST
SUBURB: HATFIELD
MUNICIPALITY: CITY OF TSHWANE
REGION: GAUTENG
Commission House, corner of Church Avenue and Hill Streets, Pretoria
APARTMENT_BUILDING: COMMISSION HOUSE
INTERSECTING_STREET: CHURCH AVENUE
STREET: HILL STREET
CITY: PRETORIA
Farm 938 Rietfontein 341-JR
SITE_TYPE: FARM
NUMBER: 938
SUBURB: RIETFONTEIN
SITE_ID: 341-JR
Postnet suite 8839, Private Bag X09, WELTEVREDENPARK, 1715
PRIVATE_BAG_AGENCY: POSTNET SUITE
PRIVATE_BAG_BOX_NUMBER: 8839
PRIVATE_BAG_NUMBER: X09
SUBURB: WELTEVREDENPARK
POSTCODE: 1715
110101 Corana, Umtata, 5100
NUMBER: 110101
VILLAGE_NAME: CORANA
TOWN: UMTATA
POSTCODE: 5100
SA Post Office Ltd., PO Box 10 000, PROTEA PARK, 0305
POST_OFFICE: SA POST OFFICE LTD
PO_BOX: 10000
TOWNSHIP: PROTEA PARK
POSTCODE: 0305
123 London Street, Cambridge, Cambridgeshire, CB42AA
NUMBER: 123
STREET: LONDON STREET
CITY: CAMBRIDGE
COUNTY: CAMBRIDGESHIRE
POSTCODE: CB42AA
100 Boulevard Alexis-Nihon, Montreal (Quebec) H4M 2N7
NUMBER: 100
STREET: BOULEVARD ALEXIS NIHON
CITY: MONTREAL
PROVINCE: QUEBEC
POSTCODE: H4M 2N7
Component Name | Notes |
---|---|
ALLEY | tw only |
APARTMENT | |
BLOCK | jp only |
BU_BLOCK | jp only |
COUNTRY | |
CITY | |
CITY_BLOCK | jp only |
CITY_BLOCK_DIRECTION | jp only |
CITY_BLOCK_LANDMARK | jp only |
CITY_BLOCK_NUMBER | jp only |
DISTRICT | tw only |
DISTRICT_DIRECTION | jp only |
DISTRICT_NAME | jp only |
DISTRICT_NUMBER | jp only |
DISTRICT_NUMBER_JIKKAN | jp only |
FLOOR | tw only |
LANE | tw only |
NEIGHBORHOOD | tw only |
NUMBER | |
PO_BOX | |
POSTCODE | |
POST_OFFICE | |
REGION | |
RURAL_AREA |
jp only |
RURAL_SUBUNIT | jp only |
SECTION | tw only |
STREET | tw only |
TOWN | jp only |
TOWNSHIP | tw only |
VILLAGE | |
WARD | jp only |
The following examples demonstrate the use of these components:
日本、〒123-4567神奈川県津島市城南区月形町八重洲四丁目1番2-34号
COUNTRY: 日本 POSTCODE: 1234567 REGION: 神奈川県 CITY: 津島市 WARD: 城南区 TOWN: 月形町 DISTRICT_NAME: 八重洲 DISTRICT_NUMBER: 四 BLOCK: 1 NUMBER: 2 APARTMENT: 34
京都府東筑摩郡音威子府村大字滝沢字住吉6番地の6-22
REGION: 京都府 RURAL_AREA: 東筑摩郡 VILLAGE: 音威子府村 RURAL_SUBUNIT: 大字滝沢字住吉 BLOCK: 6 NUMBER: 6 APARTMENT: 22
札幌市中央区南二十二条西十六丁目2番地
CITY: 札幌市 WARD: 中央区 CITY_BLOCK_DIRECTION: 南 CITY_BLOCK_NUMBER: 二十二 DISTRICT_DIRECTION: 西 DISTRICT_NUMBER: 十六 BLOCK: 2
北海道札幌市厚別区厚別中央二条十丁目3番6号
REGION: 北海道 CITY: 札幌市 WARD: 厚別区 CITY_BLOCK_LANDMARK: 厚別中央 CITY_BLOCK_NUMBER: 二 DISTRICT_NUMBER: 十 BLOCK: 3 NUMBER: 6
札幌市中央区大通西二十丁目2番18号
CITY: 札幌市 WARD: 中央区 CITY_BLOCK: 大通 DISTRICT_DIRECTION: 西 DISTRICT_NUMBER: 二十 BLOCK: 2 NUMBER: 18
新潟県新潟市江南区楚川甲180-1
REGION: 新潟県 CITY: 新潟市 WARD: 江南区 DISTRICT_NAME: 楚川 DISTRICT_NUMBER_JIKKAN: 甲 BLOCK: 180 NUMBER: 1
鹿島郡中能登町良川ト部32番地の5
RURAL_AREA: 鹿島郡 TOWN: 中能登町 DISTRICT_NAME: 良川 BU_BLOCK: ト BLOCK: 32 NUMBER: 5
〒963-8642郡山郵便局私書箱12号
POSTCODE: 9638642 POST_OFFICE: 郡山郵便局 PO_BOX: 12
10603台北市大安區金山南路2段55號
POSTCODE: 10603 REGION: 台北市 DISTRICT: 大安區 STREET: 金山南路 SECTION: 2 NUMBER: 55
臺東縣關東河鄉都蘭村42鄰431之2號
REGION: 臺東縣
TOWNSHIP: 關東河鄉
VILLAGE: 都蘭村
NEIGHBORHOOD: 42
NUMBER: 431
APARTMENT: 2
臺北市大安區延吉街70巷5弄6號1樓
REGION: 臺北市 DISTRICT: 大安區 STREET: 延吉街 LANE: 70 ALLEY: 5 NUMBER: 6 FLOOR: 1