Le café étant une boisson très importante pour tout développeur, dans ce mini-hack vous utiliserez Bot Framework pour coder un bot permettant de commander un café.
Le but est de jouer avec Bot Framework et d’utiliser rapidement Azure pour déployer votre bot sur le cloud et l’invoquer dans des applications tierces.
Le tutoriel ci-dessous vous guidera pour construire un bot simple et le déployer, n’hésitez pas à laisser libre cours à votre imagination pour l’enrichir !
Pour ce challenge vous aurez besoin de :
- Visual Studio 2015 à jour
- Microsoft Bot Framework Channel Emulator, téléchargeable ici : https://download.botframework.com/bf-v3/tools/emulator/publish.htm
- Microsoft Azure SDK à jour
Pour bien commencer, il faut s'assurer que la solution de départ se lance correctement dans votre environnement. Pour cela :
-
Ouvrez la solution MiniHack.BotApplication.sln
-
Exécutez le projet
-
Une page de votre navigateur internet s’ouvre, notez le port indiqué dans l’url :
-
Pour interagir avec le bot nous avons besoin d'un émulateur. Lancez Microsoft Bot Framework Channel Emulator (si vous ne l’avez pas installé, téléchargez le ici et installez le)
-
Dans le champs « Bot Url » reportez le port que vous avez noté à l’étape 3
-
Ne modifiez pas les autres champs
-
Dans la zone de texte située en bas de l’émulateur, tapez hello
-
Votre hello s’affiche dans la zone chat
-
Le bot répond en vous souhaitant la bienvenue et demande votre nom
-
Saisissez votre nom. Le bot affiche le message Processed your order ! :
Nous allons compléter le code pour construire le scénario souhaité.
Notre objectif va être de coder un bot permettant de prendre votre commande de café, avec des étapes similaires à celles d’une célèbre enseigne de vente de café à emporter.
Ajoutons le nécessaire pour étendre les fonctionnalités de ce bot au scénario ci-dessous :
- Spécifier le type de boisson à commander : café, chocolat, mocha, etc.
- Spécifier si la boisson doit être chaude ou froide
- Indiquer la taille de la boisson
- Préciser si la boisson doit être sucrée
- Lister les suppléments désirés : crème, lait, chocolat, caramel, etc.
- Indiquer le montant de la commande
- Récapituler la commande et demander si tout est correct
- Demander le nom de l’utilisateur
- Demander l’adresse de l’utilisateur
- Demander l’horaire de livraison souhaité
- Demander à l'utilisateur d'évaluer le service
- Remercier l'utilisateur pour sa commande
L'ensemble de nos modifications vont être faites dans le fichier CoffeeBot.cs, ouvrez ce fichier. Notez la présence de la classe CoffeeOrder.
Vous remarquez :
- la présence de la propriété :
public string Name { get; set; }- la génération du formulaire :
var builder = new FormBuilder<CoffeeOrder>()
.Message(DynamicCoffee.Welcome)
.AddRemainingFields();Ce qu'il faut comprendre :
- chaque question posée par le bot va être définie par une propriété similaire à la propriété Name
- dans le cas d'une question à choix multiple, les choix proposés à l'utilisateur sont définis par une enum
- la "boucle" du formulaire est tout simplement définie de manière chainée
Passons à l'action !
Dans le fichier CoffeeBot.cs (en dehors de la classe CoffeeOrder) :
- Ajouter une enum pour le type de café :
public enum CoffeeOptions
{
Coffee, CaramelMacchiato, Mocha
};- Ajouter une enum pour définir la température :
public enum TemperatureOptions
{
Hot, Cold
};- Ajouter une enum pour spécifier la taile de votre boisson :
public enum SizeOptions
{
Ristretto, Short, Medium, Long, Big
};- Ajouter une enum pour connaitre la quantité de sucre souhaitée :
public enum SugarOptions
{
ALittleBitOfSugar, ALot
};- Ajouter une enum pour proposer des suppléments :
public enum ToppingOptions
{
[Terms("except", "but", "not", "no", "all", "everything")]
Cream=1, Milk, Vanilla, Chocolate, Caramel, Everything
};Vous aurez probablement noté que nous faisons commencer les valeurs de cette enum à 1 avec Cream=1 car cette la propriété associée sera optionnelle. La valeur 0 sera donc réservée pour gérer l'absence de réponse.
Ajoutons maintenant les propriétés nécessaires !
Toujours dans le fichier CoffeeBot.cs (dans la classe CoffeeOrder) :
- Ajouter une propriété pour le type de café :
[Prompt("What kind of {&} would you like? {||}")]
public CoffeeOptions? Coffee;- Ajouter une propriété pour définir la température :
[Prompt("Which temperature do you want? {||}")]
public TemperatureOptions? Temperature;- Ajouter une propriété pour spécifier la taile de votre boisson :
[Prompt("What size do you want? {||}")]
public SizeOptions? Size;- Ajouter une propriété pour connaitre la quantité de sucre souhaitée :
[Optional]
[Prompt("Do you want some sugar ? {||}")]
[Template(TemplateUsage.NoPreference, "None")]
public SugarOptions? Sugar { get; set; }- Ajouter une propriété pour proposer des suppléments :
[Optional]
[Prompt("Choose your toppings ? {||}")]
[Template(TemplateUsage.NoPreference, "None")]
public List<ToppingOptions> Toppings { get; set; }- Ajouter une propriété pour connaitre l'adresse de livraison :
public string DeliveryAddress;- Ajouter une propriété pour demander le numéro de téléphone :
[Pattern(@"(\(\d{3}\))?\s*\d{3}(-|\s*)\d{4}")]
public string PhoneNumber;- Ajouter une propriété pour spécifier l'heure de livraison souhaitée :
[Optional]
[Template(TemplateUsage.StatusFormat, "{&}: {:t}", FieldCase = CaseNormalization.None)]
public DateTime? DeliveryTime;- Ajouter une propriété pour que l'utilisateur puisse évaluer le service :
[Numeric(1, 5)]
[Optional]
[Describe("your experience today")]
public double? Rating;Ce qu'il faut retenir :
- l'attribut Prompt définit la phrase qui sera utilisée par le bot pour questionner l'utilisateur
- l'attribut Optional permet de rendre une question facultative et de donner la possibilité à l'utilisateur de ne pas répondre
- l'attribut Pattern définit le format de la réponse attendu
- l'attribut Template permet de spécifier le template à utiliser pour une propriété
Modifions maintenant le formulaire pour aboutir à notre scénario !
Dans la méthode BuildForm de la classe CoffeeOrder, après la ligne .Message(DynamicCoffee.Welcome) :
- Demander le type de boisson à commander :
.Field(nameof(Coffee))- Demander si la boisson doit être chaude ou froide :
.Field(nameof(Temperature))- Indiquer la taille de la boisson
.Field(nameof(Size))- Préciser si la boisson doit être sucrée :
.Field(nameof(Sugar)) - Proposer des suppléments :
.Field(nameof(Toppings),
validate: async (state, value) =>
{
if (value != null)
{
var values = ((List<object>)value).OfType<ToppingOptions>();
var result = new ValidateResult { IsValid = true, Value = values };
if (values != null && values.Contains(ToppingOptions.Everything))
{
result.Value = (from ToppingOptions topping in Enum.GetValues(typeof(ToppingOptions))
where topping != ToppingOptions.Everything && !values.Contains(topping)
select topping).ToList();
}
return result;
}
else
{
// To handle null value when choosing none in toppings
var result = new ValidateResult { IsValid = true, Value = null };
return result;
}
})- Indiquer le montant de la commande
.Confirm(async (state) =>
{
var cost = 0.0;
switch (state.Size)
{
case SizeOptions.Ristretto: cost = 2.0; break;
case SizeOptions.Short: cost = 3.49; break;
case SizeOptions.Medium: cost = 5.0; break;
case SizeOptions.Long: cost = 6.49; break;
case SizeOptions.Big: cost = 8.99; break;
}
total = cost;
string message = string.Format(DynamicCoffee.Cost, $"{total:C2}");
return new PromptAttribute(message);
})- Récapituler la commande et demander si tout est correct :
.Confirm(async (state) =>
{
string customMessage = DynamicCoffee.RepeartOrderPart1;
if (state.Sugar != null || state.Toppings != null)
{
customMessage = string.Concat(customMessage, DynamicCoffee.RepeartOrderPart2);
}
customMessage = string.Concat(customMessage, "?");
return new PromptAttribute(customMessage);
})- Demander le nom de l'utilisateur, l'adresse, l'horaire de livraison et l'évaluation du service :
.AddRemainingFields()Notez que la méthode AddRemainingFields() permet d'ajouter toutes les autres propriétés restantes (une ligne de code oui).
- Remercier l'utilisateur pour sa commande :
.Message(DynamicCoffee.ThankYou)Compilez, éxécutez et testez le tout avec l'émulateur !
Voici le résultat que vous devriez obtenir :
Ces parties sont optionnelles dans le cadre du mini-hack, mais voici quelques idées pour aller plus loin :
- Déployer votre bot dans le cloud
- Enregistrer votre bot
Vous pouvez réaliser les deux parties ci-dessus en suivant les instructions détaillées ici : Pour aller plus loin
Indépendamment de cela, vous pouvez également :
- Localiser le bot pour qu’il gère plusieurs langues
- Ajouter un peu de cogntives services avec LUIS ou Recast.AI
- Gérer plus de boissons ou plus de type de boissons (pourquoi pas des cocktails ?)
- Développer une gestion des prix plus aboutie et plus dynamique (en se basant sur la présence de suppléments par exemple)