News skill: adding trending articles, favorite topics, searching by market, searching by website (#1660)

* Added trending articles, changing search market, search specific sites, choosing favorite topics

* Changes from comments

* fis newsLuis

Author: litofish

skills/src/csharp/experimental/newsskill/Deployment/Resources/LU/en/news.lu

@@ -19,9 +19,84 @@
 - find me news on {topic}
 - find news on {topic}
 - news about {topic}
+- news about {topic=microsoft} on {site=wsj.com}
+- whats the latest news on {site=nytimes.com}
+- news on {site=cnn.com}
+- latest news on {site}
+- find me news about {topic} on {site}
+- find me news on {topic} on {site}
+- whats the news on {site=cnn.com}
+- find news on {topic=technology} on {site=wsj.com}
+- whats the latest on {topic} on {site}
+- find me news from {site}
+- find me news about {topic} from {site}
+- {topic} news from {site}
+- {topic} news on {site}
+
+## TrendingArticles
+- what's trending now
+- what's the latest trending news
+- find trending news
+- what's the top news on social media
+- trending news
+- top news on social media
+- what news is popular right now
+- popular news
+- find trending articles
+- trending articles
+- news trending on social media
+- articles popular on social media
+- news trending now
+- find news trending on social networks
+- news popular on social networks
+- articles trending now
+
+## SetFavoriteTopics
+- set favorite news topics
+- set favorite news categories
+- choose favorite news topics
+- choose favorite news categories
+- set news topics
+- set news categories
+- set favorites
+- choose favorites
+- choose my topics
+- set my topics
+- set news I'm interested in
+- choose topics I'm interested in
+
+## ShowFavoriteTopics
+- favorite news
+- favorite news topics
+- my news categories
+- my news topics
+- my news interests
+- news I'm interested in
+- what's my favorite news
+- topics I'm interested in
+- my news
+- my favorite news
+- news for me
+- my news suggestions
+- news topics for me
+- what are my favorites
+- what are my favorite topics
+- find favorites
+- find favorite news
+- find favorite topics
 
 ## None
+- 1
+- 2
+- forward email
+- find point of interest
+- get directions
+- add to my to do list
+- how long do I have until my next calendar appointment
+- hello world
+- what's the weather today
 
 > # Entity definitions
 
-$topic:simple
+$topic:simple
+$site:simple

skills/src/csharp/experimental/newsskill/Deployment/Resources/template.json

@@ -70,6 +70,10 @@
     "bingServiceName": {
       "type": "string",
       "defaultValue": "[concat(parameters('name'), '-bing')]"
+    },
+    "azureMapsServiceName": {
+      "type": "string",
+      "defaultValue": "[concat(parameters('name'), '-maps')]"
     }
   },
   "variables": {
@@ -202,6 +206,16 @@
       "sku": {
         "name": "S1"
       }
+    },
+    {
+      "type": "Microsoft.Maps/accounts",
+      "apiVersion": "2018-05-01",
+      "name": "[parameters('azureMapsServiceName')]",
+      "location": "global",
+      "sku": {
+        "name": "s1",
+        "tier": "Standard"
+      }
     }
   ],
   "outputs": {
@@ -236,6 +250,10 @@
     "bingSearch": {
       "type": "string",
       "value": "[listKeys(resourceId('Microsoft.CognitiveServices/accounts', parameters('bingServiceName')),'2017-04-18').key1]"
+    },
+    "azureMaps": {
+      "type": "string",
+      "value": "[listKeys(resourceId('Microsoft.Maps/accounts', parameters('azureMapsServiceName')),'2018-05-01').primaryKey]"
     }
   }
 }

skills/src/csharp/experimental/newsskill/Dialogs/FavoriteTopicsDialog.cs

