NAV Navbar

Working with data packs

Data packs are maintained by Nuance speech scientists to remain current with popular vocabulary and language use.

Mix uses two types of data packs when building models for your applications:

Currently, this section contains information on the QNLP data pack versions available to Mix, including on the predefined entities supported. In the future more information about NDP models will be available.

Projects are associated with a specific version of a QuickNLP/NLU data pack. When you create a new project, it is associated with the current data pack version. When you rebuild your model, it continues to use the same data pack version. For example, if the version of the QNLP data pack is 6.6.11 when you create a new project, this data pack version will continue to be used when you rebuild your model, even if the current data pack version available has increased.

Data pack versions may not be fully backward-compatible. This means that if you create a new project but you want to import the TRSX content of a project associated with an older data pack version, you may encounter issues.

For example, data packs contain predefined entities, which save you the trouble of defining entities that are common to many applications, such as monetary amounts, Boolean values, calendar items (dates, times, or both), cardinal and ordinal numbers, and so on. Let's say that the nuance_DURATION predefined entity changed between the 5.x and 6.x data packs. An application with a 5.x data pack would expect a response of {"DURATION_ABS":{"HOUR":2}}, but the new data pack would return a different format: {"DURATION_ABS":{"UNIT":"hour","NUMBER":2}}. This change may break your application.

Upgrading to a new QNLP data pack version

Before you upgrade to a new QuickNLP (QNLP) data pack, make sure that the client application can handle the latest definition of the predefined entities.

To upgrade your project to the latest QNLP data pack version using the Mix platform:

  1. Export the TRSX file for the project. For this step and the next, see Importing and exporting data.
  2. If the project includes a dialog model, also export the .json file for the dialog model.
  3. Create a new project.
  4. Re-import the TRSX NLU file into the new project.
  5. If applicable, re-import the .JSON dialog file into the new project.
  6. Make sure that the client application can handle the latest definition of the predefined entities. See Predefined entitles.

This procedure creates a new project with the latest version of the predefined entities.

If you need to keep the same project, or if you need to use an earlier version of a data pack, contact your Nuance representative.

Predefined entities

Mix.nlu includes a set of predefined entities that can be useful as you develop your own NLU models. Predefined entities save you the trouble of defining entities that are generally useful in a number of different applications, such as monetary amounts, Boolean values, calendar items (dates, times, or both), cardinal and ordinal numbers, and so on. A predefined entity is not limited to a flat list of values, but instead can contain a complete grammar that defines the various ways that values for that entity can be expressed. A grammar is a compact way of expressing a vast range of possible constructions. For example, within the nuance_DURATION entity, there is a grammar that defines expressions such as "3.5 hours", "25 mins", "for 33 minutes and 19 seconds", and so on. It would simply not make sense to try to capture the possible expressions for this entity in a list.

This section describes the predefined entities that are included with Mix QuickNLP (QNLP) data pack version 9.x.

Some notes:

Change log

Predefined entities are included in QNLP data packs.

Changes between 6.x and 9.x data packs

The following changes were made to predefined entities between QNLP data pack versions 6.x and 9.x:

Numeric value ranges for predefined entities

Most predefined entities use a mix of both regular expression (regex) and GRXML grammars. In general, GRXML grammars are used to parse expressions written as words (for example, "five degrees Celsius"), and regex are used to parse expressions that include Arabic numerals, punctuation, or symbols (such as "5°C"). However, GRXML grammars can also be used to parse expressions with Arabic numbers (for example, "December 10 2018"), and a regex may parse expressions that include words (for example, "-5 degrees" or "5:15 tomorrow").

For regex, there is no limit to the number of digits in an Arabic number for any entity with regex values in the data pack. This applies to all languages.

For GRXML grammars, the accepted ranges of numeric values are provided per predefined entity (when applicable). Note that the values are provided based on US English. The coverage may vary per language. As an example, for languages where large numbers are expressed as compound words (such as Finnish and Germanic languages), the value ranges may be more limited because a grammar cannot list all the possible compounds for large numbers. Also, languages that have not been used by a deployed application may be more limited due to availability of feedback.

nuance_AMOUNT

"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
    "nuance_AMOUNT": {
        "type": "object",
        "properties": {
            "nuance_UNIT": {
                "anyOf": [{
                        "type": "number"
                    }, {
                        "type": "string"
                    }
                ]
            },
            "nuance_NUMBER": {
                "type": "object",
                "properties": {
                    "oneOf": [{
                            "nuance_CARDINAL_NUMBER": {
                                "anyOf": [{
                                        "type": "number"
                                    }, {
                                        "type": "string"
                                    }
                                ]

                            }
                        }, {
                            "nuance_DOUBLE": {
                                "anyOf": [{
                                        "type": "number"
                                    }, {
                                        "type": "string"
                                    }
                                ]

                            }
                        }
                    ]
                }

            }

        },
        "required": [
            "nuance_UNIT",
            "nuance_NUMBER"
        ]
    }
},
"additionalProperties": false
}

A sum of money intended for use in banking actions and for payments. The currency is dependent on the grammar. For example, if the en-US grammar is used, the only currency accepted is the US Dollar.

The example responses shown below are formatted in JSON.

Example: five dollars

