> For the complete documentation index, see [llms.txt](https://humley.gitbook.io/humley-studio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://humley.gitbook.io/humley-studio/enhance-assistant/entities/system-entities.md).

# system entities

/\* Title: System Entities Sort: 3 \*/ An entity can be used to store information to be used later in the conversation, in Flows, or to pass to Integrations that reference external services.

**System Entities** are pre-configured and can be added to a project's entity list, allowing you to deploy them instantly without the need to write extensive lists of text values or build complicated regex patterns.

### Create a System Entity

From the Entities page, click **Create Entity**

Select **System** entity type in the sidebar.

Enter in the sidebar -

* **Entity Name**

  Name the entity. All entity names must be unique within the project.
* **Supported Entity**

  Select a supported system entity from the dropdown list.
* **Training materials checkbox**

  Leave unchecked.

Click **Create Entity** in the sidebar

<br>

> System entities currently recognise English language inputs only and are not editable i.e. you cannot view/edit/add any details such as text or pattern values.\
> All information extracted from the utterance is stored in an entity as a string value.\
> The examples for each system entity below are not exhaustive. The **Sessions** page can be used to view each 'turn' in a conversation. Expand the **Entities and Variables** section to see any entities that are captured and the values that are stored within them at that point in time.

<br>

### Supported Entities

Humley Studio supports the following System Entities:

| Entity       | Notes                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Age          | <p>Extracts a number and period unit from an utterance referencing age e.g. -<br><em>I am 24 years old</em> stored as <em>24 Year</em></p>                                                                                                                                                                                                                                                                                          |
| Choice       | <p>Extracts a yes/no, true/false choice from an utterance e.g. -<br><em>No I don't</em>, <em>Nope</em>, <em>that's false</em>, stored as <em>False</em></p>                                                                                                                                                                                                                                                                         |
| Currency     | <p>Extracts an amount and a currency unit from an utterence referencing currency e.g. -<br><em>£10</em>, <em>10 pounds</em> stored as <em>10 Pound</em></p>                                                                                                                                                                                                                                                                         |
| Date         | <p>Extracts a system date from an utterance referencing a date. Supports a range of formats e.g. -<br><em>21-12-2019</em>, <em>21st of Dec 2019</em>, <em>The day after tomorrow</em>, <em>2 days from now</em> etc. stored as <em>2019-12-21</em><br>Defaults to recognising dates in utterances as US format e.g -<br><em>01/02/1990</em> stored as <em>2019-01-02</em></p>                                                       |
| DateTime     | <p>Extracts a system datetime from an utterance referencing a date and time. Supports a range of formats e.g. -<br><em>21-12-2019 10am</em>, <em>21st of Dec 2019 10:00</em>, <em>10 am day after tomorrow</em>, <em>10am 2 days from now</em> etc. stored as <em>2019-12-21 10:00:00</em><br>Defaults to recognising dates in utterances as US format e.g -<br><em>01/02/1990 10am</em> stored as <em>2019-01-02 10:00:00</em></p> |
| Dimension    | <p>Extracts an amount and a dimension unit from an utterence referencing a dimension (length, height, distance, volume etc.) e.g. -<br><em>I would walk 500 miles</em> stored as <em>500 Mile</em><br><em>The speed limit is 55mph</em> stored as <em>55 Mile per hour</em><br><em>10 cubic metres</em> stored as <em>10 Cubic meter</em></p>                                                                                       |
| Duration     | <p>Extracts a value in Seconds from an utterence referencing a duration e.g. -<br><em>That takes 1 hour</em> stored as <em>3600</em><br><em>The 100m sprint record is 9.58 seconds</em> stored as <em>9.58</em></p>                                                                                                                                                                                                                 |
| Email        | <p>Extracts an email address from an utterance referencing a valid email address format e.g. -<br><em><info@humley.com></em></p>                                                                                                                                                                                                                                                                                                    |
| GUID         | <p>Extracts a GUID from an utterance referencing a valid GUID format e.g. -<br><em>3cd2f9ca-8689-43ec-9ee5-b626c44bde5d</em></p>                                                                                                                                                                                                                                                                                                    |
| Hashtag      | <p>Extracts a hashtag from an utterance containing a word preceded by the # symbol e.g. -<br><em>#humleystudio</em></p>                                                                                                                                                                                                                                                                                                             |
| IP Address   | <p>Extracts an IP address from an utterance referencing a valid IP address format e.g. -<br><em>192.168.0.150</em></p>                                                                                                                                                                                                                                                                                                              |
| Number       | <p>Extracts a number from an utterance referencing a numeric value e.g. -<br><em>I'll have 2 of those</em>, <em>I want to buy two please</em> etc. stored as <em>2</em></p>                                                                                                                                                                                                                                                         |
| Ordinal      | <p>Extracts a number from an utterance referencing an ordinal (a position in a list) e.g. -<br><em>I'll take the third option</em> stored as <em>3</em></p>                                                                                                                                                                                                                                                                         |
| Percentage   | <p>Extracts a number (with percentage symbol) from an utterance referencing a percentage amount (a position in a list) e.g. -<br><em>77%</em>, <em>77 percent</em>, <em>seventy seven %</em> etc. stored as <em>77%</em></p>                                                                                                                                                                                                        |
| Phone Number | <p>Extracts a phone number from an utterance referencing a valid phone number formats from a range of countries e.g. -<br><em>+1-555-754-3010</em>, <em>(555) 754-3010</em>, <em>754-3010</em>, <em>07435 222217</em>, <em>+447435222217</em> etc.</p>                                                                                                                                                                              |
| Temperature  | <p>Extracts a number (with temperature unit symbol, if uttered) from an utterance referencing a temperature e.g. -<br><em>It's 23 degrees out here</em>, <em>23°</em> etc. stored as <em>23 Degree</em><br><em>180C</em>, <em>180 C</em>, <em>180 degrees celcius</em>, <em>180 degrees centigrade</em> etc. stored as <em>180 C</em></p>                                                                                           |
| Time         | <p>Extracts a system time from an utterance referencing a valid time format.<br>Supports a range of formats e.g. -<br><em>10:10</em>, <em>ten minutes past ten</em>, <em>10.10 am</em> etc. stored as <em>10:10:00</em><br><em>3pm</em>, <em>three pm</em> etc. stored as <em>15:00:00</em></p>                                                                                                                                     |
| URL          | <p>Extracts a URL from an utterance referencing a valid URL format e.g. -<br><em>[www.humley.com](http://www.humley.com)</em>, <em><https://docs.humley.com></em> etc.</p>                                                                                                                                                                                                                                                          |
