From c013d77df54ad8628438fffdfc4635a4eebfbf19 Mon Sep 17 00:00:00 2001 From: smore Date: Mon, 8 Jun 2020 14:10:35 -0700 Subject: [PATCH] Fix Urls in MarkDown (#3453) --- docs/_docs/skills/samples/bing-search.md | 4 +-- docs/_docs/skills/samples/hospitality.md | 6 ++-- docs/_docs/skills/samples/itsm.md | 4 +-- docs/_docs/skills/samples/music.md | 4 +-- docs/_docs/skills/samples/news.md | 2 +- .../skills/samples/restaurant-booking.md | 4 +-- docs/_docs/skills/samples/weather.md | 4 +-- .../assistants/hospitality-assistant.md | 24 +++++++-------- .../virtual-assistant/handbook/feedback.md | 29 ++++++++++++++++--- 9 files changed, 51 insertions(+), 30 deletions(-) diff --git a/docs/_docs/skills/samples/bing-search.md b/docs/_docs/skills/samples/bing-search.md index b056d6ee70..1765c85ba5 100644 --- a/docs/_docs/skills/samples/bing-search.md +++ b/docs/_docs/skills/samples/bing-search.md @@ -11,7 +11,7 @@ toc: true # {{ page.title }} {:.no_toc} -The [Bing Search Skill]({{site.repo}}/tree/master/skills/csharp/experimental/bingsearchskill) provides a simple Skill that integrates with the [Bing Search Cognitive Service](https://azure.microsoft.com/en-us/services/cognitive-services/bing-web-search-api/). +The [Bing Search Skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/bingsearchskill) provides a simple Skill that integrates with the [Bing Search Cognitive Service](https://azure.microsoft.com/en-us/services/cognitive-services/bing-web-search-api/). This skill has a very limited LUIS model (available in English, French, Italian, German, Spanish and Chinese) and demonstrates three simple scenarios: @@ -35,4 +35,4 @@ Learn how to [provision your Azure resources]({{site.baseurl}}/skills/tutorials/ ``` "BingSearchKey": "{YOUR_BING_SEARCH_COGNITIVE_SERVICES_KEY}", "BingAnswerSearchKey": "{YOUR_PROJECT_ANSWER_SEARCH_KEY}" -``` \ No newline at end of file +``` diff --git a/docs/_docs/skills/samples/hospitality.md b/docs/_docs/skills/samples/hospitality.md index ac4d647ac0..db977f5174 100644 --- a/docs/_docs/skills/samples/hospitality.md +++ b/docs/_docs/skills/samples/hospitality.md @@ -10,12 +10,12 @@ order: 5 # {{ page.title }} {:.no_toc} -The [Hospitality Skill]({{site.repo}}/tree/master/skills/csharp/experimental/hospitalityskill) demonstrates experiences that would be useful in a hospitality specific scenario, such as being able to check out of a hotel, ordering room service, and requesting hotel amenities. This skill does not integrate a hotel service at this time, and is instead simulated with static data for testing purposes. +The [Hospitality Skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/hospitalityskill) demonstrates experiences that would be useful in a hospitality specific scenario, such as being able to check out of a hotel, ordering room service, and requesting hotel amenities. This skill does not integrate a hotel service at this time, and is instead simulated with static data for testing purposes. This skill demonstrates the following scenarios: - Show reservation: *What is my current check out date?* - Extend reservation: *Can I extend my stay?* -- Request late check-out: *I want a late check out time* +- Request late check-out: *I want a late check out time* - Request amenities: *Can you bring me a toothbrush and toothpaste?* - Room service: *I want to see a room service menu* - Check out: *Can I check out now?* @@ -28,4 +28,4 @@ The [Hospitality Sample VA]({{site.baseurl}}/solution-accelerators/assistants/ho ## Deployment {:.no_toc} -Learn how to [provision your Azure resources]({{site.baseurl}}/skills/tutorials/create-skill/csharp/4-provision-your-azure-resources/) in the Create a Skill tutorial. \ No newline at end of file +Learn how to [provision your Azure resources]({{site.baseurl}}/skills/tutorials/create-skill/csharp/4-provision-your-azure-resources/) in the Create a Skill tutorial. diff --git a/docs/_docs/skills/samples/itsm.md b/docs/_docs/skills/samples/itsm.md index 36cd45f29b..849e53cc97 100644 --- a/docs/_docs/skills/samples/itsm.md +++ b/docs/_docs/skills/samples/itsm.md @@ -11,7 +11,7 @@ toc: true # {{ page.title }} {:.no_toc} -The [IT Service Management skill]({{site.repo}}/tree/master/skills/csharp/experimental/itsmskill) provides a basic skill that provides ticket and knowledge base related capabilities and supports SerivceNow. +The [IT Service Management skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/itsmskill) provides a basic skill that provides ticket and knowledge base related capabilities and supports SerivceNow. This skill demonstrates the following scenarios: - Create a ticket: *Create a ticket for my broken laptop* @@ -49,4 +49,4 @@ To test this skill you will need to follow the ServiceNow configuration steps sh To test this skill with your Virtual Assistant one manual step is required over and above the usual skill connection steps. -- Add OAuth Connection to your Virtual Assistant manually as per the step above. This connection type cannot be automatically configured as part of botskills. \ No newline at end of file +- Add OAuth Connection to your Virtual Assistant manually as per the step above. This connection type cannot be automatically configured as part of botskills. diff --git a/docs/_docs/skills/samples/music.md b/docs/_docs/skills/samples/music.md index 7d33d3481b..e88ee4157d 100644 --- a/docs/_docs/skills/samples/music.md +++ b/docs/_docs/skills/samples/music.md @@ -11,7 +11,7 @@ toc: true # {{ page.title }} {:.no_toc} -The [Music skill]({{site.repo}}/tree/master/skills/csharp/experimental/musicskill) integrates with [Spotify](https://developer.spotify.com/documentation/web-api/libraries/) to look up playlists and artists and open the Spotify app via URI. +The [Music skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/musicskill) integrates with [Spotify](https://developer.spotify.com/documentation/web-api/libraries/) to look up playlists and artists and open the Spotify app via URI. This is dependent on the [SpotifyAPI-NET](https://github.com/JohnnyCrazy/SpotifyAPI-NET) wrapper for the Spotify Web API. ## Deployment @@ -27,4 +27,4 @@ Learn how to [provision your Azure resources]({{site.baseurl}}/skills/tutorials/ ``` "spotifyClientId": "{YOUR_SPOTIFY_CLIENT_ID}", "spotifyClientSecret": "{YOUR_SPOTIFY_CLIENT_SECRET}" -``` \ No newline at end of file +``` diff --git a/docs/_docs/skills/samples/news.md b/docs/_docs/skills/samples/news.md index a8455b92f8..c2a51a6347 100644 --- a/docs/_docs/skills/samples/news.md +++ b/docs/_docs/skills/samples/news.md @@ -11,7 +11,7 @@ toc: true # {{ page.title }} {:.no_toc} -The [News skill]({{site.repo}}/tree/master/skills/csharp/experimental/newsskill) provides a simple Skill that integrates with the Bing News Cognitive Service to demonstrate how a news experience can be integrated into a Virtual Assistant. +The [News skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/newsskill) provides a simple Skill that integrates with the Bing News Cognitive Service to demonstrate how a news experience can be integrated into a Virtual Assistant. Once deployed create a [Bing News Cognitive Services Key](https://azure.microsoft.com/en-us/services/cognitive-services/bing-news-search-api/) and update the appropriate configuration within appSettings.config. diff --git a/docs/_docs/skills/samples/restaurant-booking.md b/docs/_docs/skills/samples/restaurant-booking.md index 8116a7bd2b..e9fb3857c6 100644 --- a/docs/_docs/skills/samples/restaurant-booking.md +++ b/docs/_docs/skills/samples/restaurant-booking.md @@ -11,7 +11,7 @@ toc: true # {{ page.title }} {:.no_toc} -The [Restaurant Booking skill]({{site.repo}}/tree/master/skills/csharp/experimental/restaurantbookingskill) provides a simple restaurant booking experience guiding the user through booking a table and leverages Adaptive Cards throughout to demonstrate how Speech, Text and UX can be combined for a compelling user experience. No integration to restaurant booking services exists at this time so is simulated with static data for testing purposes. +The [Restaurant Booking skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/restaurantbookingskill) provides a simple restaurant booking experience guiding the user through booking a table and leverages Adaptive Cards throughout to demonstrate how Speech, Text and UX can be combined for a compelling user experience. No integration to restaurant booking services exists at this time so is simulated with static data for testing purposes. An example transcript file demonstrating the Skill in action can be found [here]({{site.baseurl}}/assets/transcripts/skills-restaurantbooking.transcript), you can use the Bot Framework Emulator to open transcripts. @@ -19,4 +19,4 @@ An example transcript file demonstrating the Skill in action can be found [here] ## Deployment {:.no_toc} -Learn how to [provision your Azure resources]({{site.baseurl}}/skills/tutorials/create-skill/csharp/4-provision-your-azure-resources/) in the Create a Skill tutorial. \ No newline at end of file +Learn how to [provision your Azure resources]({{site.baseurl}}/skills/tutorials/create-skill/csharp/4-provision-your-azure-resources/) in the Create a Skill tutorial. diff --git a/docs/_docs/skills/samples/weather.md b/docs/_docs/skills/samples/weather.md index 1953cf11a7..fe39a196cc 100644 --- a/docs/_docs/skills/samples/weather.md +++ b/docs/_docs/skills/samples/weather.md @@ -11,7 +11,7 @@ toc: true # {{ page.title }} {:.no_toc} -The [Weather skill]({{site.repo}}/tree/master/skills/csharp/experimental/weatherskill) provides a basic Skill that integrates with [Azure Maps](https://azure.microsoft.com/en-us/services/azure-maps/) to demonstrate how a weather experience can be integrated into a Virtual Assistant. +The [Weather skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/weatherskill) provides a basic Skill that integrates with [Azure Maps](https://azure.microsoft.com/en-us/services/azure-maps/) to demonstrate how a weather experience can be integrated into a Virtual Assistant. ## Deployment {:.no_toc} @@ -30,4 +30,4 @@ Learn how to [provision your Azure resources]({{site.baseurl}}/skills/tutorials/ ``` "WeatherApiKey": "{YOUR_AzureMaps_KEY}" -``` \ No newline at end of file +``` diff --git a/docs/_docs/solution-accelerators/assistants/hospitality-assistant.md b/docs/_docs/solution-accelerators/assistants/hospitality-assistant.md index 8f6d81f351..e7e95744a3 100644 --- a/docs/_docs/solution-accelerators/assistants/hospitality-assistant.md +++ b/docs/_docs/solution-accelerators/assistants/hospitality-assistant.md @@ -11,9 +11,9 @@ toc: true The [Hospitality Assistant sample]({{site.repo}}/tree/master/samples/csharp/assistants/hospitality-assistant) is a prototype of an assistant that helps to conceptualize and demonstrate how a virtual assistant could be used in a hospitality specific scenario. It also provides a starting point for those interested in creating an assistant customized for this scenario. -This sample works off the basis that the assistant would be integrated into a hotel room device and would help a hotel guest with anything they might usually go to the hotel concierge about. It also provides additional capabilites that might be useful for guests, such as getting the weather forecast or showing current news articles. +This sample works off the basis that the assistant would be integrated into a hotel room device and would help a hotel guest with anything they might usually go to the hotel concierge about. It also provides additional capabilites that might be useful for guests, such as getting the weather forecast or showing current news articles. -The Hospitality Sample builds off of the [Virtual Assistant Template]({{site.baseurl}}/overview/virtual-assistant-template) with the addition of a [QnA Maker](https://www.qnamaker.ai/) knowledge base for answering common hotel FAQs and customized [Adaptive Cards](https://adaptivecards.io/). +The Hospitality Sample builds off of the [Virtual Assistant Template]({{site.baseurl}}/overview/virtual-assistant-template) with the addition of a [QnA Maker](https://www.qnamaker.ai/) knowledge base for answering common hotel FAQs and customized [Adaptive Cards](https://adaptivecards.io/). ![Hospitality Sample Diagram]({{site.baseurl}}/assets/images/hospitalitysample-diagram.png) @@ -56,7 +56,7 @@ The majority of the skills connected to this sample are [experimental skills]({{ #### [News Skill]({{site.baseurl}}/skills/samples/news) {:.no_toc} -##### Find news articles +##### Find news articles {:.no_toc} - *What's the latest news on surfing?* - *What news is currently trending?* @@ -77,21 +77,21 @@ The majority of the skills connected to this sample are [experimental skills]({{ {:.no_toc} ##### Get the forecast {:.no_toc} -- *Whatโ€™s the weather today?* +- *Whatโ€™s the weather today?* ## Deploy To configure this sample follow the steps below: 1. Clone the [Hospitality Assistant sample]({{site.repo}}/tree/master/samples/csharp/assistants/hospitality-assistant). 1. Follow the [Create your Virtual Assistant tutorial]({{site.baseurl}}/virtual-assistant/tutorials/create-assistant/csharp/1-intro/) to deploy your assistant. Use the sample project you cloned instead of the Virtual Assistant template to include the hospitality customizations in this project. 1. Clone the following skills from our repository: - - [Hospitality Skill]({{site.repo}}/tree/master/skills/csharp/experimental/hospitalityskill) - - [Point of Interest Skill]({{site.repo}}/tree/master/skills/csharp/pointofinterestskill) - - [Weather Skill]({{site.repo}}/tree/master/skills/csharp/experimental/weatherskill) - - [Bing Search Skill]({{site.repo}}/tree/master/skills/csharp/experimental/bingsearchskill) - - [News Skill]({{site.repo}}/tree/master/skills/csharp/experimental/newsskill) - - [Restaurant Booking Skill]({{site.repo}}/tree/master/skills/csharp/experimental/restaurantbookingskill) -1. [Deploy each one of these skills]({{site.baseurl}}/skills/tutorials/create-skill/csharp/4-provision-your-azure-resources/) separately, using the deployment script included in the skill directory. -1. [Add each skill]({{site.baseurl}}/skills/handbook/add-skills-to-a-virtual-assistant/) using the botskills connect CLI tool. + - [Hospitality Skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/hospitalityskill) + - [Point of Interest Skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/pointofinterestskill) + - [Weather Skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/weatherskill) + - [Bing Search Skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/bing-search) + - [News Skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/newsskill) + - [Restaurant Booking Skill](https://github.com/microsoft/botframework-skills/tree/master/skills/csharp/experimental/restaurantbookingskill) +1. [Deploy each one of these skills]({{site.baseurl}}/skills/tutorials/create-skill/csharp/4-provision-your-azure-resources/) separately, using the deployment script included in the skill directory. +1. [Add each skill]({{site.baseurl}}/skills/handbook/add-skills-to-a-virtual-assistant/) using the botskills connect CLI tool. ## Download transcripts diff --git a/docs/_docs/virtual-assistant/handbook/feedback.md b/docs/_docs/virtual-assistant/handbook/feedback.md index 8b728b63d1..7482a98769 100644 --- a/docs/_docs/virtual-assistant/handbook/feedback.md +++ b/docs/_docs/virtual-assistant/handbook/feedback.md @@ -38,17 +38,38 @@ This implementation allows for feedback to be collected when a child dialog of m | CommentReceivedMessage | Message to show after user provides a free-form comment. | **string** | *Your comment has been received.* | | FeedbackPromptMessage | Message to show after user when prompting for feedback | **string** | *Was that helpful?* | +Example of altering any of the identified properties in startup.cs + ```csharp + services.AddSingleton(new FeedbackOptions + { + CommentsEnabled = false, + FeedbackActions = + { + new Choice() + { + Action = new CardAction(ActionTypes.MessageBack, title: "๐Ÿ‘†", text: "positive", displayText: "๐Ÿ‘†"), + Value = "positive", + }, + new Choice() + { + Action = new CardAction(ActionTypes.MessageBack, title: "๐Ÿ‘‡", text: "negative", displayText: "๐Ÿ‘‡"), + Value = "negative", + }, + } + }); + ``` + 3. Copy the feedback waterfall steps from Maindialog.cs in the Enterprise Assistant solution (RequestFeedback, RequestFeedbackComment, ProcessFeedback) and add them to your VAs mainDialog.cs waterfall flow. - Add corresponding steps and prompts to the Maindialog constructor (use enterprise assistant for reference) -1. When you copy the waterfall steps over ensure you resolve any unknown object/function references with the implementations added in step 1. +1. When you copy the waterfall steps over ensure you resolve any unknown object/function references with the implementations added in step 1. - There are separate implementations in the lib, **do not use those for this feedback solution, use the implementations you manually added in step 1**. 1. If you have followed these steps and used the Enterprise Assistant as a reference then you should now have all you need. -1. Run through any dialog in your VA, when the dialog ends and returns to MainDialog.cs then the feedback flow should be triggered. - - If the user ignores the feedback prompt and sends an unrelated query to the bot then they're query will skip feedback and be routed accordingly. +1. Run through any dialog in your VA, when the dialog ends and returns to MainDialog.cs then the feedback flow should be triggered. + - If the user ignores the feedback prompt and sends an unrelated query to the bot then they're query will skip feedback and be routed accordingly. - If the user provides any feedback at all then it will be logged with app insights and that telemetry will be part of your PowerBI dashboard ## View your feedback in Power BI -You can view your **Feedback** in the Feedback tab of the Conversational AI Dashboard. +You can view your **Feedback** in the Feedback tab of the Conversational AI Dashboard. ![]({{site.baseurl}}/assets/images/analytics/virtual-assistant-analytics-powerbi-13.png)