{
    "nuance_NUMBER": {
        "nuance_CARDINAL_NUMBER": 5
    },
    "nuance_UNIT": "USD"
}

Example: four dollars and seventy five cents

{
    "nuance_NUMBER": {
        "nuance_DOUBLE": 4.75
    },
    "nuance_UNIT": "USD"
}

Numeric value range

<= 99,999,999,999

Changes between 6.x and 9.x for nuance_AMOUNT

nuance_NUMBER now returns, instead of a string, either:

Example: "five dollars"

nuance_BOOLEAN

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "nuance_BOOLEAN": {
            "type": "boolean"
        }
    },
    "additionalProperties": false
}

Declaration of true or false.

The example responses shown below are formatted in JSON.

Examples

Positive input such as "yes" or "that's right" returns this response (formatted in JSON):

{
  "nuance_BOOLEAN": true
}

Negative input such as "no" or "not really" returns this response (JSON format):

{
  "nuance_BOOLEAN": false
}

nuance_CALENDARX

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "definitions": {
        "__main__.TimeAbs": {
            "type": "object",
            "properties": {
                "nuance_TIME_ABS": {
                    "type": "object",
                    "properties": {
                        "nuance_AMPM": {
                            "type": "string",
                            "pattern": "[am|pm]"
                        },
                        "nuance_MINUTE": {
                            "type": "number"
                        },
                        "nuance_HOUR": {
                            "type": "number"
                        },
                        "nuance_MODIFIER": {
                            "type": "string",
                            "pattern": "[fuzzy]"
                        }

                    }
                }
            },
            "additionalProperties": false
        },
        "__main__.TimeRel": {
            "type": "object",
            "properties": {
                "nuance_TIME_REL": {
                    "type": "object",
                    "properties": {
                        "nuance_INCREMENT": {
                            "type": "number"
                        },
                        "nuance_STEP": {
                            "type": "string",
                            "pattern": "[hour|minute]"
                        },
                        "nuance_MODIFIER": {
                            "type": "string",
                            "pattern": "[fuzzy]"
                        },
                        "nuance_TIME_ANCHOR": {
                            "$ref": "#/definitions/__main__.Time"
                        }

                    }
                }
            },
            "additionalProperties": false
        },
        "__main__.DateAbs": {
            "type": "object",
            "properties": {
                "nuance_DATE_ABS": {
                    "type": "object",
                    "properties": {
                        "nuance_DAY": {
                            "type": "number"
                        },
                        "nuance_MONTH": {
                            "type": "number"
                        },
                        "nuance_YEAR": {
                            "type": "number"
                        },
                        "nuance_MODIFIER": {
                            "type": "string",
                            "pattern": "[fuzzy]"
                        }
                    }
                }
            },
            "additionalProperties": false
        },
        "__main__.DateRel": {
            "type": "object",
            "properties": {
                "nuance_DATE_REL": {
                    "type": "object",
                    "properties": {
                        "nuance_NAMED_DAY": {
                            "type": "string"
                        },
                        "nuance_DAY_OF_WEEK": {
                            "type": "number",
                            "pattern": "[1-7]"
                        },
                        "nuance_INCREMENT": {
                            "type": "number"
                        },
                        "nuance_STEP": {
                            "type": "string",
                            "pattern": "[day|week|month|year]"
                        },
                        "nuance_MODIFIER": {
                            "type": "string",
                            "pattern": "[fuzzy]"
                        },
                        "nuance_DATE_ANCHOR": {
                            "$ref": "#/definitions/__main__.Date"
                        }
                    }
                }
            },
            "additionalProperties": false
        },
        "__main__.Date": {
            "type": "object",
            "properties": {
                "nuance_DATE": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/__main__.DateAbs"
                        },
                        {
                            "$ref": "#/definitions/__main__.DateRel"
                        }
                    ]
                }
            },
            "additionalProperties": false
        },
        "__main__.Time": {
            "type": "object",
            "properties": {
                "nuance_TIME": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/__main__.TimeAbs"
                        },
                        {
                            "$ref": "#/definitions/__main__.TimeRel"
                        }
                    ]
                }
            },
            "additionalProperties": false
        },
        "__main__.CalendarRange": {
            "type": "object",
            "properties": {
                "nuance_CALENDAR_RANGE_START": {
                  "nuance_CALENDAR": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/__main__.Date"
                        },
                        {
                            "$ref": "#/definitions/__main__.Time"
                        }
                    ]
                  }
                },
                "nuance_CALENDAR_RANGE_END": {
                  "nuance_CALENDAR": {
                    "anyOf": [                                      
                        {
                            "$ref": "#/definitions/__main__.Date"
                        },
                        {
                            "$ref": "#/definitions/__main__.Time"
                        }
                    ]
                  } 
                }
            },
            "additionalProperties": false
        }
    },
    "type": "object",
    "properties": {
        "nuance_CALENDARX": {
            "type": "object",
            "properties": {
                "oneOf": [
                    {
                        "nuance_CALENDAR": {
                            "anyOf": [
                                {
                                    "$ref": "#/definitions/__main__.Date"
                                },
                                {
                                    "$ref": "#/definitions/__main__.Time"
                                }
                            ]
                        },
                        "nuance_CALENDAR_RANGE": {
                            "$ref": "#/definitions/__main__.CalendarRange"
                        }
                    }
                ]
            }
        }
    },
    "additionalProperties": false
}