@@ -0,0 +1,93 @@
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Bot.Builder;
+using Microsoft.Bot.Builder.Dialogs;
+using Microsoft.Bot.Builder.Dialogs.Choices;
+using NewsSkill.Models;
+using NewsSkill.Responses.FavoriteTopics;
+using NewsSkill.Services;
+
+namespace NewsSkill.Dialogs
+{
+    public class FavoriteTopicsDialog : NewsDialogBase
+    {
+        private NewsClient _client;
+        private FavoriteTopicsResponses _responder = new FavoriteTopicsResponses();
+
+        public FavoriteTopicsDialog(
+            BotSettings settings,
+            BotServices services,
+            ConversationState conversationState,
+            UserState userState,
+            AzureMapsService mapsService,
+            IBotTelemetryClient telemetryClient)
+            : base(nameof(FavoriteTopicsDialog), settings, services, conversationState, userState, mapsService, telemetryClient)
+        {
+            TelemetryClient = telemetryClient;
+
+            var newsKey = settings.Properties["BingNewsKey"] ?? throw new Exception("The BingNewsKey must be provided to use this dialog. Please provide this key in your Skill Configuration.");
+
+            _client = new NewsClient(newsKey);
+
+            var favoriteTopics = new WaterfallStep[]
+            {
+                GetMarket,
+                SetMarket,
+                SetFavorites,
+                ShowArticles,
+            };
+
+            AddDialog(new WaterfallDialog(nameof(FavoriteTopicsDialog), favoriteTopics));
+            AddDialog(new ChoicePrompt(nameof(ChoicePrompt)));
+            AddDialog(new TextPrompt(nameof(TextPrompt), MarketPromptValidatorAsync));
+        }
+
+        private async Task<DialogTurnResult> SetFavorites(WaterfallStepContext sc, CancellationToken cancellationToken)
+        {
+            var convState = await ConvAccessor.GetAsync(sc.Context, () => new NewsSkillState());
+            var userState = await UserAccessor.GetAsync(sc.Context, () => new NewsSkillUserState());
+
+            // if intent is SetFavorites or not set in state yet
+            if (convState.LuisResult.TopIntent().intent == Luis.newsLuis.Intent.SetFavoriteTopics || userState.Category == null)
+            {
+                // show card with categories the user can choose
+                var categories = new PromptOptions()
+                {
+                    Choices = new List<Choice>(),
+                };
+
+                categories.Choices.Add(new Choice("Business"));
+                categories.Choices.Add(new Choice("Entertainment"));
+                categories.Choices.Add(new Choice("Health"));
+                categories.Choices.Add(new Choice("Politics"));
+                categories.Choices.Add(new Choice("World"));
+                categories.Choices.Add(new Choice("Sports"));
+
+                return await sc.PromptAsync(nameof(ChoicePrompt), new PromptOptions()
+                {
+                    Prompt = await _responder.RenderTemplate(sc.Context, sc.Context.Activity.Locale, FavoriteTopicsResponses.FavoriteTopicPrompt),
+                    Choices = categories.Choices
+                });
+            }
+
+            return await sc.NextAsync(userState.Category);
+        }
+
+        private async Task<DialogTurnResult> ShowArticles(WaterfallStepContext sc, CancellationToken cancellationToken)
+        {
+            var userState = await UserAccessor.GetAsync(sc.Context, () => new NewsSkillUserState());
+
+            userState.Category = (FoundChoice)sc.Result;
+
+            // show favorite articles
+            var articles = await _client.GetNewsByCategory(userState.Category.Value, userState.Market);
+            await _responder.ReplyWith(sc.Context, FavoriteTopicsResponses.ShowArticles, articles);
+
+            return await sc.EndDialogAsync();
+        }
+    }
+}

skills/src/csharp/experimental/newsskill/Dialogs/FindArticlesDialog.cs

@@ -1,4 +1,6 @@
 using System;
+using System.Globalization;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Bot.Builder;
@@ -18,37 +20,38 @@ public FindArticlesDialog(
             BotSettings settings,
             BotServices services,
             ConversationState conversationState,
+            UserState userState,
+            AzureMapsService mapsService,
             IBotTelemetryClient telemetryClient)
