{"id":18128,"date":"2019-02-12T10:34:40","date_gmt":"2019-02-12T10:34:40","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&#038;p=16539"},"modified":"2022-10-03T18:21:13","modified_gmt":"2022-10-03T17:21:13","slug":"amend-entity","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-intelligence\/amend-entity\/","title":{"rendered":"Amend Entity"},"content":{"rendered":"<p><span style=\"font-weight: 400\">Time and again, we come across situations wherein the users change their preferences during task execution.<\/span><\/p>\n<p><em><span style=\"font-weight: 400\">For example<\/span><\/em><span style=\"font-weight: 400\">, while booking a flight, the user might change the date of travel and at times even the destination.<\/span><\/p>\n<p><strong>Amend Entity<\/strong><span style=\"font-weight: 400\"> 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.<\/span><\/p>\n<p><span style=\"font-weight: 400\">The entity amendment process is divided into three stages:<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400\"><strong>Amend Identification<\/strong><span style=\"font-weight: 400\">: Identifying that the end-user wants to amend is driven by the VA\u2019s built-in NLP capabilities.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Amending Entities<\/strong><span style=\"font-weight: 400\">: 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:<\/span><\/li>\n<ul>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">When the user refers to the entity name (or entity synonyms), then they are prompted for the entity value. For example, the user utterance <\/span><em><span style=\"font-weight: 400\">I want to change the destination<\/span><\/em><span style=\"font-weight: 400\"> 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.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">When the user gives the entity value then the entity is updated accordingly. For example, the user utterance <\/span><em><span style=\"font-weight: 400\">I want to fly to JFK<\/span><\/em><span style=\"font-weight: 400\"> 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.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">When the user refers to both the entity and its value, then the entity is updated. For example, the user utterance <\/span><em><span style=\"font-weight: 400\">change my destination to JFK<\/span><\/em><span style=\"font-weight: 400\"> will change the destination entity value.<\/span><\/li>\n<\/ul>\n<li style=\"font-weight: 400\"><strong>Post Amendment Behavior<\/strong><span style=\"font-weight: 400\">: After an entity is successfully amended, there are three possible dialog execution flows that your VA can be configured for:<\/span><\/li>\n<ul>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">The dialog can be re-executed from the node that is amended by evaluating that entity\u2019s connections.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">The dialog can resume from the node where amend was identified or made.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">The dialog can be resumed from a specified node present in the dialog.<\/span><\/li>\n<\/ul>\n<\/ul>\n<table style=\"width: 100%;border-collapse: collapse;background-color: #fffbea\">\n<tbody>\n<tr>\n<td style=\"width: 100%\"><strong>Note<\/strong>: <em><span>This feature is not supported in all languages, <\/span><\/em><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/how-tos\/multi-lingual-bot-behavior\/#Feature_Support\"><em><span>Click here for details<\/span><\/em><\/a><em><span>.<\/span><\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\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>\n<h1><span class=\"ez-toc-section\" id=\"Implementation_Hierarchy\"><span style=\"font-weight: 400\">Implementation Hierarchy<\/span><\/span><\/h1>\n<p><span style=\"font-weight: 400\">On the Kore.ai XO Platform, Amend Entity behavior is defined at two levels:<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">VA level<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Task level<\/span><\/li>\n<\/ul>\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>\n<h2><span class=\"ez-toc-section\" id=\"Bot_Level\"><span style=\"font-weight: 400\">Bot Level<\/span><\/span><\/h2>\n<p><span style=\"font-weight: 400\">To Set VA Level Amend Entity Behavior, follow the below steps:<\/span><\/p>\n<ol>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Select the <\/span><strong>Build<\/strong><span style=\"font-weight: 400\"> tab from the top menu<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">From the left menu, click <\/span><strong>Intelligence<\/strong><span style=\"font-weight: 400\"> -&gt; <\/span><strong>Amend Entity.\u00a0<\/strong><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">By default, this option s disabled.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Once you <\/span><strong>Allow amend entities<\/strong><span style=\"font-weight: 400\">, various Dialog Resumption options are available:<\/span><\/li>\n<ol>\n<li style=\"font-weight: 400\"><strong>Re-execute dialog from amended entity<\/strong><span style=\"font-weight: 400\"> \u2013 use this option to resume the dialog by evaluating the amended entity\u2019s connections. You can further choose to:<\/span><\/li>\n<ul>\n<li style=\"font-weight: 400\"><em><span style=\"font-weight: 400\">Clear entity values captured downstream<\/span><\/em><span style=\"font-weight: 400\"> \u2013 to clear all entities captured between the identified entity and the amend<\/span><\/li>\n<li style=\"font-weight: 400\"><em><span style=\"font-weight: 400\">Skip display of previously displayed messages<\/span><\/em><span style=\"font-weight: 400\"> \u2013 messages from Message nodes alone.<\/span><\/li>\n<\/ul>\n<li style=\"font-weight: 400\"><strong>Resume dialog from amend identification node<\/strong><span style=\"font-weight: 400\"> \u2013 use this option to resume the dialog from the node where the amend was identified.<\/span><\/li>\n<\/ol>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">The amend process can be extended to entities marked as <\/span><em><span style=\"font-weight: 400\">Hidden<\/span><\/em><span style=\"font-weight: 400\"> using the <\/span><strong>Amend Hidden Entities <\/strong><span style=\"font-weight: 400\">option.<\/span><\/li>\n<\/ol>\n<p><span style=\"font-weight: 400\"><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174640\/amend-entity-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-47520\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174640\/amend-entity-1-1024x434.png\" alt=\"\" width=\"640\" height=\"271\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174640\/amend-entity-1-1024x434.png 1024w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174640\/amend-entity-1-300x127.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174640\/amend-entity-1.png 1922w\" sizes=\"auto, (max-width: 640px) 100vw, 640px\" \/><\/a><\/span><\/p>\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>\n<h2><span class=\"ez-toc-section\" id=\"Task_Level\"><span style=\"font-weight: 400\">Task Level<\/span><\/span><\/h2>\n<p><span style=\"font-weight: 400\">Amend entity behavior is set at the Task level also. The configurations defined at the task level will override the VA-level configurations.<\/span><\/p>\n<p><span style=\"font-weight: 400\">To set Task Level Amend Entity Behavior, follow the below steps:<\/span><\/p>\n<ol>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Go to <\/span><strong>Build &gt; Conversation Skills &gt; Dialog Tasks<\/strong><span style=\"font-weight: 400\"> and select the task that you want to configure.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">On the Dialog Task page, click the <\/span><strong>More Options <\/strong><span style=\"font-weight: 400\">icon and select the <\/span><strong>Manage Amend Behavior<\/strong><span style=\"font-weight: 400\">.<br \/><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174651\/task-settings.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-47527\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174651\/task-settings-1024x462.png\" alt=\"\" width=\"640\" height=\"289\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174651\/task-settings-1024x462.png 1024w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174651\/task-settings-300x135.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174651\/task-settings.png 1922w\" sizes=\"auto, (max-width: 640px) 100vw, 640px\" \/><\/a><\/span><span style=\"font-weight: 400\"><br \/><\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">On the <\/span><strong>Manage Amend Behaviour<\/strong><span style=\"font-weight: 400\"> dialog box, by default, the <\/span><strong>Use bot level settings<\/strong><span style=\"font-weight: 400\"> option is selected and the bot level setting is displayed.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Select <\/span><strong>Customize for this task<\/strong><span style=\"font-weight: 400\"> to override the bot level settings:<\/span>\n<ol>\n<li style=\"font-weight: 400\"><strong>Do not allow amend entities<\/strong><span style=\"font-weight: 400\"> \u2013 It will not allow the user to amend entity values for this task.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Allow amend entities<\/strong><span style=\"font-weight: 400\"> \u2013 It will further give you three Dialog Resumption options:<\/span>\n<ul>\n<li style=\"font-weight: 400\"><strong>Re-execute dialog from amended entity<\/strong><span style=\"font-weight: 400\"> \u2013 Amend entity behavior is set at the task level also. The configurations defined at the task level will override the bot-level configurations.<\/span>\n<ul>\n<li style=\"font-weight: 400\"><em><span style=\"font-weight: 400\">Clear entity values captured downstream<\/span><\/em><span style=\"font-weight: 400\"> \u2013 to clear all entities captured between the identified entity and the amend<\/span><\/li>\n<li style=\"font-weight: 400\"><em><span style=\"font-weight: 400\">Skip display of previously displayed messages<\/span><\/em><span style=\"font-weight: 400\"> \u2013 messages from Message nodes alone.<\/span><\/li>\n<\/ul>\n<\/li>\n<li style=\"font-weight: 400\"><strong>Resume dialog from amend identification node<\/strong><span style=\"font-weight: 400\"> \u2013 use this option to resume the dialog from the node where the amend was identified.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Jump to a specific node in the dialog<\/strong><span style=\"font-weight: 400\"> \u2013 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. The 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<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">The amend process can be extended to hidden entities using the <\/span><strong>Amend Hidden Entities <\/strong><span style=\"font-weight: 400\">option.<\/span><\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<p><span style=\"font-weight: 400\"><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174645\/task-amend-entity-options.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-47524\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174645\/task-amend-entity-options.png\" alt=\"\" width=\"640\" height=\"666\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174645\/task-amend-entity-options.png 777w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003174645\/task-amend-entity-options-288x300.png 288w\" sizes=\"auto, (max-width: 640px) 100vw, 640px\" \/><\/a><\/span><\/p>\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>\n<h1><span class=\"ez-toc-section\" id=\"Triggers\"><span style=\"font-weight: 400\">Triggers<\/span><\/span><\/h1>\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 \/>For 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 \/>For 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 \/>For 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 \/>For 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 \/>For 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 \/>For 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 \/>For 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 \/>For 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 \/>For example, &#8220;<em>change it from today to tomorrow<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms &lt;entity_name&gt;<\/code><br \/>For example, &#8220;<em>amend departure date<\/em>&#8220;.<\/li>\n<li><code>~amend_synonyms &lt;old_value&gt;<\/code><br \/>For 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 \/>For example, &#8220;<em>to tomorrow instead of today<\/em>&#8220;<\/li>\n<li><code>[to as from] &lt;new_value&gt; instead<\/code><br \/>For 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<table style=\"width: 100%;border-collapse: collapse;background-color: #fffbea\">\n<tbody>\n<tr>\n<td style=\"width: 100%\"><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.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\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>\n<table style=\"width: 100%;border-collapse: collapse;background-color: #fffbea\">\n<tbody>\n<tr>\n<td style=\"width: 100%\">\n<h2><span class=\"ez-toc-section\" id=\"Additional_Notes\"><span style=\"font-weight: 400\">Additional Notes<\/span><\/span><\/h2>\n<ul>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">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.<\/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<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\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>\n","protected":false},"excerpt":{"rendered":"<p>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 is a feature for such scenarios. Using this feature, you can allow the users to amend entity&#8230;<\/p>\n","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\/v10-1\/wp-json\/wp\/v2\/posts\/18128","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=18128"}],"version-history":[{"count":22,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18128\/revisions"}],"predecessor-version":[{"id":47523,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18128\/revisions\/47523"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18128"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18128"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18128"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}