Named Entity Recognition Grammars Package 25.2
Named Entity Recognition Grammars User Guide

# address grammar

The address grammar is found in the sets PII, PHI.

entity | description | examples | components | checksum
--- | --- | --- | --- | ---
address/CC | A postal address. In general, a score of one is given to an address that includes a numbered, common format street address (for example "23 North Road"), a known city (for example "London"), and a postal code in a viable format for the country (for example "SW1A 2AA"). Deviations from this form lead to score penalties. The ordering of these elements varies by country. OpenText recommends that you use prefiltering to improve the performance for this grammar. See Configure Prefiltering. This entity returns the addresses in a normalized format by default. The normalized form standardizes apartment and house numbers, expands shortened forms of region names, removes additional punctuation, and converts the text to uppercase. For example "ABIDEI HURRIYET CD TANER PALAS APT 9, KAT:7, D:9, 34437 ISTANBUL". The exact order depends on the country. You can turn off normalization by setting normalize_addresses=false in the address_stoplist.lua script. This option can improve performance when you do not need normalization. | 1-2-34, Yaesu 4-Chome, Nanae, Atsuta, Hekinan, Kagoshima, 123-4567, Japan 162-168 Regent Street, London, W1B 5TG Abidei Hurriyet Cd Taner Palas Han 9 Kat:7 Dayre 9, 34437 Istanbul Avenida Juan Xxiii 20, 41006, Sevilla No.55, Sec. 2, Jinshan S. Rd., Daan Dist., Taipei City 10603 No.99 Xingjian Road, Cixi City, Zhejiang Province, China Schlosshoferstrasse 20, 1210 Vienna 北京市房山区长阳镇北广阳城大街8号 日本、〒１２３-４５６７神奈川県津島市城南区月形町八重洲四丁目１番２-３４号 １０６０３台北市大安區金山南路２段５５號 | ✔️ | ❌
address/city/context/CC | A city or town, with context. | City: London | ✔️ | ❌
address/city/landmark/CC | A city or town landmark. | City | ❌ | ❌
address/city/nocontext/CC | A city or town, without context. | London | ✔️ | ❌
address/country/context/CC | A country, with context. | 国: 日本 Country: United Kingdom 国:中華民國 | ✔️ | ❌
address/country/landmark/CC | A country landmark. | Country 国 | ❌ | ❌
address/country/nocontext/CC | A country, without context. | Japan United Kingdom 日本 | ✔️ | ❌
address/landmark/CC | A postal address landmark. | 住所 Address | ❌ | ❌
address/postcode/context/CC | A postal code, with context. | Postcode: 1234567 Postcode: CB4 0WZ 郵便番号: １２３-４５６７ 郵遞區號106-409 | ✔️ | ❌
address/postcode/landmark/CC | A postal code landmark. | 郵便番号 Postcode 郵遞區號 | ❌ | ❌
address/postcode/nocontext/CC | A postal code, without context. | １２３-４５６７ 106-409 CB4 0WZ | ✔️ | ❌
address/streetlocation/context/CC | A street location (house number and street name), with context. | Address: 123, Mill Road Address: No.55, Sec. 2, Jinshan S. Rd. 住所: 八重洲 四丁目１番２ -３４号 | ✔️ | ❌
address/streetlocation/landmark/CC | A street location landmark. | Address 住址 住所 | ❌ | ❌
address/streetlocation/nocontext/CC | A street location (house number and street name), without context. | 1-2-34, Yaesu 4-Chome 123, Mill Road 八重洲四丁目１番２-３４号 | ✔️ | ❌

The following components are produced by the above entities.

