-
Notifications
You must be signed in to change notification settings - Fork 367
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updates to bot-tutorial-add-dialog.md
- Loading branch information
1 parent
9ec6d75
commit a9fd7c7
Showing
3 changed files
with
77 additions
and
40 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,81 +1,118 @@ | ||
| # Add a dialog | ||
| --- | ||
| title: The bot framework Composer tutorial adding dialogs to your bot | ||
| description: Learn how to add dialogs to your bot using the bot framework Composer and test it in the Emulator | ||
| keywords: The bot framework Composer, Composer, Tutorial, Emulator, dialog | ||
| author: washingtonKayaker | ||
| ms.author: v-liyan | ||
| manager: kamrani | ||
| ms.topic: article | ||
| ms.service: bot-service | ||
| ms.date: 01/17/2020 | ||
| monikerRange: 'azure-bot-service-4.0' | ||
| --- | ||
|
|
||
| When building features of a bot with Composer, it is sometimes useful to create a new **dialog** to contain a chunk of functionality. This helps keep the dialog system organized, and also allows sub-dialogs to be combined into larger, more complex dialogs. | ||
| # Tutorial: Adding dialogs to your bot | ||
|
|
||
| Each dialog contains one or more triggers that launch associated actions. They can have their own dedicated language model. Dialogs can call other dialogs and can pass values back and forth. | ||
| This tutorial walks you through adding additional dialogs to a basic bot with the Bot Framework Composer and testing it in the Emulator. | ||
|
|
||
| ## What are we building? | ||
| In this tutorial, you learn how to: | ||
|
|
||
| > [!div class="checklist"] | ||
| > * Build on the basic bot created in the previous tutorial using the Bot Framework Composer by adding an additional dialog | ||
| > * Learn how to call external API | ||
| > * Run and interact with your bot locally using the Bot Framework Emulator | ||
| ## Prerequisites | ||
| - The [Bot Framework Composer](../setup-yarn.md) | ||
| - The [Bot Framework Emulator](https://aka.ms/bot-framework-emulator-readme) | ||
| - Completion of the tutorial [Create a new bot and test it in the Emulator](./bot-tutorial-create-bot.md) | ||
| - An understanding of the concepts taught in [the dialog concept article](../concept-dialog.md) | ||
|
|
||
| # Adding dialogs | ||
|
|
||
| It can be useful to organize functionality in [**dialogs**](../concept-dialog.md) when building the features of your bot with Composer. This helps keep things organized and also allows sub-dialogs to be combined together into larger more complex dialogs. | ||
|
|
||
| A dialog contains one or more [Triggers](../concept-events-and-triggers.md) and each trigger consists of one or more actions which are the set of instructions that the bot will execute. Dialogs can also call other dialogs and can pass values back and forth between them. | ||
|
|
||
| ## What are you building? | ||
|
|
||
| The main feature of this bot is reporting on the current weather conditions. | ||
|
|
||
| To do this, we'll create a dialog that | ||
| - prompts the user to enter a zipcode to use as location for weather lookup | ||
| - calls an external API to retrieve the weather data for a specific zipcode. | ||
| To do this, you will create a dialog that | ||
| - Prompts the user to enter a zip code to use as location for weather lookup. | ||
| - Calls an external API to retrieve the weather data for a specific zip code. | ||
|
|
||
| First, we'll set up all the components and make sure they work together. Then, we'll flesh out the functionality. | ||
| > [!TIP] | ||
| > It is recommended that you first create all of the components of your bot and make sure they work together before creating the detailed functionality. | ||
| ## Create a new dialog | ||
| 1. Click the **+ New Dialog** button in the left hand explorer. A dialog will appear and ask for a **Name** and **Description**. | ||
| 1. Go to the Composers _Design_ page by selecting the _Design icon_ from the Menu on the upper left side of the Composer screen. | ||
|
|
||
| 2. Give this new dialog the name: | ||
|
|
||
| `getWeather` | ||
|
|
||
| and the description: | ||
| 2. Select **+ New Dialog** in the Navigation pane. | ||
|
|
||
|  | ||
|
|
||
| 3. The _Define conversation objective_ form will appear and ask for a **Name** and **Description** for the new dialog. | ||
|
|
||
| **Name**: "*getWeather*" | ||
|
|
||
| `Get the current weather conditions` | ||
| **Description**: "*Get the current weather conditions*" | ||
|
|
||
| 4. Select **Next**. Composer will create the new dialog and open it in the editor. | ||
|
|
||
| 3. Click **Next**, and Composer will create the new dialog and open it in the editor. Composer will also create this new dialog with a `BeginDialog` trigger pre-configured. | ||
|  | ||
|
|
||
|  | ||
| > [!NOTE] | ||
| > Composer creates the new dialog with a `BeginDialog` trigger. | ||
| 4. For now, we'll just add a simple message to get things hooked up, then we'll come back to flesh out the feature. With `BeginDialog` trigger selected, click the **+** in the flow and use the same **Send a response** action. Set the text of the activity to: | ||
| 5. For now, just add a simple message to get things hooked up, then come back to flesh out the feature. With the `BeginDialog` trigger selected, select the **+** in the flow, and use the same **Send a response** action. Set the text of the activity to: | ||
|
|
||
| `Let's check the weather` | ||
|
|
||
| You'll have a flow that looks like this: | ||
|
|
||
|  | ||
|
|
||
| ## Wire up dialogs | ||
| You can break pieces of your conversation flow into dialogs and can chain them together. Let's get the newly created `getWeather` dialog wired up to the root dialog. | ||
|  | ||
|
|
||
| 1. Click on `WeatherBot.Main` from the left navigation pane. After selecting `WeatherBot.Main` from the explorer, find the **Language Understanding** section of the properties panel. | ||
| ## Connect your new dialog | ||
| You can break pieces of your conversation flow into different dialogs and can chain them together. Next you need to get the newly created `getWeather` dialog connected to the main dialog. | ||
|
|
||
| > Each dialog can have it's own **recognizer**, a component that lets the bot examine an incoming message and decide what it means by choosing between a set of predefined **intents**. Different types of recognizers use different techniques to determine which intent, if any, to choose. | ||
| 1. Select **WeatherBot.Main** in the _Navigation_ panel. | ||
|
|
||
| > For now, we're going to use the **Regular Expression** recognizer, which uses pattern matching. Later, we'll use more sophisticated natural language understanding technology from **LUIS**. | ||
| 2. find the **Language Understanding** section of the in the _Properties_ panel | ||
|
|
||
| 2. Under the **Recognizer Type**, select `Regular Expression`. | ||
| > Each dialog can have it's own [recognizer](../concept-dialog.md#recognizer), a component that lets the bot examine an incoming message and decide what it means by choosing between a set of predefined [intents](../concept-language-understanding.md#intents). Different types of recognizers use different techniques to determine which intent, if any, to choose. | ||
|  | ||
| > [!NOTE] | ||
| > For now, you're going to use the [Regular Expression Recognizer](../how-to-define-triggers.md#regular-expression-recognizer), which uses pattern matching. Later, you will use more sophisticated natural language understanding technology from [LUIS](../how-to-define-triggers.md#luis-recognizer). | ||
| 3. In the two fields **Intent** and **Pattern**, define the bot's first intent `weather`. Set the value of the **Intent** field to `weather` and set the value of the **Pattern** field to `weather`. | ||
| 3. Select **Regular Expression** from the **Recognizer Type** drop-down list. | ||
|
|
||
|  | ||
| 4. Enter "*weather*" for both **Intent** and **Pattern** | ||
|
|
||
| > This tells the bot to look for the word "weather" anywhere in an incoming message. Regular expression patterns can be much more complicated than this, but for now, this will do! | ||
| > [!NOTE] | ||
| > This tells the bot to look for the word "weather" anywhere in an incoming message. Regular expression patterns are generally much more complicated, but this is adequate for the purposes of this example. | ||
| 4. Click **+ New Trigger** in the left hand side under the `weatherBot.Main` header, and a modal will appear. Select **Intent recognized** from the first dropdown and then select our freshly created `weather` intent from the second dropdown. | ||
| 5. Next, create a new trigger in the **weatherBot.Main** dialog by Selecting "+ New Trigger". | ||
|
|
||
|  | ||
| 6. In the **Create a trigger** form that appears, select _Intent recognized_ as the trigger type, then select "_weather_" from the **Which intent do you want to handle?** drop-down list, then **Submit**. | ||
|
|
||
| 5. Click the **+** in the flow and select the `Dialog management` option. From the submenu, select `Begin a new dialog`. | ||
| 7. Next, create a new action for the _Intent recognized_ trigger you just created. You can do this by selecting the **+** in the _Authoring canvas_, then select **Begin a new dialog** from the **Dialog management** menu. | ||
|
|
||
| 6. In the properties panel for the new action, set the `dialog name` property to our `getWeather` dialog. | ||
| 8. In the _Properties_ panel for the new **Begin a new dialog** action, select _getWeather_ from the **dialog name** drop-down list. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Now when a user enters "_weather_", you bot will respond by activating the _getWeather_ dialog. In the next tutorial you will learn how to prompt the user for additional information, then query a weather service and return the results to the user, but first you need to validate that the functionality developed so far works correctly, you will do this using the Emulator. | ||
|
|
||
| ## Test | ||
| ## Testing your bot. | ||
|
|
||
| 1. Click the **Restart Bot** button in the upper right hand corner of the Composer window. This will update the bot runtime app with all the new content and settings. Then, click **Test in Emulator**. When Emulator connects to your bot, it'll send the greeting we configured in the last section. | ||
| 1. Select the **Restart Bot** button in the upper right hand corner of the Composer window. This will update the bot runtime app with all the new content and settings. Then select **Test in Emulator**. When the Emulator connects to your bot, it'll send the greeting you configured in the last section. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| 2. Send the bot a message that says `weather`. The bot should respond with our test message, confirming that our intent was recognized as expected, and the fulfillment action was triggered. | ||
| 2. Send the bot a message that says `weather`. The bot should respond with your test message, confirming that your intent was recognized as expected, and the fulfillment action was triggered. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## Next steps | ||
| - [Get weather](./bot-tutorial-get-weather.md) |