Defines a discrete calendar event in terms of date, time, or both. Additionally, the calendar event may be in absolute or relative terms. Named holidays are also represented.

The example responses shown below are formatted in JSON.

Example: February 14

{
    "nuance_CALENDAR": {
        "nuance_DATE": {
            "nuance_DATE_ABS": {
                "nuance_DAY": 14,
                "nuance_MONTH": 2
            }
        }
    }
}  

Example: at 5

{
    "nuance_CALENDAR": {
        "nuance_TIME": {
            "nuance_TIME_ABS": {
                "nuance_HOUR": 5
            }
        }
    }
}

Example: yesterday

{
    "nuance_CALENDAR": {
        "nuance_DATE": {
            "nuance_DATE_REL": {
                "nuance_STEP": "day",
                "nuance_INCREMENT": -1
            }
        }
    }
}

Example: between the first of June and the second of August

{
    "nuance_CALENDAR_RANGE": {
        "nuance_CALENDAR_RANGE_START": {
            "nuance_CALENDAR": {
                "nuance_DATE": {
                    "nuance_DATE_ABS": {
                        "nuance_DAY": 1,
                        "nuance_MONTH": 6
                    }
                }
            }
        },
        "nuance_CALENDAR_RANGE_END": {
            "nuance_CALENDAR": {
                "nuance_DATE": {
                    "nuance_DATE_ABS": {
                        "nuance_DAY": 2,
                        "nuance_MONTH": 8
                    }
                }
            }
        }
    }
}

Example: from Monday to Friday

{
  "nuance_CALENDAR_RANGE": {
    "nuance_CALENDAR_RANGE_START": {
      "nuance_CALENDAR": {
        "nuance_DATE": {
          "nuance_DATE_REL": {
            "nuance_INCREMENT": 0,
            "nuance_DAY_OF_WEEK": 2
          }
        }
      }
    },
    "nuance_CALENDAR_RANGE_END": {
      "nuance_CALENDAR": {
        "nuance_DATE": {
          "nuance_DATE_REL": {
            "nuance_INCREMENT": 0,
            "nuance_DAY_OF_WEEK": 6
          }
        }
      }
    }
  }
}

Example: two days after Easter

{
    "nuance_CALENDAR": {
        "nuance_DATE": {
            "nuance_DATE_REL": {
                "nuance_STEP": "day",
                "nuance_INCREMENT": 2,
                "nuance_DATE_ANCHOR": {
                    "nuance_DATE": {
                        "nuance_DATE_ABS": {
                            "nuance_NAMED_DAY": "Easter"
                        }
                    }
                }
            }
        }
    }
}

Example: Monday night

{
    "nuance_CALENDAR_RANGE": {
        "nuance_CALENDAR_RANGE_END": {
            "nuance_CALENDAR": {
                "nuance_DATE": {
                    "nuance_DATE_REL": {
                        "nuance_INCREMENT": 0,
                        "nuance_DAY_OF_WEEK": 3
                    }
                },
                "nuance_TIME": {
                    "nuance_TIME_ABS": {
                        "nuance_HOUR": 3,
                        "nuance_MINUTE": 59,
                        "nuance_AMPM": "am",
                        "nuance_MODIFIER": "fuzzy"
                    }
                }
            }
        },
        "nuance_CALENDAR_RANGE_START": {
            "nuance_CALENDAR": {
                "nuance_DATE": {
                    "nuance_DATE_REL": {
                        "nuance_INCREMENT": 0,
                        "nuance_DAY_OF_WEEK": 2
                    }
                },
                "nuance_TIME": {
                    "nuance_TIME_ABS": {
                        "nuance_HOUR": 10,
                        "nuance_AMPM": "pm",
                        "nuance_MODIFIER": "fuzzy"
                    }
                }
            }
        }
    }
}

Example: Christmas

{
    "nuance_CALENDAR": 
    {
           "nuance_DATE": {
               "nuance_DATE_ABS": {
                   "nuance_DAY": 25,
                   'nuance_MONTH":12, 
                   "nuance_HOLIDAY":"Christmas"
            }
        }
    }
}

Numeric value range

Changes between 6.x and 9.x for nuance_CALENDARX

nuance_CARDINAL_NUMBER

{
  "$schema": "http://json-schema.org/draft-04/schema#", 
  "type": "object", 
  "properties": {
    "nuance_CARDINAL_NUMBER": {
      "anyOf": [
        {
          "type": "number"
        }, 
        {
          "type": "string"
        }
      ]
    }
  }, 
  "additionalProperties": false
}

A non-fractional whole number denoting quantity (1, 2, 3) as opposed to an ordinal number (denoting order like first, second, third). Cardinal numbers can be described in natural speech up to and including a million (for some languages, such as en-US, up to billions), but any number larger than that must be dictated as a string of digits.

The example responses shown below are formatted in JSON.

Example: 27

{
  "nuance_CARDINAL_NUMBER": 27
}

Example: forty three

{
  "nuance_CARDINAL_NUMBER": 43
}

Example: oh one two three

{
  "nuance_CARDINAL_NUMBER": 0123
}

Numeric value range

<= 99,999,999

