tutorial-digressions.md

copyright	lastupdated
years 2015, 2019	2019-04-08

{:shortdesc: .shortdesc} {:new_window: target="_blank"} {:tip: .tip} {:deprecated: .deprecated} {:pre: .pre} {:codeblock: .codeblock} {:screen: .screen} {:javascript: .ph data-hd-programlang='javascript'} {:java: .ph data-hd-programlang='java'} {:python: .ph data-hd-programlang='python'} {:swift: .ph data-hd-programlang='swift'}

Tutorial: Understanding digressions

{: #tutorial-digressions}

In this tutorial, you will see firsthand how digressions work. {: shortdesc}

This version of the {{site.data.keyword.conversationshort}} documentation is deprecated. Go here instead. {: deprecated}

Learning objectives

By the time you finish the tutorial, you will understand how:

• digressions are designed to work
• digression settings impact the flow of the dialog
• to test digression settings for a dialog

Duration

This tutorial will take approximately 20 minutes to complete.

Prerequisite

If you do not have a {{site.data.keyword.conversationshort}} instance, complete the Before you begin step from the Getting Started tutorial to create one.

Step 1: Import the Digressions showcase workspace

{: #import-digression-json}

First you will need to import the Digression showcase workspace into your {{site.data.keyword.conversationshort}} instance.

1. Download the digression-showcase.json file.
2. In your {{site.data.keyword.conversationshort}} instance, click the icon.
3. Click Choose a file, and then select the digression-showcase.json file that you downloaded earlier.
4. Click Import to finish importing the workspace.

Step 2: Temporarily digressing away from dialog

{: #temporarily-digress-away}

Digressions allow for the user to break away from a dialog branch in order to temporarily change the topic before returning to the original dialog flow. In this step, you will start to book a restaurant reservation, then digress away to ask for the restaurant's hours. After providing the opening hours information, the service will return back to the restaurant booking dialog flow.

1. Click Dialog to switch from the page with intents to a view of the dialog tree.

2. Click the icon to open the "Try it out" pane.

3. Type Book me a restaurant into the text field.

   The service responds with a prompt for the day to reserve, When do you want to go?

4. Click the Location icon next to the response to highlight the node that triggered the response, the Restaurant booking node, in the dialog tree.

   

5. Type Tomorrow.

   The service responds with a prompt for the time to reserve, What time do you want to go?

6. You do not know when the restaurant closes, so you ask, What time do you close?

   The bot digresses away from the restaurant booking node to process the Restaurant opening hours node. It responds with, The restaurant is open from 8:00 AM to 10:00 PM. The service then returns to the restaurant booking node, and prompts you again for the reservation time.

   

7. Optional: To complete the dialog flow, type 8pm for the reservation time and 2 for the number of guests.

Congratulations! You have successfully digressed away from and returned to a dialog flow.

Step 3: Disabling slot digressions

In this step, you will edit the digression settting for the restaurant booking node to prevent users from digressing away from it, and see how the setting change impacts the dialog flow.

1. Let's look at the current digression settings for the Restaurant booking node. Click the node to open it in edit view.

2. Click Customize, and then click the Digressions tab.

   

3. Change the Allow digressions away toggle from on to off, and then click Apply.

4. Click to close the node edit view.

5. Click Clear in the "Try it out" pane to reset the dialog.

6. Type Book me a restaurant.

   The service responds with a prompt for the day to reserve, When do you want to go?

7. Type Tomorrow.

   The service responds with a prompt for the time to reserve, What time do you want to go?

8. Ask, What time do you close?

   The service recognizes that the question triggers the #restaurant_opening_hours intent, but ignores it and displays the prompt associated with the @sys-time slot again instead.

You successfully prevented the user from digressing away from the restaurant booking process.

Step 4: Digressing to a node that does not return

{: #digress-without-return}

You can configure a dialog node to not go back to the node that the service digressed away from for the current node to be processed. To demonstrate this, you will change the digression setting for the restaurant hours node. In Step 2, you saw that after digressing away from the restaurant booking node to go to the restaurant opening hours node, the service went back to the restaurant booking node to continue with the reservation process. In this exercise, after you change the setting, you will digress away from the Job opportunities dialog to ask about restaurant opening hours and see that the service does not return to where it left off.

1. Click to open the Restaurant opening hours node.

2. Click Customize, and then click the Digressions tab.

3. Expand the Digressions can come into this node section, and deselect the Return after digression checkbox. Click Apply, and then click to close the node edit view.

4. Click Clear in the "Try it out" pane to reset the dialog.

5. To engage the Job opportunities dialog node, type I'm looking for a job.

   The service responds by saying, We are always looking for talented people to add to our team. What type of job are you interested in?

6. Instead of answering this question, ask the bot an unrelated question. Type What time do you open?

   The service digresses away from the Job opportunities node to the Restaurant opening hours node to answer your question. The service responds with The restaurant is open from 8:00 AM to 10:00 PM.

   Unlike in the previous test, this time the dialog does not pick up where it left off in the Job opportunities node. The service does not return to the dialog that was in progress because you changed the setting on the Restaurant opening hours node to not return.

   

Congratulations! You have successfully digressed away from a dialog without returning.

Summary

In this tutorial you experienced how digressions work, and saw how individual dialog node settings can impact the digressions behavior.

Next steps

For help as you configure digressions for your own dialog, see Digressions.