Entity Reference

The Einstein NER (beta) API supports normalization for some entities. Normalized data is returned in the normalizedData array. The type and format of the data depends on the type of entity.

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`type`	string	Normalization type. Valid values: `credit_card`	2.0
`issuer`	string	Credit card issuer. Valid values: American Express Diner's Club Discover Japan Credit Bureau Maestro Card Mastercard Visa other	2.0
`value`	string	Value of the normalized data	2.0

With the exception of the ja locale, credit card numbers are detected regardless of the locale provided in the request. When the request document is passed with ja locale, we support numbers written in full-width characters.

Examples

Though we identify valid credit card number formats (using Luhn’s algorithm test), we do not post process the value to determine whether a number is a real-world credit card.

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`type`	string	Normalization type. Valid values: `value`—Object contains the normalized value for the token. `range`—Object contains from and to objects that represent the start value and end value for the token.	2.0
`unit`	string	Unit of measurement for the token value. Valid values: `day` `hour` `minute` `month` `quarter` `second`</li `week` `year` The unit returned by the API is determined by the unit in the token. For example, if the token is "between today and tomorrow" the unit is day.	2.0
`value`	string	Value of the normalized data.	2.0

This entity can sometimes overlap with the DURATION and NUMBER entities.

Examples

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`type`	string	Normalization type. Valid values: `value`—Object contains the normalized value for the token.	2.0
`unit`	string	Unit of measurement for the token value. Valid values: `second`—Number of seconds in the duration.	2.0
`value`	string	Value of the normalized data.	2.0

This entity can sometimes overlap with the DATETIME and NUMBER entities.

Example

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`type`	string	Normalization type. Valid values: `value`—Object contains the normalized value for the token.	2.0
`unit`	string	Empty for the EMAIL entity type.	2.0
`value`	string	Value of the normalized data.	2.0

The API recognizes email addresses in these two formats.

info at salesforce dot com
info@salesforce.com

Example

Supports normalization: No

Example

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`type`	string	Normalization type. Valid values: `value`—Object contains the normalized value for the token.	2.0
`unit`	string	Unit of measurement for the token value. Valid values: `EUR`—Euro `GBP`—British pound stering `RUB`—Russian ruble `USD`—United States dollar	2.0
`value`	string	Value of the normalized data. For money, it's the numeric value of the specified currency.	2.0

Example

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`type`	string	Normalization type. Valid values: `value`—Object contains the normalized value for the token.	2.0
`unit`	string	Empty for the NUMBER entity type.	2.0
`value`	string	Value of the normalized data.	2.0

Example

Supports normalization: No

Example

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`type`	string	Normalization type. Valid values: `value`—Object contains the normalized value for the token. `range`—Object contains from and to objects that represent the start value and end value for the token.	2.0
`unit`	string	Empty for the PERCENT entity type.	2.0
`value`	string	Value of the normalized data.	2.0

The normalized value is the percent divided by 100. For example, 50 percent is 0.5. Recognizes percentages in these formats:

50%
50 percent

Example

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`firstName`	string	Text identified as the person's first name.	2.0
`lastName`	string	Text identified as the person's last name.	2.0
`middleName`	string	Text identified as the person's middle name.	2.0
`salutation`	string	Empty for the PERSON entity type.	2.0
`suffix`	string	Text identified as the person's suffix such as Jr., Sr., and so on.	2.0
`type`	string	Normalization type. Valid values: `person`	2.0

Titles are not detected. For example, for the string Dr. Jim Blimpish only Jim and Blimpish are detected.

Example

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`type`	string	Normalization type. Valid values: `value`—Object contains the normalized value for the token.	2.0
`unit`	string	Empty for the PHONE-NUMBER entity type.	2.0
`value`	string	Value of the normalized data.	2.0

Example

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`type`	string	Normalization type. Valid values: `value`—Object contains the normalized value for the token.	2.0
`unit`	string	Empty for the URL entity type.	2.0
`value`	string	Value of the normalized data.	2.0

Supports normalization: Yes

Normalization fields

Name	Type	Description	Available Version
`type`	string	Normalization type. Valid values: `social_security`	2.0
`value`	string	Value of the normalized data.	2.0

EXAMPLE

Though we identify valid social security number formats we do not post process the value to determine whether a number is a real-world social security number.