nuance_DISTANCE

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "nuance_DISTANCE": {
            "type": "object",
            "properties": {
                "oneOf": [{
                        "nuance_DISTANCE_ABS": {
                            "type": "object",
                            "properties": {
                                "nuance_UNIT": {
                                    "type": "string",
                                    "pattern": "[km|m|cm|mm|mi|yd|ft|in]"
                                },
                                "nuance_MODIFIER": {
                                    "type": "string",
                                    "pattern": "fuzzy"
                                },
                                "nuance_NUMBER": {
                                    "type": "object",
                                    "properties": {
                                        "oneOf": [{
                                                "nuance_CARDINAL_NUMBER": {
                                                    "anyOf": [{
                                                            "type": "number"
                                                        }, {
                                                            "type": "string"
                                                        }
                                                    ]

                                                }
                                            }, {
                                                "nuance_DOUBLE": {
                                                    "anyOf": [{
                                                            "type": "number"
                                                        }, {
                                                            "type": "string"
                                                        }
                                                    ]

                                                }
                                            }
                                        ]
                                    }

                                }
                            }
                        }
                    }, {
                        "nuance_DISTANCE_REL": {
                            "type": "object",
                            "properties": {
                                "nuance_DISTANCE_ABS": {
                                    "type": "object",
                                    "properties": {
                                        "nuance_NUMBER": {
                                            "type": "object",
                                            "properties": {
                                                "oneOf": [{
                                                        "nuance_CARDINAL_NUMBER": {
                                                            "anyOf": [{
                                                                    "type": "number"
                                                                }, {
                                                                    "type": "string"
                                                                }
                                                            ]

                                                        }
                                                    }, {
                                                        "nuance_DOUBLE": {
                                                            "anyOf": [{
                                                                    "type": "number"
                                                                }, {
                                                                    "type": "string"
                                                                }
                                                            ]

                                                        }
                                                    }
                                                ]
                                            }

                                        },

                                        "nuance_UNIT": {
                                            "type": "string",
                                            "pattern": "[km|m|cm|mm|mi|yd|ft|in]"
                                        }
                                    },
                                    "nuance_MODIFIER": {
                                        "type": "string",
                                        "pattern": "[GT|LT|GE|LE|EQ|INC]"
                                    }
                                }
                            },
                            "required": "nuance_MODIFIER"
                        }
                    }
                ]
            }
        }
    },
    "additionalProperties": false
}

Amount of space between two things or people.

The example responses shown below are formatted in JSON.

Example: eighteen inches

{
    "nuance_DISTANCE_ABS": {
        "nuance_UNIT": "in",
        "nuance_NUMBER": {
            "nuance_CARDINAL_NUMBER": 18
        }
    }
}

Example: two and a half meters

{
  "nuance_DISTANCE_ABS": {
    "nuance_UNIT": "m",
    "nuance_NUMBER": {
        "nuance_DOUBLE": 2.5
    }
  }
}

Example: more than three km

{
  "nuance_DISTANCE_REL": {
    "nuance_DISTANCE_ABS": {
      "nuance_UNIT": "km",
      "nuance_NUMBER": {
        "nuance_CARDINAL_NUMBER": 3
       }
    },
    "nuance_MODIFIER": "GT"
  }
}

Example: five miles further

{
    "nuance_DISTANCE_REL": {
        "nuance_DISTANCE_ABS": {
            "nuance_UNIT": "m",
            "nuance_NUMBER": {
                "nuance_CARDINAL_NUMBER": 5
            }
        },
        "nuance_MODIFIER": "INC"
    }
}

Example: far

{
    "nuance_DISTANCE_REL": {
        "nuance_MODIFIER": "FAR"
    }
}

Numeric value range

<= 99,999,999

Changes between 6.x and 9.x for nuance_DISTANCE

nuance_NUMBER now returns, instead of a number or string, either:

Example: "two and a half meters"

nuance_DOUBLE

{
  "$schema": "http://json-schema.org/draft-04/schema#", 
  "type": "object", 
  "properties": {
    "nuance_DOUBLE": {
      "anyOf": [
        {
          "type": "number"
        }, 
        {
          "type": "string"
        }
      ]
    }
  }, 
  "additionalProperties": false
}

Fractions and decimal-point numbers.

The example responses shown below are formatted in JSON.

Example: 2.7

{
  "nuance_DOUBLE": 2.7
}

Example: one and two tenths

{
  "nuance_DOUBLE": 1.2
}

Example: point 5

{
  "nuance_DOUBLE": 0.5
}

Example: 2 1/3

{
  "nuance_DOUBLE": "2 1/3"
}

Numeric value range

