{"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-30T06:56:48","modified_gmt":"2021-03-30T05:56:48","slug":"working-with-the-entity-node","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v7-2\/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, TimeZone. 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 may 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

Setting up an Entity Node<\/span><\/h2>\n

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

Step 1: Adding 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. Hover over a node next to which you want to add the entity node, and click the plus icon on it.<\/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 Component Properties panel for the Entity Node opens.<\/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

    Step 2: Configuring the Component Properties<\/span><\/h3>\n

    The Entity Component Properties allow 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<\/span> that use this node.<\/div>\n

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

      \n
    1. Enter a Name<\/strong> and Display Name<\/strong>\u00a0for the Entity node. Entity names cannot have spaces.<\/li>\n
    2. From the Type <\/b>drop-down 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 will do 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, see the       Entity Types<\/a><\/li>\n
    3. Based on the Type selected, you might have an option to set the Entity as\u00a0Multi-Item<\/strong> thereby allowing the user multiple selections.<\/li>\n
    4. In the User Prompt<\/b> text box, 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, see Using the Prompt Editor<\/a>.<\/li>\n
    5. In the Error Prompts<\/b> box, review the default error message, and if required, click Edit Errors<\/b> to modify it. For more information, see Using the Prompt Editor<\/a>.<\/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

      Step 3: Configuring the Instance Properties<\/span><\/h3>\n

      Use the Instance Properties to determine whether to make the Entity value mandatory as well as to choose if you want to consider values from previous user utterances to capture entities.<\/p>\n

      Note:<\/b> The settings in the Instance Properties panel are specific to the current Dialog Task and do not reflect in the other dialog tasks<\/span> that use this entity node.<\/div>\n

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

        \n
      1. Click the Instance Properties icon on the Entity node.<\/li>\n
      2. Under the User Input section, select an option (see below for how the entity flow is managed<\/a>):\n