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

# Entities supported for the country nz

The following entities are supported for the country nz (New Zealand)

entity | description | example
--- | --- | ---
address | 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. | 100 Mount Eden Road,Mount Eden,Auckland 5022 PO Box 90242, Auckland Mail Centre, AUCKLAND 1142 NEW ZEALAND apartment 12, number 100 Mount Eden Road, Mount Eden, Auckland 5022
address/city/context | A city or town, with context. | city: Auckland
address/city/landmark | A city or town landmark. | city
address/city/nocontext | A city or town, without context. | Auckland
address/country/context | A country, with context. | country: New Zealand
address/country/landmark | A country landmark. | country
address/country/nocontext | A country, without context. | New Zealand
address/landmark | A postal address landmark. | address
address/postcode/context | A postal code, with context. | POSTCODE: 1111
address/postcode/landmark | A postal code landmark. | POSTCODE
address/postcode/nocontext | A postal code, without context. | 1111
address/streetlocation/context | A street location (house number and street name), with context. | address: 100 Mount Eden Road address: PO Box 90242, Auckland Mail Centre address: apartment 12, number 100 Mount Eden Road
address/streetlocation/landmark | A street location landmark. | address
address/streetlocation/nocontext | A street location (house number and street name), without context. | 100 Mount Eden Road PO Box 90242, Auckland Mail Centre apartment 12, number 100 Mount Eden Road
banking/account_number/context | An individual bank account number, with context. | Bank Account Number: 01-902-0068389-00
banking/account_number/landmark | An individual bank account number landmark. | Bank Account Number
banking/account_number/nocontext | An individual bank account number, without context. | 01-902-0068389-00
banking/context | Bank account numbers sufficient to identify an individual account, with context. | Bank Account Number: 01-902-0068389-00
banking/landmark | A bank account landmark. | Bank Account Number
banking/nocontext | Bank account numbers sufficient to identify an individual account, without context. | 01-902-0068389-00
banking/swiftcode/context | A SWIFT/BIC code, with context. | SWIFT Number: XXXXNZ00BBB
banking/swiftcode/nocontext | A SWIFT/BIC code, without context. | XXXXNZ00BBB
driving/context | A driving license number with context. This entity matches both the driving license number, and the personal number or driver number, if present. On the standard European driving license, these are fields 5 and 4d.1 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | driving licence: AB123456
driving/landmark | A driving license landmark. | driving licence
driving/nocontext | A driving license number, without context.2 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | AB123456
health/id/context | A New Zealand National Health Index (NHI) number with context. | NHI Number: CGC2720
health/id/landmark | A health number landmark. | NHI Number
health/id/nocontext | A health number, such as a British NHS number, French Carte Vitale number or Japanese Health Insurance Card number, without context. | CGC2720
id/context | A national identity number with context. For information about the supported ID numbers, see Supported National ID Numbers. | Social Welfare Number: 123-456-785 Social Welfare Number: 123456785
id/landmark | A national identity number landmark.3 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | Social Welfare Number
id/nocontext | A national identity number without context. For information about the supported ID numbers, see Supported National ID Numbers.4 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | 123-456-785 123456785
internet/email/context | An email address, with context. | email: jsmith@mailserver.com
internet/email/landmark | An email address landmark. | email
internet/email/nocontext | An email address, without context. | jsmith@mailserver.com
name | A full personal name. Romanized names can be in title case or upper case, and can be in the order given name surname or surname given name. CJKVT native script names must be surname given name. For Japanese, either form can include honorifics.5 This entity returns the names in a normalized format, in the form GIVEN NAME SURNAME, for example JOHN SMITH. You can turn off normalization by setting normalize_names=false in the name_stoplist.lua script. You can also turn off score adjustment, by setting rescore_names=false in the name_stoplist.lua script. This option can improve performance when you do not need the normalization or score refinement. | Michael Smith Mr M. Smith Zachary O'Henson Esquire
name/given_name/context | A given name with context. For CJKVT the context landmark should be in CJKVT native script. | Given name: Michael
name/given_name/landmark | A given name landmark. For CJKVT it will be in native script. | Given name
name/given_name/nocontext | A given name, without context. | Michael
name/landmark | A full name landmark. | Name
name/post_title | A title that follows a name. | Esquire
name/pre_title | A title that precedes a name. | Mr
name/surname/context | A surname with context. For CJKVT the landmark will be in native script | Last name: Smith
name/surname/landmark | A surname landmark. | Last name
name/surname/nocontext | A surname without context. | Smith
name/title_surname | A title and surname. | Dr Smith Mr O'Smith
nationality/adj/context | A nationality adjective with context. | nationality: New Zealander
nationality/adj/landmark | A nationality adjective landmark. | nationality
nationality/adj/nocontext | A nationality adjective without context. | New Zealander
nationality/any/context | Any combination of nationality adjective and noun landmark and value. | country: New Zealand
nationality/any/landmark | Any nationality adjective or landmark. | country
nationality/any/nocontext | Any nationality adjective or noun. | New Zealand
nationality/noun/context | A nationality noun with context. | country: New Zealand
nationality/noun/landmark | A nationality noun landmark. | country
nationality/noun/nocontext | A nationality noun without context. | New Zealand
passport/context | A passport number with context. | passport number: LA123456
passport/landmark | A passport landmark. For information about cases where the landmark and passport number do not match or have an ambiguous match, see Ambiguous Entities. | passport number
passport/nocontext | A passport number without context. | LA123456
postcode/context | A postal code with context. | POSTCODE: 1111
postcode/landmark | A postal code landmark. | POSTCODE
postcode/nocontext | A postal code without context. | 1111
telephone/context | A telephone number with context. For the telephone_cjkvt grammar, numbers can be ASCII or full-width numbers. This entity returns the telephone number in the normalized format +NNNNN, starting with the country code. For example +12012224344.6 To ensure that this entity performs correctly, set your TangibleCharacters configuration to include the following characters: ()+-. For more information, see Configure Tangible Characters. | TELEPHONE: +64-3-234-5678
telephone/landmark | A telephone number landmark. For the telephone_cjkvt grammar, landmarks are available only in CJKVT native script. | TELEPHONE
telephone/nocontext | A telephone number without context. For the telephone_cjkvt grammar, numbers can be ASCII or full-width numbers. This entity returns the telephone number in the normalized format +NNNNN, starting with the country code. For example +12042439955.7 To ensure that this entity performs correctly, set your TangibleCharacters configuration to include the following characters: ()+-. For more information, see Configure Tangible Characters. | +64-3-234-5678
tin/context | A tax identification number with context. For more examples, see Example Tax Identification Numbers.8 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | IRD Number: 123456785
tin/landmark | A tax identification number landmark. | IRD Number
tin/nocontext | A tax identification number without context. For more examples, see Example Tax Identification Numbers.9 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches. | 123456785
tin/vatin/context | A VAT identification number with context. | GST/IRD Number: NZ 49098576
tin/vatin/landmark | A VAT identification number landmark. | GST/IRD Number
tin/vatin/nocontext | A VAT identification number without context. | NZ 49098576

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: Entities supported for the country nz