nuance_DURATION

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "nuance_DURATION": {
            "type": "object",
            "properties": {
                "oneOf": [{
                        "nuance_DURATION_ABS": {
                            "type": "object",
                            "properties": {
                                "nuance_NUMBER": {
                                    "type": "object",
                                    "properties": {
                                        "oneOf": [{
                                                "nuance_CARDINAL_NUMBER": {
                                                    "anyOf": [{
                                                            "type": "number"
                                                        }, {
                                                            "type": "string"
                                                        }
                                                    ]

                                                }
                                            }, {
                                                "nuance_DOUBLE": {
                                                    "anyOf": [{
                                                            "type": "number"
                                                        }, {
                                                            "type": "string"
                                                        }
                                                    ]

                                                }
                                            }
                                        ]
                                    }

                                },

                                "nuance_UNIT": {
                                    "type": "string",
                                    "pattern": "[millisecond|second|minute|hour|day|week|month|year]"
                                },
                                "nuance_MODIFIER": {
                                    "type": "string",
                                    "pattern": "[fuzzy]"
                                }

                            }
                        }
                    }, {
                        "nuance_DURATION_REL": {
                            "type": "object",
                            "properties": {
                                "nuance_DURATION_ABS": {
                                    "type": "object",
                                    "properties": {
                                        "nuance_NUMBER": {
                                            "type": "object",
                                            "properties": {
                                                "oneOf": [{
                                                        "nuance_CARDINAL_NUMBER": {
                                                            "anyOf": [{
                                                                    "type": "number"
                                                                }, {
                                                                    "type": "string"
                                                                }
                                                            ]

                                                        }
                                                    }, {
                                                        "nuance_DOUBLE": {
                                                            "anyOf": [{
                                                                    "type": "number"
                                                                }, {
                                                                    "type": "string"
                                                                }
                                                            ]

                                                        }
                                                    }
                                                ]
                                            }

                                        },

                                        "nuance_UNIT": {
                                            "type": "string",
                                            "pattern": "[millisecond|second|minute|hour|day|week|month|year]"
                                        }
                                    }
                                },

                                "nuance_MODIFIER": {
                                    "type": "string",
                                    "pattern": "[GT|LT|GE|LE|EQ|INC]"
                                }
                            },
                            "required": "nuance_MODIFIER"
                        }
                    }
                ]
            }
        }
    },
    "additionalProperties": false
}

Period of time described in absolute (hours, minutes, seconds, and days) or relative terms (for example, "two hours more").

The example responses shown below are formatted in JSON.

Example: 7 hours

{
    "nuance_DURATION_ABS": {
        "nuance_NUMBER": {
            "nuance_CARDINAL_NUMBER": 7
        },
        "nuance_UNIT": "hour"
    }
}

Example: 2.5 hours

{
    "nuance_DURATION_ABS": {
        "nuance_UNIT": "minute",
        "nuance_NUMBER": {
            "nuance_CARDINAL_NUMBER": 150
        }
    }
}

Example: half an hour

{
    "nuance_DURATION_ABS": {
        "nuance_UNIT": "minute",
        "nuance_NUMBER": {
            "nuance_CARDINAL_NUMBER": 30
        }
    }
}

Example: more than an hour

{
  "nuance_DURATION_REL": {
    "nuance_DURATION_ABS": {
      "nuance_NUMBER": {
        "nuance_CARDINAL_NUMBER": 1
      },
      "nuance_UNIT": "hour"
    },
    "nuance_MODIFIER": "GT"
  }
}

Example: 15 minutes longer

{
    "nuance_DURATION_REL": {
        "nuance_DURATION_ABS": {
            "nuance_UNIT": "minute",
            "nuance_NUMBER": {
                "nuance_CARDINAL_NUMBER": 15
            }
        },
        "nuance_MODIFIER": "INC"
    }
}

Example: less than thirty minutes

{
    "nuance_DURATION_REL": {
        "nuance_DURATION_ABS": {
            "nuance_UNIT": "minute",
            "nuance_NUMBER": {
                "nuance_CARDINAL_NUMBER": 30
            }
        },
        "nuance_MODIFIER": "LT"
    }
}

Example: around two hours and fifteen minutes

{
    "nuance_DURATION_ABS": {
        "nuance_UNIT": "minute",
        "nuance_NUMBER": {
            "nuance_CARDINAL_NUMBER": 135
            }
        },
        "nuance_MODIFIER": "fuzzy"
}

Example: a year and a month

{
    "nuance_DURATION_ABS": {
    "nuance_NUMBER": {
      "nuance_CARDINAL_NUMBER": 13
    },
    "nuance_UNIT": "month"
  }
}

Numeric value range

<= 99,999,999

Changes between 6.x and 9.x for nuance_DURATION

nuance_NUMBER now returns, instead of a number, either:

Example: "a year and a month"

