NLU system entities
Summarize
Summary of NLU System Entities
The NLU system entities in ServiceNow enable the Virtual Agent to extract relevant information from conversations. These entities, defined globally, can be used as "nodeless" input variables for topics, allowing for efficient slot-filling based on predictions from the NLU service provider or external inputs. They are enabled by default in NLU models and can be accessed via the Entities tab in NLU Workbench.
Show less
Key Features
- GLOBAL.DATE: Identifies specific dates, weeks, months, years, and seasons, normalizing them into standardized formats.
- GLOBAL.TIME: Captures precise times and parts of the day, standardizing input such as '10 minutes to three' into a normalized time string.
- GLOBAL.DATETIME: Combines date and time, allowing for detailed timestamp recognition.
- GLOBAL.DURATION: Recognizes and normalizes duration strings, facilitating queries related to time spans.
- GLOBAL.LOCATION: Extracts location names from conversations, enabling location-based queries.
- GLOBAL.PERSON: Captures personal names for user identification and interaction.
- GLOBAL.MONEY: Recognizes currency values, standardizing them according to ISO codes.
- GLOBAL.NUMBER: Extracts numerical values for various queries.
- GLOBAL.SOFTWARE: Captures software names from user requests.
- GLOBAL.HARDWARE: Identifies hardware names mentioned in conversations.
Key Outcomes
By utilizing these entities, ServiceNow customers can enhance the Virtual Agent's capability to understand user intents and provide accurate, contextually relevant responses. This leads to improved user interaction, increased efficiency in query handling, and a more streamlined experience when addressing customer requests. Each entity contributes to a robust understanding of user inputs, facilitating effective communication and support.
Use globally defined NLU entities to identify system information that Virtual Agent can extract from the conversation. You can define entities as "nodeless" input variables for a topic. These variables can be slot-filled from NLU service provider predictions or provided outside of the scope of the topic.
System entities are enabled in NLU models by default. You can view them on the model Entities tab in NLU Workbench.
GLOBAL.DATE system entity
The DAY SubType returns a date string that is accurate to a specific date.
| Usage | Example |
|---|---|
| Format | YYYY-MM-DD |
| Regular expression | \\d\\d\\d\\d-\\d\\d-\\d\\d |
| Input example | Mr. Smith left Friday, February 4, 2019. |
| Normalized value | 2019-02-04 |
| Code example | |
The WEEK SubType returns a date string of a specific week of a year.
| Usage | Example |
|---|---|
| Format | YYYY'W'WW |
| Regular expression | \\d\\d\\d\\d\\dW\\d\\d |
| Input example | Mr. Smith left the third week of 1999. |
| Normalized value | 1999W3 |
| Code example | |
The MONTH SubType returns a date string of a specific month of a year.
| Usage | Example |
|---|---|
| Format | YYYY'M'MM |
| Regular expression | \\d\\d\\d\\dM\\d\\d |
| Input example | Mr. Smith left in February of 1999. |
| Normalized value | 1999M02 |
| Code example | |
The YEAR SubType returns a date string of a specific year.
| Usage | Example |
|---|---|
| Format | YYYY |
| Regular expression | \\d\\d\\d\\d |
| Input example | Mr. Smith left in 1999. |
| Normalized value | 1999 |
| Code example | |
The SEASON SubType returns a date string of a specific season of the year.
| Usage | Example |
|---|---|
| Format | One of the following:
|
| Regular expression | One of the following:
|
| Input example | Mr. Smith left in the fall of 1999. |
| Normalized value | 1999FA |
| Code example | |
GLOBAL.TIME system entity
The TIME SubType returns a time string that is accurate to an hour and a minute.
| Usage | Example |
|---|---|
| Format | 'T'HH:mm |
| Regular expression | T\\d\\d:\\d\\d |
| Input example | Mr. Smith left at ten minutes to three. |
| Normalized value | T02:50 |
| Code example | |
The PARTSOFDAY SubType returns a time string that specifies parts of the day.
| Usage | Example |
|---|---|
| Format | One of the following:
|
| Regular expression | One of the following:
|
| Input example | Mr. Smith left in the morning. |
| Normalized value | TMO |
| Code example | |
GLOBAL.DATE_TIME system entity
The DATE_TIME SubType returns a date string that is accurate to a specific date and time string that is accurate to an hour and a minute.
| Usage | Example |
|---|---|
| Format | YYYY-MM-DD'T'HH:mm |
| Regular expression | \\d\\d\\d\\d-\\d\\d-\\d\\dT\\d\\d:\\d\\d |
| Input example | Mr. Smith leaves on October 31st at 5:00 p.m. |
| Normalized value | 2022-10-31T17:00 |
| Code example | |
GLOBAL.DURATION system entity
This entity returns a duration string that specifies the duration of the activity.
| Usage | Example |
|---|---|
| Format | One of the following:
|
| Regular expression | One of the following:
|
| Input example | Mr. Smith stayed in Boston for 48 hours. |
| Normalized value | h48 |
| Code example | |
GLOBAL.LOCATION system entity
This entity returns a location string.
| Usage | Example |
|---|---|
| Format | String value. Example: Santa Clara |
| Regular expression | Not applicable. |
| Input example | Mr. Smith works in Santa Clara. |
| Normalized value | Santa Clara |
| Code example | |
GLOBAL.PERSON system entity
This entity returns a name string.
| Usage | Example |
|---|---|
| Format | String value. Example: Joe Smith |
| Regular expression | Not applicable. |
| Input example | Joe Smith works in Santa Clara. |
| Normalized value | Joe Smith |
| Code example | |
GLOBAL.MONEY system entity
This entity returns a currency string.
| Usage | Example |
|---|---|
| Format | String value. Example: USD 2000 |
| Regular expression | Not applicable. |
| Input example | Show me laptops for less than $2000. |
| Normalized value | USD 2000 Note: The normalized value uses the three-letter ISO 3166 country
code of the source currency. |
| Code example | |
GLOBAL.NUMBER system entity
This entity returns a number.
| Usage | Example |
|---|---|
| Format | String value. Example: 5.0 |
| Regular expression | Not applicable. |
| Input example | I want to see the previous 5 transactions from my account. |
| Normalized value | 5.0 |
| Code example | |
GLOBAL.SOFTWARE
Returns a software string.
| Usage | Example |
|---|---|
| Format | String value. Example: Java |
| Regular expression | Not applicable. |
| Input example | How do I install Java? |
| Normalized value | Java |
| Code example | |
GLOBAL.HARDWARE
Returns a hardware string.
| Usage | Example |
|---|---|
| Format | String value. Example: printer |
| Regular expression | Not applicable. |
| Input example | How do I order a printer? |
| Normalized value | printer |
| Code example | |
Example NLU prediction result using Software system entity
{"status":"success",
"response":{
"utterance":"How do I install Java?",
"intents":[
{
"intentName":"test intent",
"nluModelName":"ml_x_snc_global_global_268a97a9dbd23c107906265d1396191a",
"score":0.90401393,
"intents":[
],
"entities":[
{
"name":"entity:GLOBAL.SOFTWARE",
"value":"Java",
"score":0.99930537,
"normalization":{
"type":"entity:GLOBAL.SOFTWARE",
"subType":"SOFTWARE",
"value":"Java"
},
"startingPosition":-1
}
]
}
],
"properties":{
"all:ml_x_snc_global_global_268a97a9dbd23c107906265d1396191a":"0.55",
"entity:all":"0.01",
"inference.sspace.time":"4",
"inference.time":"33",
"intent:all":"0.01",
"nluPlatformLanguage":"en",
"nluPlatformVersion":"rome.0"
}
}
}
Example NLU prediction result using DATE system entity
{
"utterance": "We should meet next Sunday at Starbucks.",
"intents": [
{
"intentName": "intent:Desire.Desire",
"score": 0.83452,
"entities": []
},
{
"intentName": "intent:Meeting.MeetRequest",
"score": 0.8919042,
"entities": [
{
"entityName": "entity:Meeting.MeetRequest.Where",
"value": "Starbucks",
"score": 1
},
{
"entityName": "entity:GLOBAL.DATE",
"value": "Sunday",
"normalization": { "type": "DATE",
"subType": "DAY",
"value": "1999-10-01"
},
"score": 0.87
}
]
}
]
}