snips-nlu-ontology

Supported builtin entities

+---------------+---------------------+---------------------+ | Entity | Identifier | Category | +===============+=====================+=====================+ | AmountOfMoney | snips/amountOfMoney | Grammar Entity_ | +---------------+---------------------+---------------------+ | City | snips/city | Gazetteer Entity_ | +---------------+---------------------+---------------------+ | Country | snips/country | Gazetteer Entity_ | +---------------+---------------------+---------------------+ | Date | snips/date | Grammar Entity_ | +---------------+---------------------+---------------------+ | DatePeriod | snips/datePeriod | Grammar Entity_ | +---------------+---------------------+---------------------+ | Datetime | snips/datetime | Grammar Entity_ | +---------------+---------------------+---------------------+ | Duration | snips/duration | Grammar Entity_ | +---------------+---------------------+---------------------+ | MusicAlbum | snips/musicAlbum | Gazetteer Entity_ | +---------------+---------------------+---------------------+ | MusicArtist | snips/musicArtist | Gazetteer Entity_ | +---------------+---------------------+---------------------+ | MusicTrack | snips/musicTrack | Gazetteer Entity_ | +---------------+---------------------+---------------------+ | Number | snips/number | Grammar Entity_ | +---------------+---------------------+---------------------+ | Ordinal | snips/ordinal | Grammar Entity_ | +---------------+---------------------+---------------------+ | Percentage | snips/percentage | Grammar Entity_ | +---------------+---------------------+---------------------+ | Region | snips/region | Gazetteer Entity_ | +---------------+---------------------+---------------------+ | Temperature | snips/temperature | Grammar Entity_ | +---------------+---------------------+---------------------+ | Time | snips/time | Grammar Entity_ | +---------------+---------------------+---------------------+ | TimePeriod | snips/timePeriod | Grammar Entity_ | +---------------+---------------------+---------------------+

Grammar Entity

Grammar entities, in the context of Snips NLU, correspond to entities which contain significant compositionality. The semantic meaning of such an entity is determined by the meanings of its constituent expressions and the rules used to combine them. Modern semantic parsers for these entities are often based on defining a formal grammar. In the case of Snips NLU, the parser used to handle these entities is Rustling, a Rust adaptation of Facebook's duckling_.

Gazetteer Entity

Gazetteer entities correspond to all the builtin entities which do not contain any semantical structure, as opposed to the grammar entities. For such entities, a gazetteer entity parser_ is used to perform the parsing.

Results Examples

The following sections provide results examples for each builtin entity.

AmountOfMoney

.. code-block:: json

[ { "kind": "AmountOfMoney", "value": 10.05, "precision": "Approximate", "unit": "€" } ]

City

.. code-block:: json

[ { "kind": "City", "value": "Paris" } ]

Country

.. code-block:: json

[ { "kind": "Country", "value": "France" } ]

Date

.. code-block:: json

[ { "kind": "InstantTime", "value": "2017-06-13 00:00:00 +02:00", "grain": "Day", "precision": "Exact" } ]

DatePeriod

.. code-block:: json

[ { "kind": "TimeInterval", "from": "2017-06-07 00:00:00 +02:00", "to": "2017-06-09 00:00:00 +02:00" } ]

Datetime

.. code-block:: json

[ { "kind": "InstantTime", "value": "2017-06-13 18:00:00 +02:00", "grain": "Hour", "precision": "Exact" }, { "kind": "TimeInterval", "from": "2017-06-07 18:00:00 +02:00", "to": "2017-06-08 00:00:00 +02:00" } ]

Duration

.. code-block:: json

[ { "kind": "Duration", "years": 0, "quarters": 0, "months": 3, "weeks": 0, "days": 0, "hours": 0, "minutes": 0, "seconds": 0, "precision": "Exact" } ]

MusicAlbum

.. code-block:: json

[ { "kind": "MusicAlbum", "value": "Discovery" } ]

MusicArtist

.. code-block:: json

[ { "kind": "MusicArtist", "value": "Daft Punk" } ]

MusicTrack

.. code-block:: json

[ { "kind": "MusicTrack", "value": "Harder Better Faster Stronger" } ]

Number

.. code-block:: json

[ { "kind": "Number", "value": 42.0 } ]

Ordinal

.. code-block:: json

[ { "kind": "Ordinal", "value": 2 } ]

Percentage

.. code-block:: json

[ { "kind": "Percentage", "value": 20.0 } ]

Region

.. code-block:: json

[ { "kind": "Region", "value": "California" } ]

Temperature

.. code-block:: json

[ { "kind": "Temperature", "value": 23.0, "unit": "celsius" }, { "kind": "Temperature", "value": 60.0, "unit": "fahrenheit" } ]

Time

.. code-block:: json

[ { "kind": "InstantTime", "value": "2017-06-13 18:00:00 +02:00", "grain": "Hour", "precision": "Exact" } ]

TimePeriod

.. code-block:: json

[ { "kind": "TimeInterval", "from": "2017-06-07 18:00:00 +02:00", "to": "2017-06-07 20:00:00 +02:00" } ]

.. _compositionality: https://en.wikipedia.org/wiki/Principle_of_compositionality .. _Rustling: https://github.com/snipsco/rustling-ontology .. _duckling: https://github.com/facebook/duckling .. _gazetteer entity parser: https://github.com/snipsco/gazetteer-entity-parser