Skip to content

Latest commit

 

History

History
 
 

10.prompt-validations

README.md

prompt validation

Bot Framework v4 prompt validation bot sample

A conversation between a bot and a user often involves asking (prompting) the user for information. This sample shows how to use the prompt classes included in botbuilder-dialogs. This bot will ask for multiple pieces of information from the user, each using a different type of prompt, each with its own validation rules. This sample also demonstrates using the ComponentDialog class to encapsulate related sub-dialogs.

Prerequisites

  • [Node.js][4] version 8.5 or higher
# determine node version
node --version

To try this sample

  • Clone the repository 
    git clone https://github.com/microsoft/botbuilder-samples.git
  • In a terminal, navigate to samples/javascript_nodejs/10.prompt-validations 
    cd samples/javascript_nodejs/10.prompt-validations
  • Install modules 
    npm install
  • Start the bot 
    npm start

Testing the bot using Bot Framework Emulator v4

Microsoft Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.

  • Install the Bot Framework emulator from here

Connect to bot using Bot Framework Emulator v4

  • Launch Bot Framework Emulator
  • File -> Open Bot Configuration and navigate to javascript_nodejs/10.prompt-validations
  • Select prompt-validations.bot file

Deploy this bot to Azure

You can use the MSBot Bot Builder CLI tool to clone and configure any services this sample depends on. In order to install this and other tools, you can read Installing CLI Tools.

To clone this bot, run

msbot clone services -f deploymentScripts/msbotClone -n <BOT-NAME> -l <Azure-location> --subscriptionId <Azure-subscription-id> --appId <YOUR APP ID> --appSecret <YOUR APP SECRET PASSWORD>

NOTE: You can obtain your appId and appSecret at the Microsoft's Application Registration Portal

Prompts

A conversation between a bot and a user often involves asking (prompting) the user for information, parsing the user's response, and then acting on that information. This sample demonstrates how to prompt users for information and validate the incoming responses using the different prompt types included in the botbuilder-dialogs library.

The botbuilder-dialogs library includes a variety of pre-built prompt classes, including text, number, and datetime types. In this sample, each prompt is wrapped in a custom class that includes a validation function. These prompts are chained together into a WaterfallDialog, and the final results are stored using the state manager.

Further reading