components | description | examples | context
--- | --- | --- | ---
APARTMENT | apartment number | APT 4 | Apt 4, Nasmah Tower, Al Ittihad Road, Al Nahda 1, Dubai
APARTMENT_BUILDING | apartment building name | NASMAH TOWER | Apt 4, Nasmah Tower, Al Ittihad Road, Al Nahda 1, Dubai
APARTMENT_PREFIX | apartment prefix number | 101- | 101-3485, rue de la Montagne, Montréal (Québec) H3G 2A6
BLOCK | postal block | 110 | гр. Варна, жк. Младост, бл.110, вх.4 ет. 2
BUILDING | building name | AURORA BUILDING | Level 12, Aurora Building, 147 Pirie Street, Adelaide South Australia 5000
CANTON | canton name | ZÜRICH | Europastrasse 2, 8152 Opfikon ZH
CITY | city name | AL AIN | Sheikh Zayed Road 123, Al Ain, United Arab Emirates
COUNTRY | country name | UNITED ARAB EMIRATES | Sheikh Zayed Road 123, Al Ain, United Arab Emirates
COUNTY | county name | VILJANDI | Allika talu, Halliste alevik, 69501 VILJANDIMAA
DISTRICT | district | AL NAHDA 1 | Apt 4, Nasmah Tower, Al Ittihad Road, Al Nahda 1, Dubai
DOOR | door number | G | Alameda de Colón,26, 2o G. 29001 Málaga
DWELLING | dwelling name | VILLA 251 | Villa 251, Khalifa Bin Shakbout Street, Abu Dhabi, UAE
EMIRATE | emirate name | SHARJAH | PO Box 57, Sharjah, United Arab Emirates
ENTRANCE | building entrance number | 4 | гр. Варна, жк. Младост, бл.110, вх.4 ет. 2
FLOOR | floor number | LEVEL 12 | Level 12, Aurora Building, 147 Pirie Street, Adelaide South Australia 5000
GOVERNORATE | governorate name | DHOFAR | AL QOAF STREET, NEAR AL MARAI SIGNAL, SALALAH, DHOFAR
INTERSECTING_STREET | name of intersecting street (when a location is given as on the corner of two streets) | MULDERS MILE | Corner of Mulders Mile & Swart Street, Eldoraigne
MUNICIPALITY | municipality name | ВЕЛИКО ТЪРНОВО | Slavyanska 29, Бургас SOFIA 1000 община Велико Търново
NEIGHBORHOOD | neighborhood name | МЛАДОСТ | гр. Варна, жк. Младост, бл.110, вх.4 ет. 2
NUMBER | number of the match (eg house, site or building number as part of a street address; or id number etc) | 123 | Sheikh Zayed Road 123, Al Ain, United Arab Emirates
POSTCODE | postal code | 1210 | Schlosshoferstrasse 20,1210 Vienna
POST_OFFICE | post office name or code | STN A | 1425 JAMES ST, PO BOX 4001 STN A,VICTORIA BC V8X 3X4
PO_BOX | postal box (PO Box) number | 57 | PO Box 57, Sharjah, United Arab Emirates
PRIVATE_BAG_AGENCY | private mail bag agency | POSTNET SUITE | Postnet Suite 29487, Private Bag 10, Menlo Park, 0102
PRIVATE_BAG_BOX_NUMBER | private mail bag box number | 29487 | Postnet Suite 29487, Private Bag 10, Menlo Park, 0102
PRIVATE_BAG_NUMBER | private mail bag number | 10 | Postnet Suite 29487, Private Bag 10, Menlo Park, 0102
PROVINCE | province name | EAST FLANDERS | Appartements 19 Rue Du Cornet 429, Asper, VOV East Flanders, 9890
QUADRANT | postal quadrant | QUADRA 4 | SHS Quadra 4 Bloco D, 70314-000, Brasília
RELATION | descriptor giving the location of the address relative to another location | OPP AL FUTTAIM MOSQUE | Ahmed Plaza Building, Opp Al Futtaim Mosque,Naif Road, Deira
SECTOR | postal sector | SHS | SHS Quadra 4 Bloco D, 70314-000, Brasília
SITE | site name | ALLIKA TALU | Allika talu, Halliste alevik, 69501 VILJANDIMAA
SITE_ID | site identifier | X | Plot 1/45 Waterkloof X
SITE_TYPE | type of location | PLOT | Plot 1/45 Waterkloof X
STAIRWELL | stairwell number | 2 | VDA RAMON Y CAJAL 3, Esc:2 Piso:1º Pta:B, 28703, MADRID
STATE | state name | VICTORIA | PO BOX 37, SPRINGVALE VIC 3171, AUSTRALIA
STREET | street name (without the number) | SHEIKH ZAYED ROAD | Sheikh Zayed Road 123, Al Ain, United Arab Emirates
SUB-PROVINCE | sub-province name | SHCHYOLKOVSKY | 11 Ul. Lenina, Shchyolkovo, Shchyolkovsky District, Moscow Oblast, 141103, Russia
VILLAGE | village name | ANTRA | СВ Slavyanska 29, с. Antra, Bulgaria

In the tables, ✔️ indicates that the item is always used, and ❌ that the item is never used. The ✓ symbol indicates that the item is only used for some entities (that is, for some but not all countries or languages). For details, refer to the relevant entity page.

Copyright 2025 Open Text
Version 25.2 | Last updated April 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Named Entity Recognition Grammars Package 25.2

Topic Title: address grammar