{"id":18095,"date":"2019-01-14T11:31:18","date_gmt":"2019-01-14T11:31:18","guid":{"rendered":"https:\/\/developer.kore.ai\/v7-3\/?post_type=docs&#038;p=15874"},"modified":"2021-03-26T08:03:42","modified_gmt":"2021-03-26T08:03:42","slug":"entity-types","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v7-3\/docs\/bots\/bot-builder-tool\/dialog-task\/entity-types\/","title":{"rendered":"Supported Entity Types"},"content":{"rendered":"<section class=\"l-section wpb_row height_auto\"><div class=\"l-section-h i-cf\"><div class=\"g-cols vc_row type_default valign_top\"><div class=\"vc_col-sm-12 wpb_column vc_column_container\"><div class=\"vc_column-inner\"><div class=\"wpb_wrapper\">\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p>The <strong>Entity Type<\/strong> provides the NLP Interpreter with the expected type of data from a user utterance to enhance recognition and system performance.\u00a0 The Kore.ai NLP interpreter extracts the entity from the user utterance. If the user does not enter a required entity, you can define a Bot Response node to prompt the user to provide the entity. For more information, see the <a href=\"\/v7-3\/docs\/bots\/bot-builder-tool\/develop\/dialog-task\/working-with-the-message-confirmation-nodes\/#Setting_up_a_Message_Node\">Working with the Bot Response Node<\/a>.<\/p>\n<p>The following <strong>Entity Types<\/strong> can be specified for an Entity node.<\/p>\n<table>\n<tbody>\n<tr>\n<td><a href=\"#address\">Address<\/a><\/td>\n<td><a href=\"#composite\">Composite<\/a><\/td>\n<td><a href=\"#name\">Person Name<\/a><\/td>\n<\/tr>\n<tr>\n<td><a href=\"#airport\">Airport<\/a><\/td>\n<td><a href=\"#date\">Date<\/a><\/td>\n<td><a href=\"#percent\">Percentage<\/a><\/td>\n<\/tr>\n<tr>\n<td><a href=\"#attachment\">Attachment<\/a><\/td>\n<td><a href=\"#dateperiod\">Date Period<\/a><\/td>\n<td><a href=\"#phone\">Phone Number<\/a><\/td>\n<\/tr>\n<tr>\n<td><a href=\"#email\">Email<\/a><\/td>\n<td><a href=\"#datetime\">Date Time<\/a><\/td>\n<td><a href=\"#quantity\">Quantity<\/a><\/td>\n<\/tr>\n<tr>\n<td><a href=\"#city\">City<\/a><\/td>\n<td><a href=\"#description\">Description<\/a><\/td>\n<td><a href=\"#string\">String<\/a><\/td>\n<\/tr>\n<tr>\n<td><a href=\"#country\">Country<\/a><\/td>\n<td><a href=\"#enum\">List of Items (enumerated)<\/a><\/td>\n<td><a href=\"#time\">Time<\/a><\/td>\n<\/tr>\n<tr>\n<td><a href=\"#company\">Company<\/a><\/td>\n<td><a href=\"#lookup\">List of items (lookup)<\/a><\/td>\n<td><a href=\"#timezone\">Time Zone<\/a><\/td>\n<\/tr>\n<tr>\n<td><a href=\"#color\">Color<\/a><\/td>\n<td><a href=\"#location\">Location<\/a><\/td>\n<td><a href=\"#url\">URL<\/a><\/td>\n<\/tr>\n<tr>\n<td><a href=\"#custom\">Custom<\/a><\/td>\n<td><a href=\"#number\">Number<\/a><\/td>\n<td><a href=\"#zip\">Zip Code<\/a><\/td>\n<\/tr>\n<tr>\n<td><a href=\"#currency\">Currency<\/a><\/td>\n<td><\/td>\n<td><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"address\"><span class=\"ez-toc-section\" id=\"Address\">Address<\/span><\/h3>\n<p>Captures addresses written in the standard US and Germany address formats, for example, 200 E Main ST Pheonix AZ 85123 USA. The complete address is captured as a string: \u201c200 E Main ST Pheonix AZ 85123 USA.\u201d<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"AddressEntity\": \"200 E Main ST Pheonix AZ 85123 USA\"\r\n}<\/pre>\n<p>For other country addresses, the platform captures strings that end with a recognizable city or country name. For more details, refer to the <a href=\"#city\">City entity.<\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"airport\"><span class=\"ez-toc-section\" id=\"Airport\">Airport<\/span><\/h3>\n<p>Captures airport details with the following inputs:<\/p>\n<ul>\n<li>city name,<\/li>\n<li>airport name,<\/li>\n<li>IATA code,<\/li>\n<li>ICAO, or<\/li>\n<li>abbreviations of US cities.<\/li>\n<\/ul>\n<p>Airport details are returned as JSON entity with the elements shown below:<\/p>\n<pre class=\"json\">\"AirportEntity\":\r\n  {\"IATA\": \"LHR\",\r\n   \"AirportName\": \"London Heathrow Airport\",\r\n   \"City\": \"London\",\r\n   \"ICAO\": \"EGLL\",\r\n   \"Latitude\": \"51.4775\", \"Longitude\": \"-0.461389\"\r\n  }<\/pre>\n<p>We use <a style=\"background-color: #ffffff;\" href=\"https:\/\/github.com\/opentraveldata\/opentraveldata\">https:\/\/github.com\/opentraveldata\/opentraveldata<\/a> for all the airport details.<\/p>\n<table>\n<thead>\n<tr>\n<th>Input<\/th>\n<th>Description<\/th>\n<th>Examples<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>City<br \/>\nname<\/td>\n<td>Identifies the airport name from the city name in the user utterance. If the city has multiple airports, shows the list of airports to choose from.<\/td>\n<td>Utterance: Flying to Los Angeles<br \/>\nResponse: The airport you entered seems to be ambiguous. Tell me the option you would like to choose.<br \/>\n<i>&lt;Names of five airports in Los Angeles&gt;<\/i><\/td>\n<\/tr>\n<tr>\n<td>Airport name<\/td>\n<td>Identifies the airport name from full airport name or partial name with the prominent keyword.<\/td>\n<td>Utterance: Flying to Heathrow<br \/>\nCaptured: London Heathrow Airport with the necessary details in the bot.<\/td>\n<\/tr>\n<tr>\n<td>IATA<\/td>\n<td>Identifies airport names by the International Air Transport Association (IATA) codes.<\/td>\n<td>Utterance: Flying to LHR<br \/>\nCaptured: Details of the London Heathrow Airport<\/td>\n<\/tr>\n<tr>\n<td>ICAO<\/td>\n<td>Identifies International Civil Aviation Organization (ICAO) codes.<\/td>\n<td>Utterance: Flying to EGLL<br \/>\nCaptured: Details of the London Heathrow Airport<\/td>\n<\/tr>\n<tr>\n<td>Abbreviations of cities<\/td>\n<td>Identifies city abbreviations that are listed in www.geonames.org<\/td>\n<td>Utterance: Flying to LA<br \/>\nResponse: The airport you entered seems to be ambiguous. Tell me the option you would like to choose.<br \/>\n<i>&lt;Names of five airports in LA&gt;<\/i><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"attachment\"><span class=\"ez-toc-section\" id=\"Attachment_Image_File\">Attachment (Image \/ File)<\/span><\/h3>\n<p>The user can attach a file, image, or email of up to 25 MB. The bot returns the attachment description that you enter as a string.<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"AttachmentEntity\": \"send\"\r\n}<\/pre>\n<p>Note: Currently, the attachment entity is supported only for the following channels &#8211; Facebook, Twitter, Web\/Mobile, and Slack.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"city\"><span class=\"ez-toc-section\" id=\"City\">City<\/span><\/h3>\n<p>The name of a city in an utterance such as &#8220;<em>What is the temperature in New York<\/em>&#8220;. The bot captures any city name with over 5000 population in the form of a string. We use <a href=\"http:\/\/www.geonames.org\">www.geonames.org<\/a> for all the city details.<\/p>\n<div class=\"alert alert-info\"><b>Note<\/b>: City names are not disambiguated currently but prioritized based on their population. So, if the user utterances consist of Portland, Portland OR ranks higher than Portland ME.<\/div>\n<div><\/div>\n<pre class=\"\">\"entities\":\r\n{\r\n\"CityEntity\": \"New York\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"country\"><span class=\"ez-toc-section\" id=\"Country\">Country<\/span><\/h3>\n<p>Captures the name of a Country from user utterance such as &#8220;<em>What is the capital of United States of America<\/em>&#8220;.<\/p>\n<p>Country details are returned as JSON entity with the elements shown below:<\/p>\n<pre class=\"json\">\"CountryEntity\": {\r\n      \"alpha3\": \"USA\",\r\n      \"alpha2\": \"US\",\r\n      \"localName\": \"United States of America\",\r\n      \"shortName\": \"United States\",\r\n      \"numericalCode\": 840\r\n}<\/pre>\n<p>See here for complete list of countries <a style=\"background-color: #ffffff;\" href=\"https:\/\/www.nationsonline.org\/oneworld\/country_code_list.htm\">https:\/\/www.nationsonline.org\/oneworld\/country_code_list.htm<\/a>.<\/p>\n<table>\n<thead>\n<tr>\n<th>Element<\/th>\n<th>Description<\/th>\n<th>Examples<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>alpha3<\/td>\n<td>The three letter code of the country<\/td>\n<td>USA, GBR, or IND<\/td>\n<\/tr>\n<tr>\n<td>alpha2<\/td>\n<td>The two letter code for the country<\/td>\n<td>US, GB, or IN<\/td>\n<\/tr>\n<tr>\n<td>localName<\/td>\n<td>Name of the Country<\/td>\n<td>United States of America, United Kingdom, or India<\/td>\n<\/tr>\n<tr>\n<td>shortName<\/td>\n<td>Short name<\/td>\n<td>United States, United Kingdom, or India<\/td>\n<\/tr>\n<tr>\n<td>numericalCode<\/td>\n<td>United Nations, used numerical code M49 for countries<\/td>\n<td>840, 826, or 356<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"company\"><span class=\"ez-toc-section\" id=\"Company_Name_or_Organization_Name\">Company Name or Organization Name<\/span><\/h3>\n<p>Captures the name of a company from user utterances such as &#8220;<em>Nearest branch for Amazon&#8221;<\/em>. The value for Company Name is returned (<em>Amazon<\/em>) as a string. See <a href=\"\/v7-3\/docs\/bots\/bot-builder-tool\/develop\/dialog-task\/supported-company-names\/\">Supported Companies<\/a> list.<\/p>\n<p>Apart from the supported companies, the bot recognizes the words starting with a capital letter and followed by these suffixes as a company type: Inc, Incorporated, Corp, Corporation, Group, Ltd, Limited, Co, Company, LP, LLP, LLLP, LLC, PLLC.<\/p>\n<pre class=\"\"> \"entities\":\r\n{\r\n\"OrganizationEntity\": \"amazon\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"color\"><span class=\"ez-toc-section\" id=\"Color\">Color<\/span><\/h3>\n<p>Captures the name of the of color from a user utterance, for example, Set the status to green. Returns the value for Color as green as a string. See <a href=\"\/v7-3\/docs\/bots\/bot-builder-tool\/develop\/dialog-task\/supported-colors\/\">Supported Colors<\/a> list.<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"ColorEntity\": \"green\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"currency\"><span class=\"ez-toc-section\" id=\"Currency\">Currency<\/span><\/h3>\n<p>Captures the amount and type of currency from the user utterance, for example, &#8220;<em>This handbag is priced at 200 dollars&#8221; &#8211; <\/em>where 200 is the amount and USD is the currency.<\/p>\n<p>This entity type recognizes:<\/p>\n<ul>\n<li>Full currency names (Dollar, Rupees, Indian national rupees, Dinar),<\/li>\n<li>Currency symbols ($, S$, \u00a3),<\/li>\n<li>standard currency abbreviations (INR, USD), and<\/li>\n<li>commonly used slang for currencies (Buck, Nickel, Dime, Quid, Loonie, Toonie, Benjamin, Jackson, Hamilton.)<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><strong>Note<\/strong>: Currency names are not disambiguated based on your previous usage. So, if the user utterance consists of a dollar first time, USD might rank higher than SGD (Singapore Dollar) because of the popularity. But if the user explicitly mentions SGD, the bot continues to consider SGD for the dollar from there.<\/div>\n<div><\/div>\n<pre class=\"\">\"CurrencyEntity\":[\r\n{\r\n\"code\": \"SGD\",\r\n\"amount\": 20\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"custom\"><span class=\"ez-toc-section\" id=\"Custom\">Custom<\/span><\/h3>\n<p>Define a regular expression to validate the user input in the <strong>Regex<\/strong> field displayed.<\/p>\n<p>For example, enter: <em>[a-zA-Z]{3}[-]\\d{4} <\/em><br \/>\nto return a sample response as: <code>{\"regex\":\"NLP-1234\"}<\/code><\/p>\n<p>For more information, see <a href=\"https:\/\/en.wikipedia.org\/wiki\/Regular_expression\">Regex Expressions<\/a>.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"composite\"><span class=\"ez-toc-section\" id=\"Composite\">Composite<\/span><\/h3>\n<p>Composite entities can be used to capture multiple entity values in one entity.<\/p>\n<p>For example, consider the sales inquiries to car sales. Typical queries can be of the form: \u2018I am interested in Tesla Model S 2018 model\u2019 or \u2018What would a red Tesla 2010 model cost\u2019 or \u2018Tell me about Tesla Model S\u2019.<\/p>\n<p>As you can see, the bot typically needs to process a combination of details like Make, Model, Year and Color to respond to those queries.<\/p>\n<p>These scenarios are taken care of by the Composite Entity Type.<br \/>\n<a href=\"\/v7-3\/docs\/bots\/bot-builder-tool\/develop\/dialog-task\/working-with-composite-entities\/\" target=\"_blank\" rel=\"noopener noreferrer\">Refer here<\/a> to know more about Composite Entity Types.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"date\"><span class=\"ez-toc-section\" id=\"Date\">Date<\/span><\/h3>\n<p>Captures a date mention from a user utterance. For example, &#8220;<em>Book a flight on the 10th of October&#8221;,<\/em> returns the value for Date in ISO8601 date format as YYYY-MM-DD.<\/p>\n<p>The bot recognizes all possible ways and formats of dates, like:<\/p>\n<ul>\n<li><em>formatted dates<\/em> like YYYY-MM-DD,\u00a0DD-MM-YYYY,\u00a0DD-MM-YY,\u00a0YYYY\/MM\/DD,\u00a0DD\/MM\/YYYY,\u00a0DD\/MM\/YY,\u00a0YYYY.MM.DD,\u00a0DD.MM.YYYY,\u00a0DD.MM.YY<\/li>\n<li><em>all number dates<\/em>\u00a0like YMD and DMY for 20180518 and 09102013<\/li>\n<li><em>formatted dates with space separators<\/em> like YYYY MM DD.\u00a0dd\/mm yyyy,\u00a0dd-mm,\u00a0dd-mm-yyyy,\u00a0dd-mm-yy,\u00a0mm-dd,\u00a0dd \/ mm \/ yyyy,\u00a0dd . mm . yyyy,\u00a0ddmm yyyy,\u00a0mmdd<\/li>\n<li><em>named months<\/em> like yyyy\/dd\/monthNames or yyyy-dd-monthNames or\u00a0dd.monthNames.yyyy 2018\/28\/Dec or\u00a02018-28-Dec or 28.Dec.2018<\/li>\n<li><em>absolute dates related to now<\/em> like today,\u00a0tomorrow,\u00a0yesterday,\u00a0tonight,\u00a0this evening,\u00a0this afternoon,\u00a0day after tomorrow,\u00a0day before yesterday,\u00a0yesterday morning,\u00a0tomorrow night,\u00a0tomorrow for 1 hour,\u00a03 days ago,\u00a024 hours ago,\u00a0in 3 days,\u00a02 months hence,\u00a0this day next month last year,\u00a0next June,\u00a0June 26 of year after next,\u00a0in a week,\u00a02 weeks ago,\u00a022nd of this month,\u00a0Next month this day,\u00a0Next 25th,\u00a0This month 30th,\u00a027th of this month,\u00a03rdmonth,\u00a02nd of month<\/li>\n<li><em>named dates<\/em> like Christmas Day,\u00a0Christmas Eve,\u00a0Memorial Day this year,\u00a0Thanksgiving 2018,\u00a0last Thanksgiving,\u00a0week after Thanksgiving,\u00a0Passover,\u00a0day before new year,\u00a0day after Christmas<\/li>\n<li><em>relative dates from absolute<\/em> like\u00a02 more days from tomorrow,\u00a03 days after July 4th,\u00a03 days from now,\u00a05days from today,\u00a0Need two more days,\u00a0in 2days<\/li>\n<li><em>weekdays<\/em> like Saturday, coming Monday, Sunday, Saturday, next weekend, First Saturday of the upcoming year, First Sunday of the upcoming month, first Saturday of next month, First Sunday of next year<\/li>\n<\/ul>\n<pre class=\"\">\"entities\":\r\n{\r\n\"DateEntity\": \"1982-04-13\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"datetime\"><span class=\"ez-toc-section\" id=\"Date_Time\">Date Time<\/span><\/h3>\n<p>Captures a date grouping along with time in a user utterance.<\/p>\n<p>For example, &#8220;<em>Book a flight on the 10th of October at 6 pm&#8221;, r<\/em>eturns the value for Date Time in ISO8601 date format as YYYYY-MM-DDThh: mm: ss.sTZD.<\/p>\n<p>The bot recognizes all possible ways and formats of expressing dates and time.<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"DateEntity\": \"2017-10-10T18:00:00+05:30\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"dateperiod\"><span class=\"ez-toc-section\" id=\"Date_Period\">Date Period<\/span><\/h3>\n<p>Captures start date and end date from the user input, for example, Book the hotel for five days starting May 5. If the user input doesn\u2019t include one or both of the dates, the bot prompts the user to provide the necessary input.<\/p>\n<div class=\"alert alert-info\">\n<p><b>Note<\/b>: Unlike other entities, Date Period entities allow you to enter two sets of user and errors prompts:<\/p>\n<ol>\n<li>User and Error Prompts for From Date<\/li>\n<li>User and Error Prompts for To Date<\/li>\n<\/ol>\n<\/div>\n<p>The following table lists how the entity works in different scenarios:<\/p>\n<table>\n<thead>\n<tr>\n<th>Input Type<\/th>\n<th>Bot Behaviour<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Doesn\u2019t include both From and To dates [e.g., Book hotel]<\/td>\n<td>Shows <b><i>User Prompts for From Date<\/i><\/b> to the user<\/td>\n<\/tr>\n<tr>\n<td>Includes either From or To date [e.g., Book a hotel from 15th Aug]<\/td>\n<td>Shows <b><i>User Prompts for From Date<\/i><\/b> or <b><i>User Prompts for To Date<\/i><\/b> based on which is missing from the input<\/td>\n<\/tr>\n<tr>\n<td>Includes implicit reference to From Date and duration [e.g., Book a hotel for five days starting from Tuesday]<\/td>\n<td>Determines both dates<\/td>\n<\/tr>\n<tr>\n<td>Includes From Date and duration [e.g., Book a hotel for five days from 15th Nov]<\/td>\n<td>Determines both dates<\/td>\n<\/tr>\n<tr>\n<td>Includes From Date and To Date [e.g., Book a hotel from 5th to 10th]<\/td>\n<td>Determines both dates<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"description\"><span class=\"ez-toc-section\" id=\"Description\">Description<\/span><\/h3>\n<p>Captures statements or paragraphs of text from the user utterance. The value for Description is returned as a string and can include wild characters.<\/p>\n<div class=\"alert alert-info\"><strong>Note<\/strong>: Is Multi-Item is not available for this entity type.<\/div>\n<div><\/div>\n<pre class=\"\">\"entities\":\r\n{\r\n\"Description\": \"text here\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"email\"><span class=\"ez-toc-section\" id=\"Email\">Email<\/span><\/h3>\n<p>Captures email address from the utterance. For example, &#8220;<em>Send an email to help@koremessenger.com&#8221;<\/em> returns the value of <strong><span style=\"color: #000000;\">Email <\/span><\/strong>as a string.<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"Email\": \"help@koremessenger.com\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"enum\"><span class=\"ez-toc-section\" id=\"List_of_Items_enumerated\">List of Items (enumerated)<\/span><\/h3>\n<p>Display a list of values to the end-user. To define the list type, click the <strong>Settings <\/strong>icon located to the immediate right of the <strong>Type<\/strong> field to open the <strong>List of items (enumerated) Setup<\/strong> page to define one of the following list types.<\/p>\n<p>This feature might not be fully supported in all languages, <a href=\"\/v7-3\/docs\/bots\/how-tos\/multi-lingual-bot-behavior\/#Feature_Support\" target=\"_blank\" rel=\"noopener noreferrer\">see here for details<\/a>.<\/p>\n<ul>\n<li><strong>Static List<\/strong> &#8211; Enter the <strong>Display Name<\/strong> for the key, the <strong>Value<\/strong> for the key, and optionally, enter <strong>synonyms<\/strong> for the key. Set up <a href=\"#auto\">Auto Correction<\/a> value for the user inputs.<\/li>\n<li><strong>List from context<\/strong> &#8211; Define a context variable to use for this item in the following fields:\n<ul>\n<li><strong>Specify Context Variable to Use<\/strong> &#8211; Defines the context object type, for example, EnterpriseContext, BotContext, UserContexts, or session variables such as context.entities. Enter <code>context.<\/code> and then select a context object type.<\/li>\n<li><strong>Display Name Key<\/strong> &#8211; The name displayed to the end-user.<\/li>\n<li><strong>Value Key<\/strong> &#8211; The key that represents the value of the item in the list.<\/li>\n<li><strong>Synonyms Key<\/strong> &#8211; Enter one or more synonyms for the key (<a href=\"\/v7-3\/docs\/bots\/nlp\/additional-notes-nlp-settings-guidelines\/#Synonyms\" target=\"_blank\" rel=\"noopener noreferrer\">see here for more<\/a>).<\/li>\n<\/ul>\n<\/li>\n<li id=\"auto\"><strong>Auto-Correction<\/strong>&#8211; Set up auto-correct thresholds for the LOV entity type so that it not only accepts exact matches but also closest utterances with small variations. For example, let\u2019s consider that a list value called Apple for which a typo such as \u201cappel\u201d could be accepted based on your threshold settings. The Auto-Correction setting works in the following way:\n<ol>\n<li>The bot identifies the number of letters to be changed (inserts, deletes or replaces) in user input to match it to a value in the list<\/li>\n<li>The number is converted to a percentage of the total number of letters in the input<\/li>\n<li>The list value with the highest similarity is considered as input if the score is greater than or equal to the configured percentage.<\/li>\n<\/ol>\n<div class=\"alert alert-info\">Spell correction doesn&#8217;t apply to dictionary words or alphanumeric inputs.<\/div>\n<\/li>\n<\/ul>\n<p>Post <span style=\"text-decoration: underline;\">ver7.1<\/span>, the following keys have been added to the context object for the below-mentioned usage:<\/p>\n<ul>\n<li><strong>ambiguousEntityValues<\/strong>: this key will contain values when the user input for a multi-item entity is ambiguous. Using this, you can check if any ambiguous values were identified and construct the flow to resolve the ambiguity. This key will be reset if the entity is re-prompted during the dialog. The values will be in the form of an array of JSON objects, each object containing title, value, and synonym.<\/li>\n<li><strong>synonymsUsed<\/strong>: this key will hold the synonym used for identifying the item. You can use this value to personalize the Bot response accordingly if needed. This key will be reset if the entity is re-prompted during the dialog.<\/li>\n<\/ul>\n<p>For the list to be presented to the user, you need to set the <strong>Display List of Values<\/strong> to\u00a0<em>Yes.<\/em> This would present the list of values to the user in the channel-specific format, you may want to use a template as per your requirement (<a href=\"\/v7-3\/docs\/bots\/sdks\/message-templates\/\" target=\"_blank\" rel=\"noopener noreferrer\">see here for more<\/a>).<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/15\/LoI_displaySettings-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-23946\" src=\"\/wp-content\/uploads\/sites\/15\/LoI_displaySettings-1.png\" alt=\"\" width=\"823\" height=\"507\" srcset=\"https:\/\/developer.kore.ai\/v7-3\/wp-content\/uploads\/sites\/15\/LoI_displaySettings-1.png 823w, https:\/\/developer.kore.ai\/v7-3\/wp-content\/uploads\/sites\/15\/LoI_displaySettings-1-300x185.png 300w\" sizes=\"auto, (max-width: 823px) 100vw, 823px\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"lookup\"><span class=\"ez-toc-section\" id=\"List_of_items_lookup\">List of items (lookup)<\/span><\/h3>\n<p>Display a list of values to the end-user. To define the lookup list, click the <strong>Settings<\/strong> icon located to the immediate right of the <strong>Type<\/strong> field to open the <strong>List of items (lookup) Setup<\/strong> page.<\/p>\n<p>This feature might not be fully supported in all languages, <a href=\"\/v7-3\/docs\/bots\/how-tos\/multi-lingual-bot-behavior\/#Feature_Support\" target=\"_blank\" rel=\"noopener noreferrer\">see here for details<\/a>.<\/p>\n<p>You can define either a <strong>Static List <\/strong>or\u00a0a <strong>Remote List<\/strong>.<\/p>\n<h4>Static List<\/h4>\n<p>Use <em>Static List<\/em> to define the entity values as one of the following list types:<\/p>\n<ul>\n<li><strong>JSON tab<\/strong> &#8211; Enter a list of key\/value pairs and synonyms (<a href=\"\/v7-3\/docs\/bots\/nlp\/additional-notes-nlp-settings-guidelines\/#Synonyms\" target=\"_blank\" rel=\"noopener noreferrer\">see here for more<\/a>), for example:\n<pre class=\"\">[{\r\n\"title\": \"United States\",\r\n\"value\": \"US\",\r\n\"synonyms\": [\"united states\", \"USA\", \"US\", \"U.S.A\", \"America\"]\r\n},\r\n{\r\n\"title\": \"John F. Kennedy International Airport\",\r\n\"value\": \"JFK\",\r\n\"synonyms\": [\"John F. Kennedy International Airport\", \"New York International Airport\", \"JFK\"]\r\n}\r\n]<\/pre>\n<\/li>\n<li><strong>Editor tab<\/strong> &#8211; Enter the <strong>Display Name<\/strong> for the key, the <strong>Value<\/strong> for the key, and optionally, enter Synonyms for the key.<\/li>\n<li><strong>Upload File<\/strong> &#8211; Click to navigate to and select a JSON formatted file list, or a .csv file formatted list of key\/value pairs, for example,<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/15\/DIYEntityTypeCSV.png\"><img loading=\"lazy\" decoding=\"async\" class=\"size-full wp-image-11469 alignnone\" src=\"\/wp-content\/uploads\/sites\/15\/DIYEntityTypeCSV.png\" alt=\"CSV File Format\" width=\"1480\" height=\"124\" \/><\/a><\/li>\n<\/ul>\n<p>Post <span style=\"text-decoration: underline;\">ver7.1<\/span>, the following keys have been added to the context object for the below mentioned usage:<\/p>\n<ul>\n<li><strong>ambiguousEntityValues<\/strong>: this key will contain values when the user input for a multi-item entity is ambiguous. Using this, you can check if any ambiguous values were identified and construct the flow to resolve the ambiguity. This key will be reset if the entity is re-prompted during the dialog. The values will be in the form of an array of JSON objects, each object containing title, value and synonym.<\/li>\n<li><strong>synonymsUsed<\/strong>: this key will hold the synonym used for identifying the item. You can use this value to personalize the Bot response accordingly if needed. This key will be reset if the entity is re-prompted during the dialog.<\/li>\n<\/ul>\n<p>For the list to be presented to the user, you need to set the <strong>Display List of Values<\/strong> to\u00a0<em>Yes.<\/em> This would present the list of values to the user in the channel-specific format, you may want to use a template as per your requirement (<a href=\"\/v7-3\/docs\/bots\/sdks\/message-templates\/\" target=\"_blank\" rel=\"noopener noreferrer\">see here for more<\/a>).<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/15\/LoI_displaySettings-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-23946\" src=\"\/wp-content\/uploads\/sites\/15\/LoI_displaySettings-1.png\" alt=\"\" width=\"823\" height=\"507\" srcset=\"https:\/\/developer.kore.ai\/v7-3\/wp-content\/uploads\/sites\/15\/LoI_displaySettings-1.png 823w, https:\/\/developer.kore.ai\/v7-3\/wp-content\/uploads\/sites\/15\/LoI_displaySettings-1-300x185.png 300w\" sizes=\"auto, (max-width: 823px) 100vw, 823px\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h4 id=\"remote\">Remote List<\/h4>\n<p><em>Remote List<\/em> can be used when the entity extraction needs to be done by an external service due to security restrictions or any other reasons. This can also be used to handle large data.<\/p>\n<p>The <strong>steps<\/strong> would involve:<\/p>\n<ol>\n<li><strong>Define the service call<\/strong>: You can set up a service call similar to how a service node is currently set up. You can set headers, body (for POST), etc.. (<a href=\"\/v7-3\/docs\/bots\/bot-builder-tool\/dialog-task\/working-with-the-service-node\/\" target=\"_blank\" rel=\"noopener noreferrer\">see here for more<\/a>).<br \/>\nThe external service being invoked should have a provision to accept and handle the user utterance data that the platform would be populating. The <code>context.inputData<\/code> object with the following fields will be used for that purpose:<\/p>\n<ul>\n<li><strong>input<\/strong> &#8211; array containing the list of inputs received from user for the current dialog;<\/li>\n<li><strong>usedUp<\/strong> &#8211; index form of words that are already used for other entities or intents. The format is <em>x-y-z<\/em> where\n<ul>\n<li>x represents the sentence\/utterance index (0 till n)<\/li>\n<li>y represents the start index of the used up word within the x utterance and<\/li>\n<li>z represents the end index of the used up word;<\/li>\n<li><em>sentenceindex-x-x<\/em> represents no used up words in that sentence;<\/li>\n<li>If multiple words are used-up in a single sentence these should be entered as comma-seperated values;<\/li>\n<\/ul>\n<\/li>\n<li><strong>isMultiItem<\/strong> &#8211; flag should be set if multiple values are expected from the service call\n<pre>  \"inputData\": {\r\n    \"input\": [\r\n      \"get account\"\r\n    ],\r\n    \"usedUp\": [\r\n      \"0-x-x\"\r\n    ],\r\n    \"isMultiItem\": false\r\n  }<\/pre>\n<\/li>\n<\/ul>\n<\/li>\n<li><strong>Map Response<\/strong> from the service call with the following fields:\n<ul>\n<li>the <em>context variable<\/em> that will hold the response data from the service call. This should be in an <em>array format.<\/em><\/li>\n<li><em>Display Key Name<\/em> &#8211; name to be used to refer to this field, this name is used when interacting with the users for example in disambguation scenario. This can be accessed using <code>{{context.entities.&lt;entity-name&gt;.title}}<\/code>.<\/li>\n<li><em>Value Key<\/em> &#8211; the field name in the response body from the service call that holds the value, the entity will be assigned this value. This can be accessed using <code>{{context.entities.&lt;entity-name&gt;.value}}<\/code>.<\/li>\n<li><em>Synonyms Key<\/em> &#8211; the field containing the synonyms for this field, if any. This is the value that the user might refer to for example in response to disambiguation question. This can be accessed using <code>{{context.entities.&lt;entity-name&gt;.synonym}}<\/code>.<\/li>\n<li><em>Matched Word Index<\/em> to indicate the words in the inputData that were used for entity extraction (in the same format as the usedUp value in the context.inputData object). This will be used by the platform to mark the word as used in the user utterance.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/15\/entity_remote.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-22360\" src=\"\/wp-content\/uploads\/sites\/15\/entity_remote.png\" alt=\"\" width=\"1366\" height=\"768\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/15\/20221201095308\/entity_remote.png 1366w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/15\/20221201095308\/entity_remote-300x169.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/15\/20221201095308\/entity_remote-1024x576.png 1024w\" sizes=\"auto, (max-width: 1366px) 100vw, 1366px\" \/><\/a><\/p>\n<p><strong>Flow:\u00a0<\/strong>The platform will:<\/p>\n<ol>\n<li>Populate the <code>context.inputData<\/code> with the values as mentioned above.<\/li>\n<li>Make the service call to fetch the entity values passing the values as configured in the service call<\/li>\n<li>Use the values returned as per Response Mapping\n<ul>\n<li>If a single value is returned by the remote system, then that value will be assigned to the entity<\/li>\n<li>If multiple values are returned by the remote system, the platform will extract the entity from this list\n<ul>\n<li>if a match is found, it is assigned to the entity<\/li>\n<li>if no match is found, then the user will be presented with the list of values to choose from.\u00a0If the user input matches with any of the items in the list, then it will be assigned to the entity.\u00a0If the user input does not match any of the items, then the input will be updated in the context object and another call to the remote service will be initiated<\/li>\n<li>If one or more matches are found, then it is considered as ambigious and the user will be presented with the choices. \u00a0If the user input matches with any of the items in the list, then it will be assigned to the entity. If the user input does not match any of the items, then the input will be updated in the context object and another call to the remote service will be initiated<\/li>\n<\/ul>\n<\/li>\n<li>If the entity is marked as a multi-item entity, then the list of values returned from the remote server will be re-evaluated and all valid (valid as per entity type) list items will be assigned as values for the entity.\u00a0Invalid list items will be discarded<\/li>\n<\/ul>\n<\/li>\n<li>Handle the following exceptions\n<ul>\n<li>In case the response from the Service call is empty or not in the expected format, the User Prompt settings for the entity would be used to prompt the user for input.<\/li>\n<li>In case of ambiguity, for example when the service returns multiple values when one is expected, the user will be prompted to choose one from the list of values returned by the service.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"location\"><span class=\"ez-toc-section\" id=\"Location\">Location<\/span><\/h3>\n<p>Captures the location details of a city or state from a user utterance.<\/p>\n<p>For example, in Bellagio, Las Vegas the entity captures the location details of Las Vegas. The entity returns the location of the object with address and coordinates as a JSON response.<\/p>\n<pre class=\"\">\"Location\":\r\n{\r\n\"formatted_address\": \"Las Vegas, NV, USA\",\r\n\"lat\": 36.1699412,\r\n\"lng\": -115.1398296\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"number\"><span class=\"ez-toc-section\" id=\"Number\">Number<\/span><\/h3>\n<p>Captures a number from a user utterance. For example, &#8220;<em>Book a room for 16 people&#8221;<\/em>. In this example, the value 16 is returned as the Number.<\/p>\n<p>The Bots Platform recognizes the spelled out numbers and also standard abbreviations such as 1M. Consecutive number words are combined into one number, for example, one two three becomes 123.<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"NumberEntity\": 16\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"name\"><span class=\"ez-toc-section\" id=\"Person_Name\">Person Name<\/span><\/h3>\n<p>Captures the full name of a person from a user utterance.<\/p>\n<p>For example, &#8220;<em>Send an email to John Smith&#8221;,<\/em>\u00a0where <em>John Smith<\/em> is identified as Person Name.<\/p>\n<p>Kore.ai Bot Platform assumes that the first word in the user utterance with capital letters as the first name along and the next two words in camel case as a part of the name.<\/p>\n<p>For example, if the user utterance is \u201c<em>I want to talk to John Smith<\/em>,\u201d it recognizes <em>John Smith<\/em> as the name. If the utterance is \u201c<em>I want to talk to John smith immediately<\/em>\u201d it recognizes only <em>John<\/em> as the name.<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"PersonName\": \"John Smith\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"percent\"><span class=\"ez-toc-section\" id=\"Percentage\">Percentage<\/span><\/h3>\n<p>Captures the percentage value from a user utterance.<\/p>\n<p>For example, &#8220;<em>The chance of rain today is more than 60 percent&#8221;<\/em>, where 60 is the Percentage and is returned as a float value of 0.6 in a range of (0.0-1.0).<span style=\"color: #000000;\"> It supports percent, percentage, and the % sign.<\/span><\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"PercentageEntity\": 0.6\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"phone\"><span class=\"ez-toc-section\" id=\"Phone_Number\">Phone Number<\/span><\/h3>\n<p>Captures standard 10-digit or 12-digit telephone numbers.<\/p>\n<p>For example, &#8220;<em>Please call 4075551212&#8243;, <\/em>the value for Phone Number is <em>4075551212<\/em> and is returned as a number.<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"PhoneNumber\": \"+<em>4075551212<\/em>\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"quantity\"><span class=\"ez-toc-section\" id=\"Quantity\">Quantity<\/span><\/h3>\n<p>Captures the quantity in an utterance with the following details from the user utterance:<\/p>\n<ul>\n<li>Type of the quantity (length, area, volume, etc.),<\/li>\n<li>unit of measurement (kilometers, square kilometer, cubic meter, etc.),<\/li>\n<li>the amount (100, 500, 1.5, etc.).<\/li>\n<\/ul>\n<p>When you select Quantity entity type, you also need to select a unit type for the quantity and the default measure.<\/p>\n<p>For example, for capturing volumes, select Volume as the Unity type and Milliliters as the Default unit. So, if a user utterance is &#8220;<em>Add 500 ml of water&#8221;<\/em>, the following JSON is returned<\/p>\n<pre class=\"\">\"Quantity\":\r\n{\r\n\"unit\": \"millilitre\",\r\n\"amount\": 500,\r\n\"type\": \"volume\",\r\n\"source\": \"500 ml\"\r\n}<\/pre>\n<p>Bots platform identifies all these quantities and unites along with the standard abbreviations, codes, and symbols.<\/p>\n<table>\n<thead>\n<tr>\n<th>Type<\/th>\n<th>Units<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>Length<\/strong><\/td>\n<td>\n<ul>\n<li>kilometer<\/li>\n<li>meter<\/li>\n<li>centimeter<\/li>\n<li>inch<\/li>\n<li>foot<\/li>\n<li>yard<\/li>\n<li>mile<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><strong>Area<\/strong><\/td>\n<td>\n<ul>\n<li>square kilometer<\/li>\n<li>square meter<\/li>\n<li>square mile<\/li>\n<li>square yard<\/li>\n<li>square foot<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><strong>Volume<\/strong><\/td>\n<td>\n<ul>\n<li>cubic meter<\/li>\n<li>liter<\/li>\n<li>milliliter<\/li>\n<li>gallon<\/li>\n<li>ounce<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Time<\/td>\n<td>\n<ul>\n<li>hour<\/li>\n<li>minute<\/li>\n<li>second<\/li>\n<li>millisecond<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Speed<\/td>\n<td>\n<ul>\n<li>meters per second<\/li>\n<li>kilometers per hour<\/li>\n<li>miles per hour<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><strong>Pressure<\/strong><\/td>\n<td>\n<ul>\n<li>pascal<\/li>\n<li>atmosphere<\/li>\n<li>bar<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><strong>Energy<\/strong><\/td>\n<td>\n<ul>\n<li>calorie<\/li>\n<li>kilocalorie<\/li>\n<li>watt-hour<\/li>\n<li>kilowatt hour<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><strong>Memory<\/strong><\/td>\n<td>\n<ul>\n<li>bit<\/li>\n<li>byte<\/li>\n<li>kilobyte<\/li>\n<li>megabyte<\/li>\n<li>terabyte<\/li>\n<li>gigabyte<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><strong>Weight<\/strong><\/td>\n<td>\n<ul>\n<li>ton<\/li>\n<li>kilogram<\/li>\n<li>gram<\/li>\n<li>pound<\/li>\n<li>ounce<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><strong>Angle<\/strong><\/td>\n<td>\n<ul>\n<li>degree<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><strong>Age<\/strong><\/td>\n<td>\n<ul>\n<li>Day<\/li>\n<li>Week<\/li>\n<li>Month<\/li>\n<li>Year<\/li>\n<li>Decade<\/li>\n<li>Century<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><b>Temperature<\/b><\/td>\n<td>\n<ul>\n<li>celsius<\/li>\n<li>fahrenheit<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"string\"><span class=\"ez-toc-section\" id=\"String\">String<\/span><\/h3>\n<p>Works identical to the <a href=\"#description\">Description entity type<\/a> but limited to one sentence.<\/p>\n<p>There wont be any validations done on the user utterance for string entities, unless trained. Hence this entity type should be used as a last resort when your requirement is not met with any of the platform supported entity types.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"time\"><span class=\"ez-toc-section\" id=\"Time\">Time<\/span><\/h3>\n<p>Capture time in a user utterance.<br \/>\nFor example, &#8220;<em>Set my alarm for 6 am&#8221;, <\/em>\u00a0returns the value of Time in ISO 8601 time format as hh:mm:ss.sZD.<br \/>\nIt recognizes the following denotations:<\/p>\n<ul>\n<li style=\"list-style-type: none;\">\n<ul>\n<li>am, a.m., AM, pm, p.m., PM, P.M.<\/li>\n<li>Numbers spelled out, for example, Six AM.<\/li>\n<li>Morning and evening, for example, Six in the evening.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<pre class=\"\">\"entities\":\r\n{\r\n\"TimeEntity\": \"T06:00:00+05:30\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"timezone\"><span class=\"ez-toc-section\" id=\"Time_Zone\">Time Zone<\/span><\/h3>\n<p>A time zone. &#8220;<em>Eastern standard time&#8221; <\/em>converts the timezone into GMT and stores the resulting value.<br \/>\nFor example, if you type EST, it is stored as -6:00.<br \/>\nBots Platform recognizes the standard time zones.<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"TimeZoneEntity\": \"-06:00\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"url\"><span class=\"ez-toc-section\" id=\"URL\">URL<\/span><\/h3>\n<p>Captures a web URL from the utterance. The bot recognizes all standard formats of URLs.<br \/>\nFor example, &#8220;<em>Visit our website: www.kore.ai&#8221;<\/em>. The value for URL is returned as a string.<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"URLEntity\": \"www.kore.ai\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"zip\"><span class=\"ez-toc-section\" id=\"Zip_Code\">Zip Code<\/span><\/h3>\n<p>Captures a US zip code from the user utterance, for example, &#8220;<em>What is the weather for 32746?&#8221;<\/em> The value for <strong>Zip Code<\/strong> is 32746 and is returned as a string.<\/p>\n<pre class=\"\">\"entities\":\r\n{\r\n\"ZipcodeEntity\": \"32746\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"The Entity Type provides the NLP Interpreter with the expected type of data from a user utterance to enhance recognition and system performance.\u00a0 The Kore.ai NLP interpreter extracts the entity from the user utterance. If the user does not enter a required entity, you can define a Bot Response node to prompt the user to...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[29],"tags":[],"class_list":["post-18095","post","type-post","status-publish","format-standard","hentry","category-dialog-task"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/posts\/18095","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/comments?post=18095"}],"version-history":[{"count":31,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/posts\/18095\/revisions"}],"predecessor-version":[{"id":24855,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/posts\/18095\/revisions\/24855"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/media?parent=18095"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/categories?post=18095"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/tags?post=18095"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}