nuance_DURATION_RANGE

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "nuance_DURATION_RANGE": {
            "type": "object",
            "properties": {
                "nuance_DURATION_RANGE_START": {
                    "type": "object",
                    "properties": {
                        "nuance_DURATION": {
                            "type": "object",
                            "properties": {
                                "oneOf": [{
                                        "nuance_DURATION_ABS": {
                                            "type": "object",
                                            "properties": {
                                                "nuance_NUMBER": {
                                                    "type": "object",
                                                    "properties": {
                                                        "oneOf": [{
                                                                "nuance_CARDINAL_NUMBER": {
                                                                    "anyOf": [{
                                                                            "type": "number"
                                                                        }, {
                                                                            "type": "string"
                                                                        }
                                                                    ]

                                                                }
                                                            }, {
                                                                "nuance_DOUBLE": {
                                                                    "anyOf": [{
                                                                            "type": "number"
                                                                        }, {
                                                                            "type": "string"
                                                                        }
                                                                    ]

                                                                }
                                                            }
                                                        ]
                                                    }

                                                },

                                                "nuance_UNIT": {
                                                    "type": "string",
                                                    "pattern": "[millisecond|second|minute|hour|day|week|month|year]"
                                                },
                                                "nuance_MODIFIER": {
                                                    "type": "string",
                                                    "pattern": "[fuzzy]"
                                                }
                                            }
                                        },
                                        "nuance_DURATION_REL": {
                                            "type": "object",
                                            "properties": {
                                                "nuance_DURATION_ABS": {
                                                    "type": "object",
                                                    "properties": {
                                                        "nuance_NUMBER": {
                                                            "type": "object",
                                                            "properties": {
                                                                "oneOf": [{
                                                                        "nuance_CARDINAL_NUMBER": {
                                                                            "anyOf": [{
                                                                                    "type": "number"
                                                                                }, {
                                                                                    "type": "string"
                                                                                }
                                                                            ]

                                                                        }
                                                                    }, {
                                                                        "nuance_DOUBLE": {
                                                                            "anyOf": [{
                                                                                    "type": "number"
                                                                                }, {
                                                                                    "type": "string"
                                                                                }
                                                                            ]

                                                                        }
                                                                    }
                                                                ]
                                                            }

                                                        },

                                                        "nuance_UNIT": {
                                                            "type": "string",
                                                            "pattern": "[millisecond|second|minute|hour|day|week|month|year]"
                                                        }
                                                    }
                                                },
                                                "nuance_MODIFIER": {
                                                    "type": "string",
                                                    "pattern": "[GT|LT|GE|LE|EQ|INC]"
                                                }
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                },
                "nuance_DURATION_RANGE_END": {
                    "type": "object",
                    "properties": {
                        "nuance_DURATION": {
                            "type": "object",
                            "properties": {
                                "oneOf": [{
                                        "nuance_DURATION_ABS": {
                                            "type": "object",
                                            "properties": {
                                                "nuance_NUMBER": {
                                                    "type": "object",
                                                    "properties": {
                                                        "oneOf": [{
                                                                "nuance_CARDINAL_NUMBER": {
                                                                    "anyOf": [{
                                                                            "type": "number"
                                                                        }, {
                                                                            "type": "string"
                                                                        }
                                                                    ]

                                                                }
                                                            }, {
                                                                "nuance_DOUBLE": {
                                                                    "anyOf": [{
                                                                            "type": "number"
                                                                        }, {
                                                                            "type": "string"
                                                                        }
                                                                    ]

                                                                }
                                                            }
                                                        ]
                                                    }

                                                },

                                                "nuance_UNIT": {
                                                    "type": "string",
                                                    "pattern": "[millisecond|second|minute|hour|day|week|month|year]"
                                                },
                                                "nuance_MODIFIER": {
                                                    "type": "string",
                                                    "pattern": "[fuzzy]"
                                                }
                                            }
                                        },
                                        "nuance_DURATION_REL": {
                                            "type": "object",
                                            "properties": {
                                                "nuance_DURATION_ABS": {
                                                    "type": "object",
                                                    "properties": {
                                                        "nuance_NUMBER": {
                                                            "type": "object",
                                                            "properties": {
                                                                "oneOf": [{
                                                                        "nuance_CARDINAL_NUMBER": {
                                                                            "anyOf": [{
                                                                                    "type": "number"
                                                                                }, {
                                                                                    "type": "string"
                                                                                }
                                                                            ]

                                                                        }
                                                                    }, {
                                                                        "nuance_DOUBLE": {
                                                                            "anyOf": [{
                                                                                    "type": "number"
                                                                                }, {
                                                                                    "type": "string"
                                                                                }
                                                                            ]

                                                                        }
                                                                    }
                                                                ]
                                                            }

                                                        },

                                                        "nuance_UNIT": {
                                                            "type": "string",
                                                            "pattern": "[millisecond|second|minute|hour|day|week|month|year]"
                                                        }
                                                    }
                                                },
                                                "nuance_MODIFIER": {
                                                    "type": "string",
                                                    "pattern": "[GT|LT|GE|LE|EQ|INC]"
                                                }
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    },
    "additionalProperties": false
}

Represents a duration when it can span one of two time intervals. There must be at least a start or end duration value, and most often there are both.

The example response shown below is formatted in JSON.

Example: between two and three months

{
    "nuance_DURATION_RANGE_START": {
        "nuance_DURATION": {
            "nuance_DURATION_ABS": {
                "nuance_NUMBER": {
                    "nuance_CARDINAL_NUMBER": 2
                },
                "nuance_UNIT": "month"
            }
        }
    },
    "nuance_DURATION_RANGE_END": {
        "nuance_DURATION": {
            "nuance_DURATION_ABS": {
                "nuance_NUMBER": {
                    "nuance_CARDINAL_NUMBER": 3
                },
                "nuance_UNIT": "month
            }
        }
    }
}

Changes between 6.x and 9.x for nuance_DURATION_RANGE

nuance_NUMBER now returns, instead of a number, either:

Example:

nuance_EXPIRY_DATE

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "nuance_EXPIRY_DATE": {
            "type": "object",
            "properties": {
                "nuance_DATE_ABS": {
                    "type": "object",
                    "properties": {
                        "nuance_MONTH": {
                            "type": "number"
                        },
                        "nuance_YEAR": {
                            "type": "number"
                        }
                    }
                }
            },
            "required": [
                "nuance_DATE_ABS"
            ]
        }
    },
    "additionalProperties": false
}

Used for credit card expiry dates.

The example responses shown below are formatted in JSON.

Example: June two thousand and twenty

{
    "nuance_DATE_ABS": {
        "nuance_MONTH": 6,
        "nuance_YEAR": 2020
    }
}

Example: one two slash two two

{
    "nuance_DATE_ABS": {
        "nuance_MONTH": 12,
        "nuance_YEAR": 2022
    }
}

Example: 05/21

{
    "nuance_DATE_ABS": {
        "nuance_MONTH": 5,
        "nuance_YEAR": 2021
    }
}

Example: one two two zero three five

{
    "nuance_DATE_ABS": {
        "nuance_MONTH": 12,
        "nuance_YEAR": 2035
    }
}

nuance_GENERIC_ORDER

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "nuance_GENERIC_ORDER": {
            "anyOf": [{
                    "ORDER_REL": {
                        "type": "string",
                        "pattern": "[min|max|succ|prec|other|middle|penultimate]"
                    }
                }, {
                    "nuance_ORDINAL_NUMBER": {
                        "anyOf": [{
                                "type": "number"
                            }, {
                                "type": "string"
                            }
                        ]
                    }
                }
            ]
        }
    },
    "required": [
        "nuance_GENERIC_ORDER"
    ],
    "additionalProperties": false
}

This entity extends ORDINAL_NUMBER (1st, 2nd, 3rd, ..., 31st) to represent special cases for expressing minimum, maximum, previous, successive, and so on.

The example responses shown below are formatted in JSON.

Example: first

{
    "nuance_ORDER_REL": "min"
}

Example: latest

{
    "nuance_ORDER_REL": "max"
}

Example: twenty second

{
    "nuance_ORDINAL_NUMBER": 22
}

Example: second to last

{
    "nuance_ORDER_REL": "penultimate"
}

Example: previous

{
    "nuance_ORDER_REL": "prec"
}

Changes between 6.x and 9.x for nuance_GENERIC_ORDER

nuance_GENERIC_ORDER now returns either:

Example: "twenty third"

Example: "next"

nuance_GLOBAL

{
  "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "nuance_GLOBAL": {
            "type": "string",
            "pattern": "[help|repeat|back|cancel|login]"
        }
    },
    "required": [
        "nuance_GLOBAL"
    ],
    "additionalProperties": false
}

Generic commands for navigating a voice system.

Example: I need help

{
    "nuance_GLOBAL": "help"
}

Example: What did you say?

{
    "nuance_GLOBAL": "repeat"
}

Example: go back

{
    "nuance_GLOBAL": "back"
}

Example: cancel

{
    "nuance_GLOBAL": "cancel"
}

Example: sign in

{
    "nuance_GLOBAL": "login"
}

nuance_NUMBER

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "nuance_NUMBER": {
            "type": "object",
            "properties": {
                "oneOf": [{
                        "nuance_CARDINAL_NUMBER": {
                            "anyOf": [{
                                    "type": "number"
                                }, {
                                    "type": "string"
                                }
                            ]

                        }
                    }, {
                        "nuance_DOUBLE": {
                            "anyOf": [{
                                    "type": "number"
                                }, {
                                    "type": "string"
                                }
                            ]

                        }
                    }
                ]
            }
        }
    },
    "additionalProperties": false
}

Represents a number (integer, fraction, or decimal point). Numbers can be described in natural speech up to and including a million.

The example responses shown below are formatted in JSON.

Example: twenty seven

{
    "nuance_NUMBER": {
        "nuance_CARDINAL_NUMBER": 27
    }
}

Example: four and a half

{
    "nuance_NUMBER": {
        "nuance_DOUBLE": 4.5
    }
}

Example: 49

{
    "nuance_NUMBER": {
        "nuance_CARDINAL_NUMBER": 49
    }
}

nuance_ORDINAL_NUMBER

{
  "$schema": "http://json-schema.org/draft-04/schema#", 
  "type": "object", 
  "properties": {
    "nuance_ORDINAL_NUMBER": {
      "type": "number"
    }
  }, 
  "required": [
    "nuance_ORDINAL_NUMBER"
  ], 
  "additionalProperties": false
}

Number that defines a position in a series. Handles all values up until 31st.

The example responses shown below are formatted in JSON.

Example: second

{
  "nuance_ORDINAL_NUMBER": 2
}

Example: tenth

{
  "nuance_ORDINAL_NUMBER": 10
}

Example: thirteenth

{
  "nuance_ORDINAL_NUMBER": 13
}

Numeric value range

<= 31st (Since this has been used mostly for the day of the month. Some languages, such as Russian, have bigger coverage.)

nuance_QUANTITY

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "nuance_QUANTITY": {
            "type": "object",
            "properties": {
                "oneOf": [{
                        "nuance_QUANTITY_ABS": {
                            "type": "object",
                            "properties": {
                                "nuance_NUMBER": {
                                    "type": "object",
                                    "properties": {
                                        "oneOf": [{
                                                "nuance_CARDINAL_NUMBER": {
                                                    "anyOf": [{
                                                            "type": "number"
                                                        }, {
                                                            "type": "string"
                                                        }
                                                    ]

                                                }
                                            }, {
                                                "nuance_DOUBLE": {
                                                    "anyOf": [{
                                                            "type": "number"
                                                        }, {
                                                            "type": "string"
                                                        }
                                                    ]

                                                }
                                            }
                                        ]
                                    }

                                }
                            }
                        }
                    }, {
                        "nuance_QUANTITY_REL": {
                            "type": "object",
                            "properties": {
                                "nuance_MODIFIER": {
                                    "type": "string",
                                    "pattern": "[GT|LT|GE|LE|EQ|INC|NONE|SOME|LOTS]"
                                },
                                "nuance_QUANTITY_ABS": {
                                    "type": "object",
                                    "properties": {
                                        "nuance_NUMBER": {
                                            "type": "object",
                                            "properties": {
                                                "oneOf": [{
                                                        "nuance_CARDINAL_NUMBER": {
                                                            "anyOf": [{
                                                                    "type": "number"
                                                                }, {
                                                                    "type": "string"
                                                                }
                                                            ]

                                                        }
                                                    }, {
                                                        "nuance_DOUBLE": {
                                                            "anyOf": [{
                                                                    "type": "number"
                                                                }, {
                                                                    "type": "string"
                                                                }
                                                            ]

                                                        }
                                                    }
                                                ]
                                            }

                                        }
                                    }
                                }
                            },
                            "required": "nuance_MODIFIER"
                        }
                    }
                ]
            }
        }
    },
    "additionalProperties": false
}

Defines values of magnitude. Can be relative (for example, "greater than nine", < 100, "some", "lots") or absolute (for example, "ten", 20). Note that QUANTITY_REL does not have built-in grammars.

The example responses shown below are formatted in JSON.

Example: a lot

{
    "nuance_MODIFIER": "LOTS"
}

Example: 10

{
    "nuance_QUANTITY_ABS": {
        "nuance_NUMBER": {
            "nuance_CARDINAL_NUMBER": 10
        }
    }
}

Example: at least ten

{
    "nuance_MODIFIER": "GE",
    "nuance_QUANTITY_ABS": {
        "nuance_NUMBER": {
            "nuance_CARDINAL_NUMBER": 10
        }
    }
}

Example: less than ten

{
    "nuance_MODIFIER": "LT",
    "nuance_QUANTITY_ABS": {
        "nuance_NUMBER": {
            "nuance_CARDINAL_NUMBER": 10
        }
    }
}

Example: maximum of 10

{
    "nuance_MODIFIER": "LE",
    "nuance_QUANTITY_ABS": {
        "nuance_NUMBER": {
            "nuance_CARDINAL_NUMBER": 10
        }
    }
}

Example: > 25

{
    "nuance_MODIFIER": "GT",
    "nuance_QUANTITY_ABS": {
        "nuance_NUMBER": {
            "nuance_CARDINAL_NUMBER": 25
        }
    }
}

Example: none

{
    "nuance_MODIFIER": "NONE"
}

Numeric value range

<= 99,999,999

Changes between 6.x and 9.x for nuance_QUANTITY

nuance_NUMBER now returns, instead of a number, either:

Example: "less than ten"

nuance_TEMPERATURE

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "nuance_TEMPERATURE": {
            "type": "object",
            "properties": {
                "nuance_UNIT": {
                    "type": "string",
                                        "pattern": "[C|F|K]"
                },
                "nuance_NUMBER": {
                    "type": "object",
                    "properties": {
                        "oneOf": [{
                                "nuance_CARDINAL_NUMBER": {
                                    "anyOf": [{
                                            "type": "number"
                                        },
                                        {
                                            "type": "string"
                                        }
                                    ]

                                }
                            },
                            {
                                "nuance_DOUBLE": {
                                    "anyOf": [{
                                            "type": "number"
                                        },
                                        {
                                            "type": "string"
                                        }
                                    ]

                                }
                            }
                        ]
                    }

                }

            },
            "required": [
                "nuance_NUMBER"
            ]
        }
    },
    "additionalProperties": false
}

Temperature as expressed in degrees Celsius or Fahrenheit. Temperature can be expressed as a whole number or a floating point value.

The example responses shown below are formatted in JSON.

Example: twenty three degrees Celsius

{
    "nuance_NUMBER": {
        "nuance_CARDINAL_NUMBER": 23
    },
    "nuance_UNIT": "C"
}

Example: eighteen point five degrees Fahrenheit

{
    "nuance_NUMBER": {
        "nuance_DOUBLE": 18.5
    },
    "nuance_UNIT": "F"
}

Example: two hundred fifty three degrees kelvin

{
    "nuance_NUMBER": {
        "nuance_CARDINAL_NUMBER": 253
    },
    "nuance_UNIT": "K"
}

Example: Fahrenheit four hundred fifty one

{
    "nuance_NUMBER": {
        "nuance_CARDINAL_NUMBER": 451
    },
    "nuance_UNIT": "F"
}

Example: eighteen below zero

{
    "nuance_NUMBER": {
        "nuance_CARDINAL_NUMBER": -18
    }
}

Numeric value range

Changes between 6.x and 9.x for nuance_TEMPERATURE

nuance_NUMBER now returns, instead of a number, either:

Example: "twenty two degrees celsius"