Skip to content
This repository has been archived by the owner on Jun 30, 2022. It is now read-only.

Commit

Permalink
[Docs] Update hospitality related docs (#2256)
Browse files Browse the repository at this point in the history
* Add room service dialog files

* Add room service luis model

*  Complete most of room service dialog

* update menu card

* improve luis model

* final changes

* Move requested item availability check to hotel service and add adaptive card for showing item requests

* update manifest

* Adding updated hospitality skill

* small changes to sample

* restaurant booking fixes

* weather skill .lu file update

* Update skill manifests

* skills updates

* Add files for event skill from skill template

* remove other languages

* Add files for basic find events dialog

* Add Eventbrite service to get event information

* Update Luis model and create adaptive card for events

* Implement populating location state from semantic action

* fix bugs

* Add event skill to sample

* room service dialog bug fix

* for event, news, and weather skills populate location state from semantic action

* customize VA start card

* Add available items and room service menu item

* Hospitality skill available items updates

* Sample small updates and add Bing Search skill

* Support adaptive cards being used in Teams for Hospitality and Event skills

* fixes for better funcitonality in Teams

* Update experimental.md docs with event and hospitality skills

* Update hospitality related docs

* Revert visual studio version

* update sample description

* fix to using {{site.repo}}

* move hospitalitysample.md into reference/samples and update links

* Update readme.md

* Update readme.md
  • Loading branch information
litofish authored and lauren-mills committed Sep 4, 2019
1 parent 3df242f commit adc6411
Show file tree
Hide file tree
Showing 12 changed files with 20,886 additions and 7 deletions.
84 changes: 84 additions & 0 deletions docs/_docs/reference/samples/hospitalitysample.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
category: Reference
subcategory: Samples
title: Hospitality Assistant
description: Virtual Assistant sample made for a hospitality scenario.
order: 2
---

# {{ page.title }}
{:.no_toc}

## In this reference
{:.no_toc}

*
{:toc}

## Overview
The [Hospitality Sample Virtual Assistant]({{site.repo}}/tree/master/samples/assistants/HospitalitySample) 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.

The Hospitality Sample builds off of the [Virtual Assistant Template]({{site.baseurl}}/overview/virtualassistant) with the addition of a [QnA Maker](https://www.qnamaker.ai/) knowledge base for answering common hotel FAQs and [Adaptive Cards](https://adaptivecards.io/) customized for hospitality. It also connects 7 different skills, which are [Hospitality]({{site.baseurl}}/reference/skills/experimental/#hospitality-skill), [Event]({{site.baseurl}}/reference/skills/experimental/#event-skill), [Point of Interest]({{site.baseurl}}/reference/skills/pointofinterest), [Weather]({{site.baseurl}}/reference/skills/experimental/#weather-skill), [Bing Search]({{site.baseurl}}/reference/skills/experimental/#bing-search-skill), [News]({{site.baseurl}}/reference/skills/experimental/#news-skill), and [Restaurant Booking]({{site.baseurl}}/reference/skills/experimental/#restaurant-booking-skill).

![Hospitality Sample Diagram]({{site.baseurl}}/assets/images/hospitalitysample-diagram.png)

The majority of the skills connected to this sample are [experimental skills]({{site.baseurl}}/reference/skills/experimental), which means they are early prototypes of Skills and are likely to have rudimentary language models, limited language support and limited testing. These skills demonstrate a variety of skill concepts and provide great examples to get you started.

## Sample Configuration
To configure this sample follow the steps below:
1. Clone the [Hospitality Sample from our repository]({{site.repo}}/tree/master/samples/assistants/HospitalitySample).
2. Follow the [Create your Virtual Assistant tutorial]({{site.baseurl}}/tutorials/csharp/create-assistant/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.
3. Clone the following skills from our repository:
- [Hospitality Skill]({{site.repo}}/tree/master/skills/src/csharp/experimental/hospitalityskill)
- [Event Skill]({{site.repo}}/tree/master/skills/src/csharp/experimental/eventskill)
- [Point of Interest Skill]({{site.repo}}/tree/master/skills/src/csharp/pointofinterestskill/pointofinterestskill)
- [Weather Skill]({{site.repo}}/tree/master/skills/src/csharp/experimental/weatherskill)
- [Bing Search Skill]({{site.repo}}/tree/master/skills/src/csharp/experimental/bingsearchskill/bingsearchskill)
- [News Skill]({{site.repo}}/tree/master/skills/src/csharp/experimental/newsskill)
- [Restaurant Booking Skill]({{site.repo}}/tree/master/skills/src/csharp/experimental/restaurantbooking)
4. [Deploy each one of these skills]({{site.baseurl}}/tutorials/csharp/create-skill/4_provision_your_azure_resources/) separately, using the deployment script included in the skill directory.
4. [Add each skill]({{site.baseurl}}/howto/skills/addingskills/) using the botskills connect CLI tool.

## Supported Scenarios
This sample demonstrates the following scenarios:
- Answer hotel FAQs ([QnA Maker](https://www.qnamaker.ai/) knowledge base)
- *Where is the gym?*
- *What time is breakfast?*
- *Do you allow pets?*
- Guest reservation changes ([Hospitality Skill]({{site.baseurl}}/reference/skills/experimental/#hospitality-skill))
- *I want to extend my stay by 2 nights*
- *Can I get a late check out time?*
- *Can you check me out now*
- Room services ([Hospitality Skill]({{site.baseurl}}/reference/skills/experimental/#hospitality-skill))
- *I want to see a room service menu*
- *Can you get me 2 croissants and a yogurt parfait?*
- *Can you bring me a toothbrush and toothpaste?*
- Get local area information ([Event]({{site.baseurl}}/reference/skills/experimental/#event-skill) and [Point of Interest]({{site.baseurl}}/reference/skills/pointofinterest) skills)
- *What's happening nearby?*
- *Find me nearby coffee shops*
- Make a restaurant reservation ([Restaurant Booking Skill]({{site.baseurl}}/reference/skills/experimental/#restaurant-booking-skill))
- *Make a dinner reservation for tonight*
- Weather forecast ([Weather Skill]({{site.baseurl}}/reference/skills/experimental/#weather-skill))
- *What's the weather today?*
- Find news articles ([News Skill]({{site.baseurl}}/reference/skills/experimental/#news-skill))
- *What's the latest news on surfing?*
- *What news is currently trending?*
- Search the web ([Bing Search Skill]({{site.baseurl}}/reference/skills/experimental/#bing-search-skill))
- *Tell me about the jurassic park movie*
- *Who is Bill Gates?*

For a more in-depth explanation of the scenarios supported by each skill check out the [experimental skills documentation]({{site.baseurl}}/reference/skills/experimental) and [Point of Interest Skill documentation]({{site.baseurl}}/reference/skills/pointofinterest).

## Transcripts
Review sample conversational flows for the Hospitality Sample Assistant by downloading the following transcripts and opening with the [Bot Framework Emulator](https://aka.ms/botframework-emulator). For more flows of specific skills see [skills transcripts]({{site.baseurl}}/reference/skills/transcripts).

**Hotel FAQs**: [Download]({{site.baseurl}}/assets/transcripts/hospitalitysample-faqs.transcript)

**Reservation changes**: [Download]({{site.baseurl}}/assets/transcripts/hospitalitysample-reservationchanges.transcript)

**Room services**: [Download]({{site.baseurl}}/assets/transcripts/hospitalitysample-roomservices.transcript)

**Local information**: [Download]({{site.baseurl}}/assets/transcripts/hospitalitysample-localinfo.transcript)

61 changes: 55 additions & 6 deletions docs/_docs/reference/skills/experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
category: Reference
subcategory: Skills
title: Experimental Skills
description: News, Search, Reservation, and Weather.
description: News, Search, Reservation, Weather, Music, Events, and Hospitality.
order: 12
---

Expand All @@ -17,25 +17,74 @@ order: 12

## Overview

Experimental Skills are early prototypes of Skills to help bring skill concepts to life for demonstrations and proof-of-concepts along with providing different examples to get you started.
[Experimental Skills](https://aka.ms/bfexperimentalskills) are early prototypes of Skills to help bring skill concepts to life for demonstrations and proof-of-concepts along with providing different examples to get you started.

These skills by their very nature are not complete, will likely have rudimentary language models, limited language support and limited testing hence are located in a experimental folder to ensure this is understood before you make use of them.

## Restaurant Booking Skill

The [Restaurant Booking skill](https://github.com/microsoft/AI/tree/master/skills/src/csharp/experimental/restaurantbooking) 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]({{site.repo}}/tree/master/skills/src/csharp/experimental/restaurantbooking) 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.

![Restaurant Example]({{site.baseurl}}/assets/images/skills-restaurant-transcript.png)

## News Skill

The [News skill](https://github.com/microsoft/AI/tree/master/skills/src/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]({{site.repo}}/tree/master/skills/src/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.

This skill supports the following scenarios:
- Find articles: *Find me news about sports*
- Trending articles: *What news is trending now?*
- Show favorite topic: *Find news for me*

![News Example]({{site.baseurl}}/assets/images/skills-news-transcript.png)

## Weather Skill

The Weather skill provides a basic Skill that integrates with [AccuWeather](https://developer.accuweather.com) to demonstrate how a weather experience can be integrated into a Virtual Assistant. Provide an API key from [AccuWeather Getting Started](https://developer.accuweather.com/getting-started) in the appsettings to configure the skill.
The [Weather skill]({{site.repo}}/tree/master/skills/src/csharp/experimental/weatherskill) provides a basic Skill that integrates with [AccuWeather](https://developer.accuweather.com) to demonstrate how a weather experience can be integrated into a Virtual Assistant. Provide an API key from [AccuWeather Getting Started](https://developer.accuweather.com/getting-started) in the appsettings to configure the skill.

## Music Skill

The Music skill integrates with [Spotify](https://developer.spotify.com/documentation/web-api/libraries/) to look up playlists and artists and open via the Spotify app. Provide credentials after you [create a Spotify client](https://developer.spotify.com/dashboard/) in the appsettings to configure the skill.
The [Music skill]({{site.repo}}/tree/master/skills/src/csharp/experimental/musicskill) integrates with [Spotify](https://developer.spotify.com/documentation/web-api/libraries/) to look up playlists and artists and open via the Spotify app. Provide credentials after you [create a Spotify client](https://developer.spotify.com/dashboard/) in the appsettings to configure the skill.

## Bing Search Skill

The [Bing Search Skill]({{site.repo}}/tree/master/skills/src/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 demonstates three simple scenarios:

- Celebrity Information: *Who is Tom Cruise?*
- Q&A: *What is the gdp of switzerland*
- Movie Information: *Tell me about the jurassic park movie*

![Search Example]({{site.baseurl}}/assets/images/skills-experimental-bingsearch.png)

Once deployed create a [Bing Search Cognitive Services Key](https://azure.microsoft.com/en-us/services/cognitive-services/bing-web-search-api/) for BingSearchKey and a [Project Answer Search Key](https://labs.cognitive.microsoft.com/en-us/project-answer-search) for BingAnswerSearchKey, then update the appropriate configuration within appSettings.config.

## Event Skill

The [Event Skill]({{site.repo}}/tree/master/skills/src/csharp/experimental/eventskill) provides a simple skill that integrates with [Eventbrite](https://www.eventbrite.com/platform/) to show information about events happening in the specified area. Provide an API key from the [Eventbrite API Keys](https://www.eventbrite.com/platform/api-keys) page in the appsettings to configure the skill.

This skill currently supports one scenario to get local event information.

![Event Example]({{site.baseurl}}/assets/images/skills-event-transcript.png)

## Hospitality Skill

The [Hospitality Skill]({{site.repo}}/tree/master/skills/src/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 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?*

The [Hospitality Sample VA]({{site.baseurl}}/reference/virtual-assistant/hospitalitysample) leverages this skill and a number of other skills to demonstrate a more in-depth hospitality experience.

![Hospitality Example]({{site.baseurl}}/assets/images/skills-hospitality-transcript.png)

## Experimental Skill Deployment

Expand Down
2 changes: 2 additions & 0 deletions docs/_docs/reference/skills/transcripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ Review a sample conversational flow of each skill by downloading a transcript an
#### News Skill: [Download]({{site.baseurl}}/assets/transcripts/skills-news.transcript)

#### Reservation Skill: [Download]({{site.baseurl}}/assets/transcripts/skills-restaurantbooking.transcript)

#### Hospitality Skill: [Download]({{site.baseurl}}/assets/transcripts/skills-hospitality.transcript)
Binary file added docs/assets/images/hospitalitysample-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/skills-event-transcript.png
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.
2,449 changes: 2,449 additions & 0 deletions docs/assets/transcripts/hospitalitysample-faqs.transcript

Large diffs are not rendered by default.

4,923 changes: 4,923 additions & 0 deletions docs/assets/transcripts/hospitalitysample-localinfo.transcript

Large diffs are not rendered by default.

3,944 changes: 3,944 additions & 0 deletions docs/assets/transcripts/hospitalitysample-reservationchanges.transcript

Large diffs are not rendered by default.

3,921 changes: 3,921 additions & 0 deletions docs/assets/transcripts/hospitalitysample-roomservices.transcript

Large diffs are not rendered by default.

Loading

0 comments on commit adc6411

Please sign in to comment.