{"id":17952,"date":"2016-12-06T23:41:55","date_gmt":"2016-12-06T23:41:55","guid":{"rendered":"https:\/\/developer.kore.com\/?post_type=docs&p=9158"},"modified":"2021-03-25T18:05:27","modified_gmt":"2021-03-25T18:05:27","slug":"working-with-the-entity-node","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/bot-builder-tool\/dialog-task\/working-with-the-entity-node\/","title":{"rendered":"Working with the Entity Node"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Bots need to extract relevant information from the user utterance to fulfill the user intent. <\/span><\/p>\n

Take a look at this sample utterance: Book me a flight from LA to NYC on Sunday<\/em>. \u00a0To act on this user intent, which is to book a flight ticket, the bot should extract the entities such as the source city<\/em> (LA), destination city<\/em> (NYC), and the departure date<\/em> (Sunday). <\/span><\/p>\n

So, in a Dialog Task, for every critical data you want to get from a user utterance, you should create a corresponding entity node. You can add prompt messages to these nodes for users to input the required values. <\/span>
\nKore.ai supports more than 30 entity types such as Address, Airport, Quantity, and so on. You can also define the entities as a selection from a list, free-form entry, file or image attachment from a user, or as regex expressions. <\/span><\/p>\n

Note:<\/b> You need to follow one entity node with several other entity nodes to collect series of user inputs to complete a transaction, such as a username, location, amount, and due date, followed by a Webhook node to process a request to an API to complete an online transaction.<\/div>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Set Up an Entity Node<\/span><\/h2>\n

Setting up an entity node in a dialog task involves the following steps:<\/p>\n

Add an Entity Node to the Dialog Task<\/span><\/h3>\n
    \n
  1. Open the Dialog Task where you want to add the entity node.<\/li>\n
  2. Click the +<\/strong> icon next to the respective node.<\/li>\n
  3. Select Entity > New entity node <\/b>(you can also use an existing entity node, by selecting from the list).
    \n\"\"<\/a><\/li>\n
  4. The Entity window is displayed with the Component Properties<\/strong> tab selected by default.<\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Configure the Component Properties<\/span><\/h3>\n

    The Entity window allows you to configure the General Settings, User, and Error Prompts.<\/p>\n

    Note:<\/b> The configurations you set up or modify in this section are reflected in all other dialog tasks\u00a0that use this node.<\/div>\n

    \"\"<\/a><\/p>\n

      \n
    1. On the Component Properties<\/strong> tab, under the General Settings <\/strong>section, enter a Name<\/strong> and Display Name<\/strong> for the entity node. Entity names cannot have spaces.<\/li>\n
    2. From the Type <\/b>drop-down list, select an entity type depending on the expected user input. For example, if you want the user to type the departure date, select Date <\/b>from the drop-down. The platform does the basic validation based upon the Type selected.
      \nThe Entity Type<\/strong> provides the NLP Interpreter with the expected type of data from a user utterance to enhance recognition and system performance. For more information, refer to       Entity Types<\/a><\/li>\n
    3. Based on the Type selected, you have an option to set the Entity as Multi-item<\/strong> thereby allowing the user multiple selections.<\/li>\n
    4. Under the User Prompt<\/b> section, enter the prompt message that you want the user to see for this entity. For example, Enter the Departure Date<\/em>. You can enter channel-specific messages for user prompts. For more information, refer to Using the Prompt Editor<\/a>.<\/li>\n
    5. Under the Error Prompts<\/b> section, review the default error message, and if required, you can modify the error messages. To manage the error messages, click Manage Error Messages<\/strong>. For more information, refer to Using the Prompt Editor<\/a>. You can also reorder the error messages. To reorder,\n