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

# Entities supported for the country gb

The following entities are supported for the country gb (United Kingdom)

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. | 162-168 Regent Street,London,W1B 5TG P.O. Box 1234, Bromborough, CH62 3NX, UNITED KINGDOM apartment 71, 46 Graham Gardens, Luton, Bedfordshire, LU7 8PQ
address/city/context | A city or town, with context. | city: London
address/city/landmark | A city or town landmark. | city
address/city/nocontext | A city or town, without context. | London
address/country/context | A country, with context. | country: United Kingdom
address/country/landmark | A country landmark. | country
address/country/nocontext | A country, without context. | United Kingdom
address/landmark | A postal address landmark. | address
address/postcode/context | A postal code, with context. | côd post: W1B 5TG
address/postcode/landmark | A postal code landmark. | côd post
address/postcode/nocontext | A postal code, without context. | W1B 5TG
address/streetlocation/context | A street location (house number and street name), with context. | address: 168 Regent Street address: P.O. Box 1234 address: apartment 71, 46 Graham Gardens
address/streetlocation/landmark | A street location landmark. | address
address/streetlocation/nocontext | A street location (house number and street name), without context. | 168 Regent Street P.O. Box 1234 apartment 71, 46 Graham Gardens
banking/account_number/context | An individual bank account number, with context. | Bank account number: 1234567
banking/account_number/landmark | An individual bank account number landmark. | Bank account number
banking/account_number/nocontext | An individual bank account number, without context. | 1234567
banking/context | Bank account numbers sufficient to identify an individual account, with context. | Bank account details: 40-38-02 31618080 Sort code: 40-38-02 Account number: 31618080 Roll number: 897/98X
banking/iban/context | An International Bank Account Number (IBAN), with context. The IBAN number can have spaces, hyphens (-), or periods (.) as delimiters between different components of the IBAN. | IBAN: GB33BUKB20201555555555
banking/iban/nocontext | An International Bank Account Number (IBAN), without context. | GB33BUKB20201555555555
banking/landmark | A bank account landmark. | Bank account details
banking/nocontext | Bank account numbers sufficient to identify an individual account, without context. | 40-38-02 31618080 40-38-02 31618080 897/98X
banking/roll_number/context | A UK building society roll number, with context. | Roll number: 1234/123456789
banking/roll_number/landmark | A UK building society roll number landmark. | Roll number
banking/roll_number/nocontext | A UK building society roll number, without context. | 1234/123456789
banking/routing_number/context | A routing number, usually used to identify a bank branch, with context. | Sort code: 40-38-02
banking/routing_number/landmark | A routing number landmark. | Sort code
banking/routing_number/nocontext | A routing number, usually used to identify a bank branch, without context. | 40-38-02
banking/swiftcode/context | A SWIFT/BIC code, with context. | SWIFT code: XXXXGB00BBB
banking/swiftcode/nocontext | A SWIFT/BIC code, without context. | XXXXGB00BBB
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: ABC99851207A99AB12
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. | ABC99851207A99AB12
health/ehic/context | An EHIC personal identification number with context. | EHIC: UK 1234 5678
health/ehic/landmark | An EHIC landmark | EHIC
health/ehic/nocontext | An EHIC personal identification number without context. | UK 1234 5678
health/id/context | A British NHS number with context. | NHS Number: 943 476 5919
health/id/landmark | A health number landmark. | NHS 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. | 943 476 5919
id/context | A national identity number with context. For information about the supported ID numbers, see Supported National ID Numbers. | National Insurance Number: AB 12 34 56 A Residence Permit Number: RH4941406
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. | National Insurance Number Residence Permit 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. | AB 12 34 56 A RH4941406
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. | Rachael McGiggs QC Rev S. Taylor Stuart Taylor
name/given_name/context | A given name with context. For CJKVT the context landmark should be in CJKVT native script. | enw cyntaf: Stuart
name/given_name/landmark | A given name landmark. For CJKVT it will be in native script. | enw cyntaf
name/given_name/nocontext | A given name, without context. | Stuart
name/landmark | A full name landmark. | enw
name/post_title | A title that follows a name. | QC
name/pre_title | A title that precedes a name. | Rev
name/surname/context | A surname with context. For CJKVT the landmark will be in native script | cyfenw: Taylor
name/surname/landmark | A surname landmark. | cyfenw
name/surname/nocontext | A surname without context. | Taylor
name/title_surname | A title and surname. | Dr Taylor Rev McTaylor
nationality/adj/context | A nationality adjective with context. | nationality: British
nationality/adj/landmark | A nationality adjective landmark. | nationality
nationality/adj/nocontext | A nationality adjective without context. | British
nationality/any/context | Any combination of nationality adjective and noun landmark and value. | country: Britain
nationality/any/landmark | Any nationality adjective or landmark. | country
nationality/any/nocontext | Any nationality adjective or noun. | Britain
nationality/noun/context | A nationality noun with context. | country: Britain
nationality/noun/landmark | A nationality noun landmark. | country
nationality/noun/nocontext | A nationality noun without context. | Britain
passport/context | A passport number with context. | Passport: 925665416
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
passport/nocontext | A passport number without context. | 925665416
postcode/context | A postal code with context. | côd post: W1B 5TG
postcode/landmark | A postal code landmark. | côd post
postcode/nocontext | A postal code without context. | W1B 5TG
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. | phone: +44 20 7008 1500 tel: 020 7008 1500
telephone/landmark | A telephone number landmark. For the telephone_cjkvt grammar, landmarks are available only in CJKVT native script. | phone tel
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. | +44 20 7008 1500 020 7008 1500
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. | Taxpayer Identification Number: AB 12 34 56 A Unique Taxpayer Reference: 12345 12345
tin/landmark | A tax identification number landmark. | Taxpayer Identification Number Unique Taxpayer Reference
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. | 12345 12345 AB 12 34 56 A
tin/vatin/context | A VAT identification number with context. | VAT Reg No: GB 980 7806 84 VAT Reg No: XI 980 7806 84
tin/vatin/landmark | A VAT identification number landmark. | VAT Reg No
tin/vatin/nocontext | A VAT identification number without context. | GB 980 7806 84 XI 980 7806 84
voter_id/context | A voter ID number with context. This entity is available only for GB, IN, and MX. | Electoral Number: AC-72
voter_id/landmark | A voter ID number landmark. This entity is available only for GB, IN, and MX. | Electoral Number
voter_id/nocontext | A voter ID number without context. This entity is available only for GB, IN, and MX. | AC-72

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 gb