v6_x predefined entities

You are viewing documentation for QuickNLP data pack version 6.x.

Looking for the most current data pack information? For documentation on the predefined entities included in the current QNLP data pack version available with Mix, see the latest prededined entities.

To find out which QNLP data pack version your project is using, from the Mix dashboard select your project and click the Details tab. The data pack version is provided in the Information area.

Important notes

Keep in mind the following when working with predefined entities:

  • Predefined entities are namespaced with “nuance_”, including all subnodes.
  • Some entities may not be available in all languages. Examples provided are for English (United States).
  • Mix.dialog does not support the nuance_CALENDARX predefined entity. If you would like to let users provide either a date or a time, as a single conversation turn, use separate DATE and TIME entities. See Predefined entities in Mix.dialog.

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

Sum of money intended for use in banking actions and for payments, with the currency dependent on the grammar.

nuance_BOOLEAN

Declaration of true or false.

nuance_CALENDARX

Discrete calendar event in terms of date, time, or both.

nuance_CARDINAL_NUMBER

A non-fractional, whole number denoting quantity (1, 2, 3) as opposed to an ordinal number (denoting order like first, second, third).

nuance_DISTANCE

Amount of space between two things or people.

nuance_DOUBLE

Fractions and decimal-point numbers.

nuance_DURATION

Period of time described in absolute or relative terms.

nuance_DURATION_RANGE

Duration when it can span one of two time intervals.

nuance_EXPIRY_DATE

Credit card expiry dates.

nuance_GENERIC_ORDER

Extends ORDINAL_NUMBER to represent special cases for expressing minimum, maximum, previous, successive, and so on.

nuance_GLOBAL

Generic commands for navigating a voice system.

nuance_NUMBER

Represents a number (integer, fraction, or decimal point).

nuance_ORDINAL_NUMBER

Number that defines a position in a series.

nuance_QUANTITY

Values of magnitude, relative or absolute.

nuance_TEMPERATURE

Temperature expressed in degrees Celsius or Fahrenheit.