-            : base(nameof(FindArticlesDialog), services, conversationState, telemetryClient)
+            : base(nameof(FindArticlesDialog), settings, services, conversationState, userState, mapsService, telemetryClient)
         {
             TelemetryClient = telemetryClient;
 
-            var key = settings.Properties["BingNewsKey"] ?? throw new Exception("The BingNewsKey must be provided to use this dialog. Please provide this key in your Skill Configuration.");
+            var newsKey = settings.Properties["BingNewsKey"] ?? throw new Exception("The BingNewsKey must be provided to use this dialog. Please provide this key in your Skill Configuration.");
 
-            _client = new NewsClient(key);
+            _client = new NewsClient(newsKey);
 
             var findArticles = new WaterfallStep[]
             {
+                GetMarket,
+                SetMarket,
                 GetQuery,
+                GetSite,
                 ShowArticles,
             };
 
             AddDialog(new WaterfallDialog(nameof(FindArticlesDialog), findArticles));
-            AddDialog(new TextPrompt(nameof(TextPrompt)));
+            AddDialog(new TextPrompt(nameof(TextPrompt), MarketPromptValidatorAsync));
         }
 
         private async Task<DialogTurnResult> GetQuery(WaterfallStepContext sc, CancellationToken cancellationToken)
         {
-            var state = await Accessor.GetAsync(sc.Context, () => new NewsSkillState());
+            var convState = await ConvAccessor.GetAsync(sc.Context, () => new NewsSkillState());
 
             // Let's see if we have a topic
-            if (state.LuisResult.Entities.topic != null)
+            if (convState.LuisResult.Entities.topic != null && convState.LuisResult.Entities.topic.Length > 0)
             {
-                // If we have a topic let's skip the topic prompt
-                if (state.LuisResult.Entities.topic.Length > 0)
-                {
-                    return await sc.NextAsync(state.LuisResult.Entities.topic[0]);
-                }
+                return await sc.NextAsync(convState.LuisResult.Entities.topic[0]);
             }
 
             return await sc.PromptAsync(nameof(TextPrompt), new PromptOptions()
@@ -57,10 +60,29 @@ private async Task<DialogTurnResult> GetQuery(WaterfallStepContext sc, Cancellat
             });
         }
 
+        private async Task<DialogTurnResult> GetSite(WaterfallStepContext sc, CancellationToken cancellationToken)
+        {
+            var convState = await ConvAccessor.GetAsync(sc.Context, () => new NewsSkillState());
+
+            string query = (string)sc.Result;
+
+            // if site specified in luis, add to query
+            if (convState.LuisResult.Entities.site != null && convState.LuisResult.Entities.site.Length > 0)
+            {
+                string site = convState.LuisResult.Entities.site[0].Replace(" ", string.Empty);
+                query = string.Concat(query, $" site:{site}");
+            }
+
+            return await sc.NextAsync(query);
+        }
+
         private async Task<DialogTurnResult> ShowArticles(WaterfallStepContext sc, CancellationToken cancellationToken)
         {
+            var userState = await UserAccessor.GetAsync(sc.Context, () => new NewsSkillUserState());
+
             var query = (string)sc.Result;
-            var articles = await _client.GetNewsForTopic(query);
+
+            var articles = await _client.GetNewsForTopic(query, userState.Market);
             await _responder.ReplyWith(sc.Context, FindArticlesResponses.ShowArticles, articles);
 
             return await sc.EndDialogAsync();

skills/src/csharp/experimental/newsskill/Dialogs/MainDialog.cs

@@ -30,6 +30,8 @@ public MainDialog(
             BotServices services,
             ConversationState conversationState,
             FindArticlesDialog findArticlesDialog,
+            TrendingArticlesDialog trendingArticlesDialog,
+            FavoriteTopicsDialog favoriteTopicsDialog,
             IBotTelemetryClient telemetryClient)
             : base(nameof(MainDialog), telemetryClient)
         {
@@ -42,6 +44,8 @@ public MainDialog(
             _stateAccessor = _conversationState.CreateProperty<NewsSkillState>(nameof(NewsSkillState));
 
             AddDialog(findArticlesDialog ?? throw new ArgumentNullException(nameof(findArticlesDialog)));
+            AddDialog(trendingArticlesDialog ?? throw new ArgumentNullException(nameof(trendingArticlesDialog)));
+            AddDialog(favoriteTopicsDialog ?? throw new ArgumentNullException(nameof(favoriteTopicsDialog)));
         }
 
         protected override async Task OnStartAsync(DialogContext dc, CancellationToken cancellationToken = default(CancellationToken))
@@ -72,6 +76,21 @@ public MainDialog(
                 // switch on general intents
                 switch (intent)
                 {
+                    case newsLuis.Intent.TrendingArticles:
+                        {
+                            // send articles in response
+                            turnResult = await dc.BeginDialogAsync(nameof(TrendingArticlesDialog));
+                            break;
+                        }
+
+                    case newsLuis.Intent.SetFavoriteTopics:
+                    case newsLuis.Intent.ShowFavoriteTopics:
+                        {
+                            // send favorite news categories
+                            turnResult = await dc.BeginDialogAsync(nameof(FavoriteTopicsDialog));
+                            break;
+                        }
+                        
                     case newsLuis.Intent.FindArticles:
                         {
                             // send greeting response