{"id":30824,"date":"2020-11-18T04:24:19","date_gmt":"2020-11-18T04:24:19","guid":{"rendered":"https:\/\/multisite.korebots.com\/?p=25389"},"modified":"2024-03-27T08:07:31","modified_gmt":"2024-03-27T08:07:31","slug":"system-commands-2","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-builder-tool\/system-commands-2\/","title":{"rendered":"System Commands"},"content":{"rendered":"<p><span style=\"font-weight: 400;\">Conversation sessions are defined as an uninterrupted interaction between the assistant and the user. These sessions are used in multiple analytics dashboards in the XO Platform as well as the Admin Console.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">The Kore.ai XO Platform allows you to customize how these Conversation Sessions are to be created and closed.<\/span><\/p>\n<table style=\"width: 100%; border-collapse: collapse; background-color: #fffbea; height: 36px;\">\n<tbody>\n<tr style=\"height: 36px;\">\n<td style=\"width: 100%; height: 36px;\"><strong><em>Note<\/em><\/strong><em><span style=\"font-weight: 400;\">: Conversation Sessions are different from Billing Sessions, <\/span><\/em><a href=\"https:\/\/multisite.korebots.com\/docs\/bots\/bot-admin-bots-bots\/billing\/\"><em><span style=\"font-weight: 400;\">refer here<\/span><\/em><\/a><em><span style=\"font-weight: 400;\"> for more on Billing Sessions.<\/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=\"Overview\"><span style=\"font-weight: 400;\">Overview<\/span><\/span><\/h1>\n<p><span style=\"font-weight: 400;\">A Conversation Session is defined as an uninterrupted volley between the end-user and the assistant.<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Before the release of v7.2 of the Platform \u2013 a new session was created after the <\/span><em><span style=\"font-weight: 400;\">inactivity duration (set as 15 mins)<\/span><\/em><span style=\"font-weight: 400;\"> has elapsed since the end-users\u2019 last interaction.<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Post v7.2 \u2013 after the <\/span><em><span style=\"font-weight: 400;\">inactivity duration (set as 15 mins)<\/span><\/em><span style=\"font-weight: 400;\"> has elapsed<\/span>\n<ul>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">if the end-user comes back and continues with the same intent, then the current session continues;<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">if the end-user comes back with a new intent or with an invalid input for the existing intent, a new session is created.<\/span><\/li>\n<\/ul>\n<\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Post v8.0 Platform provides options to:<\/span>\n<ul>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Proactively close the sessions after inactivity \u2013 for details on Manage Sessions <\/span><a href=\"https:\/\/multisite.korebots.com\/docs\/bots\/bot-settings\/bot-sessions\/#Manage_Sessions\"><span style=\"font-weight: 400;\">refer here<\/span><\/a><span style=\"font-weight: 400;\">.<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Not proactively close the sessions after inactivity \u2013 retain the v7.2 behavior described above;<\/span><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><span style=\"font-weight: 400;\">Conversation Sessions are created for all interactions with the virtual assistant. These include:<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">All conversations that include one or more messages from the user marked as <\/span><strong>interactive sessions<\/strong><span style=\"font-weight: 400;\">. These include all end-user interactions across all channels and events including providing authorization details.<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">All conversion sessions initiated by the VA, such as onConnect event messages are recorded as <\/span><strong>non-interactive sessions. <\/strong><span style=\"font-weight: 400;\">These sessions will be updated as Interactive sessions as soon as a user message is received. Non-interactive sessions are not considered for calculating the billing sessions.<\/span><\/li>\n<li style=\"font-weight: 400;\"><strong>Developer interactions<\/strong><span style=\"font-weight: 400;\"> are also included as conversation sessions. A flag differentiates the user sessions from developer sessions and billing sessions are not created for these developer sessions.<\/span><\/li>\n<\/ul>\n<table style=\"width: 100%; border-collapse: collapse; background-color: #fffbea; height: 36px;\">\n<tbody>\n<tr style=\"height: 36px;\">\n<td style=\"width: 100%; height: 36px;\"><strong><em><span style=\"font-weight: 400;\"><strong>Note<\/strong>: inclusion of non-interactive and developer interactions in conversation sessions was done with ver8.0.<\/span><\/em><\/strong><\/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=\"Manage_Sessions\"><span style=\"font-weight: 400;\">Manage Sessions<\/span><\/span><\/h1>\n<p><span style=\"font-weight: 400;\">This feature was released with v8.0 of the Platform. You can manage session behavior by selecting your assistant then going to <\/span><strong>Build &gt; Configurations &gt; Manage Sessions<\/strong><span style=\"font-weight: 400;\">.<\/span><\/p>\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\/20221003090631\/manage-sessions.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-47177\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003090631\/manage-sessions-1024x450.png\" alt=\"\" width=\"640\" height=\"281\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003090631\/manage-sessions-1024x450.png 1024w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003090631\/manage-sessions-300x132.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221003090631\/manage-sessions.png 1949w\" sizes=\"auto, (max-width: 640px) 100vw, 640px\" \/><\/a><\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\"><strong>Do not proactively close the sessions after inactivity<\/strong><span style=\"font-weight: 400;\"> \u2013 this option will close the session only when the user returns after 15 minutes of inactivity and provides a new intent. This was the default behavior before the release of ver8.0 of the Platform. This option will be deprecated in future releases.<\/span><\/li>\n<li style=\"font-weight: 400;\"><strong>Proactively close the sessions after inactivity<\/strong><span style=\"font-weight: 400;\"> \u2013 this option will close the session after a defined duration of inactivity. You can set the following parameters:<\/span>\n<ul>\n<li style=\"font-weight: 400;\"><strong>Inactivity Duration<\/strong><span style=\"font-weight: 400;\"> \u2013 this is set to 15 minutes by default and decides when the session should close. You can set it to any value between 5-60 minutes.<\/span><\/li>\n<li style=\"font-weight: 400;\"><strong>Pre-closure Behavior<\/strong><span style=\"font-weight: 400;\"> \u2013 you can choose to close the session without informing the user or inform the user about the session closure by sending out a message. This message can be customized using the <\/span><strong>Manage response<\/strong><span style=\"font-weight: 400;\"> link.<\/span><\/li>\n<\/ul>\n<\/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<h1><span class=\"ez-toc-section\" id=\"Implementation\"><span style=\"font-weight: 400;\">Implementation<\/span><\/span><\/h1>\n<h2><span class=\"ez-toc-section\" id=\"When_does_a_Conversation_Session_start\"><span style=\"font-weight: 400;\">When does a Conversation Session start?<\/span><\/span><\/h2>\n<p><span style=\"font-weight: 400;\">Conversation Sessions will be created for all interactions:<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">All <\/span><strong>end-user interactions<\/strong><span style=\"font-weight: 400;\"> across all channels and events \u2013 Conversation sessions will be created for On_connect \u2013 Run a script, Run a Message, Trigger a Dialog scenario. There are two categories of these conversation sessions:<\/span>\n<ul>\n<li style=\"font-weight: 400;\"><strong>Interactive sessions<\/strong><span style=\"font-weight: 400;\"> are conversations that include one or more messages from the user.<\/span><\/li>\n<li style=\"font-weight: 400;\"><strong>Non-interactive sessions <\/strong><span style=\"font-weight: 400;\">are conversations with no messages from the user. All conversion sessions initiated by the VA will start as \u2018Non-interactive\u2019. These sessions will be updated as Interactive sessions as soon as a user message is received. The non-interactive sessions will not be considered for calculating the billing sessions.<\/span><\/li>\n<\/ul>\n<\/li>\n<li style=\"font-weight: 400;\"><strong>Developer interactions<\/strong><span style=\"font-weight: 400;\"> will also be considered for creating conversation sessions but these will be marked as different from the user sessions and will not be considered for Billing Sessions.<\/span><\/li>\n<\/ul>\n<h2><span class=\"ez-toc-section\" id=\"When_does_a_Conversation_Session_close\"><span style=\"font-weight: 400;\">When does a Conversation Session close?<\/span><\/span><\/h2>\n<ul>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">The Platform will proactively close inactive sessions after the specified time of inactivity as set in the Manage Sessions option described above.<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">When the chat window is refreshed ie <\/span><em><span style=\"font-weight: 400;\">\u201crefresh: true\u201d <\/span><\/em><span style=\"font-weight: 400;\">is detected.<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">When you run the koreUtil.closeConversationSession Platform function for closing any active conversation. For more information, <\/span><a href=\"https:\/\/multisite.korebots.com\/docs\/bots\/advanced-topics\/koreutil-libraries\/\"><span style=\"font-weight: 400;\">refer here<\/span><\/a><span style=\"font-weight: 400;\">.<\/span><\/li>\n<\/ul>\n<table style=\"width: 100%; border-collapse: collapse; background-color: #fffbea; height: 36px;\">\n<tbody>\n<tr style=\"height: 36px;\">\n<td style=\"width: 100%; height: 36px;\"><strong><em>Note<\/em><\/strong><em><span style=\"font-weight: 400;\">: <\/span><span style=\"font-weight: 400;\"><b>Discard<\/b> and\u00a0<strong>Discard all<\/strong> commands only stop the ongoing chat and do not end the Conversation Session.<\/span><\/em><\/p>\n<p><em>For <strong>discard all:<\/strong><\/em><\/p>\n<ul>\n<li><em>The Dialog context, Current and Historic Tags are cleared;<\/em><\/li>\n<li><em>The Sentiment Tones are reset<\/em><\/li>\n<\/ul>\n<p><em>For <strong>discard:<\/strong><\/em><\/p>\n<ul>\n<li><em>The current Dialog context will be cleared;<\/em><\/li>\n<li><em>The Current Tags will be replaced with the last updated \u2018tags\u2019 in the Historic Tags, and the Historic Tags would be cleared<\/em><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2><span class=\"ez-toc-section\" id=\"What_happens_when_a_Conversation_Session_closes\"><span style=\"font-weight: 400;\">What happens when a Conversation Session closes?<\/span><\/span><\/h2>\n<ul>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Post-session closure, the following information or variables will be cleared:<\/span>\n<ul>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Conversation session;<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Bot User Session (developer-defined variables without custom TTL)<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Dialog Context (Topic File and Conversation Details)<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">If configured, before closing the conversation session, the Platform will proactively send a session closure message to the users on supported channels.<\/span><\/li>\n<\/ul>\n<\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">For \u201c<\/span><em><span style=\"font-weight: 400;\">refresh: true<\/span><\/em><span style=\"font-weight: 400;\">\u201d:<\/span>\n<ul>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Complete session information is cleared;<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">A new conversation session is created.<\/span><\/li>\n<\/ul>\n<\/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","protected":false},"excerpt":{"rendered":"<p>Conversation sessions are defined as an uninterrupted interaction between the assistant and the user. These sessions are used in multiple analytics dashboards in the XO Platform as well as the Admin Console. The Kore.ai XO Platform allows you to customize how these Conversation Sessions are to be created and closed. Note: Conversation Sessions are different&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[19],"tags":[],"class_list":["post-30824","post","type-post","status-publish","format-standard","hentry","category-bot-builder-tool"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/30824","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=30824"}],"version-history":[{"count":8,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/30824\/revisions"}],"predecessor-version":[{"id":61564,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/30824\/revisions\/61564"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=30824"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=30824"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=30824"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}