{"id":18128,"date":"2019-02-12T10:34:40","date_gmt":"2019-02-12T10:34:40","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-2\/?post_type=docs&#038;p=16539"},"modified":"2021-08-14T08:58:04","modified_gmt":"2021-08-14T07:58:04","slug":"amend-entity","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-2\/docs\/bots\/bot-intelligence\/amend-entity\/","title":{"rendered":"Amend Entity"},"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>Time and again, we come across situations wherein the users change their preferences during task execution.<\/p>\n<p><em>For example<\/em>, while booking a flight, the user might change the date of travel and at times even the destination.<\/p>\n<p><strong>Amend Entity<\/strong>\u00a0is a feature for such scenarios. Using this feature, you can allow the users to amend entity values and also control the post-amendment dialog behavior.<\/p>\n<p>The entity amendment process is divided into three stages:<\/p>\n<ul>\n<li><strong>Amend Identification<\/strong>: Identifying that the end-user wants to amend is driven by the bot\u2019s built-in NLP capabilities.<\/li>\n<li><strong>Amending Entities<\/strong>: On identifying the intention to amend, the current task is put on hold and the amend flow is triggered. Three kinds of amend flows are possible based upon the user utterance:\n<ul>\n<li>When the user refers to the entity name (or entity synonyms), then they are prompted for the entity value. For example, the user utterance <em>I want to change the destination<\/em> triggers the prompt for the destination entity. If the same entity node is present multiple times in the dialog, then the latest entity node for which the user has already provided input will be amended.<\/li>\n<li>When the user gives the entity value then the entity is updated accordingly. For example, the user utterance <em>I want to fly to JFK<\/em> changes the destination entity value. If the value is compatible with two or more entities in the dialog, then the user is prompted to select an entity to amend.<\/li>\n<li>When the user refers to both the entity and its value, then the entity is updated. For example, the user utterance <em>change my destination to JFK<\/em>\u00a0will change the destination entity value.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Post Amendment Behavior<\/strong>: After an entity is successfully amended, there are three possible dialog execution flows that your bot can be configured for:\n<ul>\n<li>The dialog can be re-executed from the node that is amended by evaluating that entity\u2019s connections.<\/li>\n<li>The dialog can resume from the node where amend was identified or made.<\/li>\n<li>The dialog can be resumed from a specified node present in the dialog.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\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<p>Note: This feature is not supported in all languages, <a href=\"https:\/\/developer.kore.ai\/v9-2\/docs\/bots\/how-tos\/multi-lingual-bot-behavior\/#Feature_Support\" target=\"_blank\" rel=\"noopener noreferrer\">Click here for details<\/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<h2><span class=\"ez-toc-section\" id=\"Implementation\"><span id=\"Implementation\" class=\"ez-toc-section\">Implementation<\/span><\/span><\/h2>\n<p>On the Kore.ai platform, Amend Entity behavior is defined at two levels:<\/p>\n<ul>\n<li>Bot level<\/li>\n<li>Task level<\/li>\n<\/ul>\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><span class=\"ez-toc-section\" id=\"Bot_Level\"><span id=\"Bot_Level\" class=\"ez-toc-section\">Bot Level<\/span><\/span><\/h3>\n<p>To Set Bot Level Amend Entity Behavior, follow the below steps:<\/p>\n<ol>\n<li>Select the <strong>Build<\/strong> tab from the top menu<\/li>\n<li>From the left menu, click <strong>Intelligence<\/strong> -&gt; <strong>Amend Entity.\u00a0<\/strong><\/li>\n<li>By default amend entities is disabled.<\/li>\n<li>Once you\u00a0<strong>Allow amend entities<\/strong>, various Dialog Resumption options are available:\n<ul>\n<li><strong>Re-execute dialog from amended entity<\/strong>\u00a0\u2013 use this option to resume the dialog by evaluating the amended entity\u2019s connections. You can further choose to:\n<ul>\n<li><em>Clear entity values captured downstream<\/em>\u00a0\u2013 to clear all entities captured between the identified entity and the amend<\/li>\n<li><em>Skip display of previously displayed messages<\/em>\u00a0\u2013 messages from Message nodes alone.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Resume dialog from amend identification node<\/strong>\u00a0\u2013\u00a0use this option to resume the dialog from the node where the amend was identified.<\/li>\n<\/ul>\n<p><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/20210622101744\/intelligence_AmendEntity.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-27884\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/20210622101744\/intelligence_AmendEntity.png\" alt=\"\" width=\"1365\" height=\"619\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/20210622101744\/intelligence_AmendEntity.png 1365w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/20210622101744\/intelligence_AmendEntity-300x136.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/20210622101744\/intelligence_AmendEntity-1024x464.png 1024w\" sizes=\"auto, (max-width: 1365px) 100vw, 1365px\" \/><\/a><\/li>\n<li>The amend process can be extended to entities marked as <em>Hidden<\/em> using the\u00a0<strong>Amend Hidden Entities <\/strong>option.<\/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><span class=\"ez-toc-section\" id=\"Task_Level\"><span id=\"Task_Level\" class=\"ez-toc-section\">Task Level<\/span><\/span><\/h3>\n<p>To set Task Level Amend Entity Behavior, follow the below steps:<\/p>\n<p>Amend entity behavior is set at the Task level also. The configurations defined at the task level will override the bot-level configurations.<\/p>\n<ol>\n<li>On the Dialog Task page, click the <strong>Ellipses\u00a0<\/strong><a ref=\"magnificPopup\" href=\"https:\/\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/DIYDialogTaskEllipsesIcon.png\"><img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-10353\" src=\"https:\/\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/DIYDialogTaskEllipsesIcon.png\" alt=\"\" width=\"8\" height=\"25\" \/><\/a>\u00a0icon and select the\u00a0<strong>Manage Amend Behaviour<\/strong>.<\/li>\n<li>On the <strong>Manage Amend Behaviour<\/strong> dialog box, by default, the <strong>Use bot level settings<\/strong> option is selected and the bot level setting is displayed.<\/li>\n<li>Select\u00a0<strong>Customize for this task<\/strong> to override the bot level settings:\n<ul>\n<li><strong>Do not allow amend entities<\/strong> &#8211; It will not allow the user to amend entity values for this task.<\/li>\n<li><strong>Allow amend entities<\/strong> &#8211; It will further give you three Dialog Resumption options:\n<ul>\n<li><strong>Re-execute dialog from amended entity<\/strong> \u2013 Amend entity behavior is set at the task level also. The configurations defined at the task level will override the bot-level configurations.\n<ul>\n<li><i>Clear entity values captured downstream<\/i>\u00a0\u2013 to clear all entities captured between the identified entity and the amend<\/li>\n<li><i>Skip display of previously displayed messages<\/i>\u00a0\u2013 messages from Message nodes alone.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Resume dialog from amend identification node<\/strong>\u00a0\u2013\u00a0use this option to resume the dialog from the node where the amend was identified.\n<ul>\n<li><strong>Jump to a specific node in the dialog<\/strong> \u2013\u00a0use this option to select a node from the current dialog where the task flow needs to jump. You can use this option to add custom behavior before resuming with the dialog. Context object will contain the details of the entities amended, along with the previous and current values. You may use this information to customize the dialog.<\/li>\n<\/ul>\n<\/li>\n<li>The amend process can be extended to hidden entities using the\u00a0<strong>Amend Hidden Entities <\/strong>option.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/20210622104023\/intelligence_AmendEntity_dialog.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-27888\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/20210622104023\/intelligence_AmendEntity_dialog.png\" alt=\"\" width=\"693\" height=\"651\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/20210622104023\/intelligence_AmendEntity_dialog.png 693w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v9-2\/wp-content\/uploads\/sites\/26\/20210622104023\/intelligence_AmendEntity_dialog-300x282.png 300w\" sizes=\"auto, (max-width: 693px) 100vw, 693px\" \/><\/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<h2><span class=\"ez-toc-section\" id=\"Triggers\"><span id=\"Additional_Notes\" class=\"ez-toc-section\">Triggers<\/span><\/span><\/h2>\n<p>The following are patterns supporting the Amend Entity behavior. User utterance around these patterns triggers Amend Entity.<\/p>\n<ul>\n<li><code>~amend_synonyms &lt;entity_name&gt; from &lt;old_value&gt; to &lt;new_value&gt;<\/code><br \/>\nFor example, &#8220;<em>change the departure date from today to tomorrow<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms &lt;entity_name&gt; [to as from with] &lt;new_value&gt; [instead_of rather_than not] &lt;old_value&gt;<\/code><br \/>\nFor example, &#8220;<em>modify departure date to tomorrow instead of today<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms &lt;entity_name&gt; &lt;old_value&gt; [to as with] &lt;new_value&gt;<\/code><br \/>\nFor example, &#8220;<em>replace departure date with tomorrow<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms &lt;entity_name&gt; from &lt;old_value&gt;<\/code><br \/>\nFor example &#8220;<em>alter departure date from today<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms &lt;entity_name&gt; [to as from with] &lt;new_value&gt;<\/code><br \/>\nFor example, &#8220;<em>modify departure date to tomorrow<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms {from} &lt;old_value&gt; [to as with] &lt;new_value&gt;<\/code><br \/>\nFor example, &#8220;<em>change from today to tomorrow<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms [to as from] &lt;new_value&gt; [instead_of rather_than not] &lt;old_value&gt;<\/code><br \/>\nFor example, &#8220;<em>change to tomorrow instead of today<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms [to as from] &lt;new_value&gt; instead<\/code><br \/>\nFor example, &#8220;<em>change to tomorrow instead<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms [([it that this] {to}) it that this to] &lt;new_value&gt;<\/code><br \/>\nFor example, &#8220;<em>change it from today to tomorrow<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms &lt;entity_name&gt;<\/code><br \/>\nFor example, &#8220;<em>amend departure date<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms &lt;old_value&gt;<\/code><br \/>\nFor example, &#8220;<em>change today<\/em>&#8220;<\/li>\n<li><code>[to as from] &lt;new_value&gt; [instead_of rather_than not] &lt;old_value&gt;<\/code><br \/>\nFor example, &#8220;<em>to tomorrow instead of today<\/em>&#8220;<\/li>\n<li><code>[to as from] &lt;new_value&gt; instead<\/code><br \/>\nFor example, &#8220;<em>to tomorrow instead<\/em>&#8220;<\/li>\n<\/ul>\n<p>In the above-mentioned patterns the concept <code>~amend_synonyms<\/code> includes <code>\"amend\", \"change\",\"modify\",\"alter\",\"update\", \"replace\", \"make\", \"move\", \"upgrade\", \"want\"<\/code>.<\/p>\n<p><strong>Note<\/strong>: The user can use these patterns to change multiple entity values. For example, <em>Change the departure date from today to tomorrow and departure city to Chicago<\/em> results in the changes to both departure date and city.<\/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<h2><span class=\"ez-toc-section\" id=\"Additional_Notes\"><span id=\"Additional_Notes\" class=\"ez-toc-section\">Additional Notes<\/span><\/span><\/h2>\n<ul>\n<li>Amend functionality is not applicable for the universal bot\u2019s default language. However, when a linked bot is in progress, amend the settings of the linked bot is honored.<\/li>\n<li>The platform\u2019s in-built training data drives the identification of the amend requests, and it is currently supported only for the dialog task conversations in English.<\/li>\n<li>The scope of this feature currently includes only the replacement of previously populated entities. It does not include other scenarios like partial modifications, deletions, additions to entity values.<\/li>\n<\/ul>\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":"Time and again, we come across situations wherein the users change their preferences during task execution. For example, while booking a flight, the user might change the date of travel and at times even the destination. Amend Entity\u00a0is a feature for such scenarios. Using this feature, you can allow the users to amend entity values...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[47],"tags":[],"class_list":["post-18128","post","type-post","status-publish","format-standard","hentry","category-bot-intelligence"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/posts\/18128","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/comments?post=18128"}],"version-history":[{"count":20,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/posts\/18128\/revisions"}],"predecessor-version":[{"id":30934,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/posts\/18128\/revisions\/30934"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/media?parent=18128"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/categories?post=18128"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/tags?post=18128"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}