{"id":18128,"date":"2019-02-12T10:34:40","date_gmt":"2019-02-12T10:34:40","guid":{"rendered":"https:\/\/developer.kore.ai\/v7-3\/?post_type=docs&#038;p=16539"},"modified":"2020-07-03T15:04:34","modified_gmt":"2020-07-03T14:04:34","slug":"amend-entity","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v7-3\/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>Notes:<\/p>\n<ul>\n<li>This feature has been introduced in v6.4 release<\/li>\n<li>This feature is not 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>.<\/li>\n<\/ul>\n<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> is 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 can be divided into three stages:<\/p>\n<ul>\n<li><strong>Amend Identification<\/strong>: Identifying that the end user wants to amend is driven by 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 will be prompted for the entity value. For example, user utterance \u201cI want to change the destination\u201d triggers the prompt for 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 will be updated accordingly. For example, user utterance \u201cI want to fly to JFK\u201d changes the destination entity value. If the value is compatible with two or more entities in the dialog, then the user will be 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, user utterance \u201cchange my destination to JFK\u201d will 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<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\">Implementation<\/span><\/h2>\n<p>On the Kore.ai platform, Amend Entity behavior can be defined at two levels:<\/p>\n<ul>\n<li>Bot level, and<\/li>\n<li>Task level.<\/li>\n<\/ul>\n<h3><span class=\"ez-toc-section\" id=\"Bot_Level\">Bot Level<\/span><\/h3>\n<p><strong>To Set Bot Level Amend Entity Behavior<\/strong><\/p>\n<ol>\n<li>From <strong>Natural Language -&gt; Intelligence<\/strong> option select <strong>Amend Entity.\u00a0<\/strong>By default amend entities is disabled.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/15\/amend-entity.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-16578 size-full\" src=\"\/wp-content\/uploads\/sites\/15\/amend-entity.png\" alt=\"\" width=\"820\" height=\"461\" \/><\/a><\/li>\n<li>Once you <strong>Allow amend entities<\/strong>, various Dialog Resumption options are available:\n<ul>\n<li><strong>Re-execute dialog from amended entity<\/strong> &#8211; 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> &#8211; to clear all entities captured between the identified entity and the amend<\/li>\n<li><em>Skip display of previously displayed messages<\/em> &#8211; messages from Message nodes alone.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Resume dialog from amend identification node<\/strong> &#8211; <span style=\"font-weight: 400\">use this option to resume the dialog from the node where the amend was identified.<\/span><\/li>\n<\/ul>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/15\/amend-entity-options.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16579\" src=\"\/wp-content\/uploads\/sites\/15\/amend-entity-options.png\" alt=\"\" width=\"820\" height=\"461\" \/><\/a><\/li>\n<\/ol>\n<h4><\/h4>\n<h3><span class=\"ez-toc-section\" id=\"Task_Level\">Task Level<\/span><\/h3>\n<p><strong>To set Task Level Amend Entity Behavior<\/strong><\/p>\n<p>Amend entity behavior can be set at the Task level also. The configurations defined at the task level will override the bot level configurations.<\/p>\n<ol>\n<li>From the Dialog Task page, click the\u00a0<strong>Ellipses\u00a0<\/strong><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/15\/DIYDialogTaskEllipsesIcon.png\"><img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-10353\" src=\"\/wp-content\/uploads\/sites\/15\/DIYDialogTaskEllipsesIcon.png\" alt=\"\" width=\"8\" height=\"25\" \/><\/a>\u00a0icon and select the\u00a0<strong>Manage Amend Behaviour<\/strong>.<\/li>\n<li>This opens the\u00a0<strong>Manage Amend Behaviour<\/strong> dialog.<\/li>\n<li>By default,\u00a0<strong>Use bot level settings<\/strong> is selected and the Bot level setting is displayed<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/15\/amend-entity-task.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16580\" src=\"\/wp-content\/uploads\/sites\/15\/amend-entity-task.png\" alt=\"\" width=\"650\" height=\"296\" \/><\/a><\/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> will not allow the user to amend entity values for this task,<\/li>\n<li><strong>Allow amend entities<\/strong> will further give you three Dialog Resumption options:\n<ul>\n<li><strong>Re-execute dialog from amended entity<\/strong> &#8211; <span style=\"font-weight: 400\">Amend entity behavior can be set at the Task level also. The configurations defined at the task level will override the bot level configurations.<\/span>\n<ul>\n<li><i><span style=\"font-weight: 400\">Clear entity values captured downstream<\/span><\/i><span style=\"font-weight: 400\"> &#8211; to clear all entities captured between the identified entity and the amend<\/span><\/li>\n<li><i><span style=\"font-weight: 400\">Skip display of previously displayed messages<\/span><\/i><span style=\"font-weight: 400\"> &#8211; messages from Message nodes alone.<\/span><\/li>\n<\/ul>\n<\/li>\n<li><strong>Resume dialog from amend identification node<\/strong> &#8211; <span style=\"font-weight: 400\">use this option to resume the dialog from the node where the amend was identified.<\/span><\/li>\n<li><strong>Jump to a specific node in the dialog<\/strong> &#8211; <span style=\"font-weight: 400\">use 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 <\/span><\/li>\n<\/ul>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/15\/amend-entity-task-options.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16973\" src=\"\/wp-content\/uploads\/sites\/15\/amend-entity-task-options.png\" alt=\"\" width=\"645\" height=\"471\" \/><\/a><\/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<h2><span class=\"ez-toc-section\" id=\"Additional_Notes\">Additional Notes<\/span><\/h2>\n<ul>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Amend functionality is not applicable for universal bot\u2019s default language. However, when a linked bot is in progress, amend settings of the linked bot will be honored.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Identification of the amend requests is driven by the platform&#8217;s in-built training data and it is currently supported only for the Dialog task conversations in English. <\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">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.<\/span><\/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":"Notes: This feature has been introduced in v6.4 release This feature is not supported in all languages, see here for details. 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...","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\/v7-3\/wp-json\/wp\/v2\/posts\/18128","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=18128"}],"version-history":[{"count":9,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/posts\/18128\/revisions"}],"predecessor-version":[{"id":23632,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/posts\/18128\/revisions\/23632"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/media?parent=18128"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/categories?post=18128"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-3\/wp-json\/wp\/v2\/tags?post=18128"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}