diff --git a/README.md b/README.md index db8d7706ad..7d05e49f79 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,13 @@ Templates are pre-built bot projects designed for specific scenarios. We use [ye | Name | npm | Description | |:------------:|:---:|:------------| -|[Empty Bot](/generators/generator-bot-empty) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty) | The base empty bot. | -|[Core Bot with Language](/generators/generator-bot-core-language) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-language.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-language) | Basic conversational bot with NLP. | -|[Core Assistant Bot](/generators/generator-bot-core-assistant) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant) | Basic assistant bot with no skills. | -|[Enterprise Assistant Bot](/generators/generator-bot-enterprise-assistant) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant) | Assistant Core + Calendar & People as skills. | -|[Enterprise Calendar Bot](/generators/generator-bot-enterprise-calendar) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-calendar.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-calendar) | A bot for working with Calendars. | -|[Enterprise People Bot](/generators/generator-bot-enterprise-people) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-people.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-people) | A bot for searching for people on the MS Graph. | -|[Adaptive](/generators/generator-bot-adaptive) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive) | Used by other generators to scaffold web app or functions project. | +|[Empty Bot](/generators/generator-bot-empty) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty) | A simple bot with a root dialog and greeting dialog. | +|[Core Bot with Azure Language Understanding](/generators/generator-bot-core-language) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-language.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-language) | A simple bot with Azure Language Understanding (LUIS) and common trigger phrases used to direct the conversation flow. | +|[Core Assistant Bot](/generators/generator-bot-core-assistant) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant) | A bot with Azure Language Understanding (LUIS) and common trigger phrases used to direct the conversation flow and help customers accomplish basic tasks. Designed to be extended with skills. | +|[Enterprise Assistant Bot](/generators/generator-bot-enterprise-assistant) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant) | A Core Assistant Bot with Calendar & People as skills. | +|[Enterprise Calendar Bot](/generators/generator-bot-enterprise-calendar) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-calendar.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-calendar) | A bot with the ability to interact with M365 Calendar using Microsoft Graph. | +|[Enterprise People Bot](/generators/generator-bot-enterprise-people) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-people.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-people) | A bot with the ability to search for people within Azure Active Directory using Microsoft Graph.| +|[Adaptive Bot Generator](/generators/generator-bot-adaptive) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive) | Used by other generators to scaffold web app or functions project. | ### Packages diff --git a/generators/generator-bot-core-assistant/README.md b/generators/generator-bot-core-assistant/README.md index 7b6620c8c6..c8164eb085 100644 --- a/generators/generator-bot-core-assistant/README.md +++ b/generators/generator-bot-core-assistant/README.md @@ -1,48 +1,34 @@ # @microsoft/generator-bot-core-assistant [![NPM version][npm-image]][npm-url] -This template creates an assistant-style conversational bot. Assistant-style bots typically help their users accomplish multiple different tasks, and have support for more varied conversational interactions. +A bot with Azure Language Understanding (LUIS) and common trigger phrases used to direct the conversation flow and help customers accomplish basic tasks. -Includes support for: +### Recommended use + +- Create a sophisticated conversational bot +- Customize and extend sophisticated dialogs, bot logic, language understanding and bot responses + +### Included capabilities - Greeting new and returning users +- Chit chat with QnA Maker ([professional personality](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/chit-chat-knowledge-base?tabs=v1)) - Asking for help -- Cancelling a dialog -- Submitting feedback about the bot - Error handling in conversations +- Cancelling a dialog +- Get customer feedback - Repeat the previous question -- Chit chat with QnA Maker ([professional personality](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/chit-chat-knowledge-base?tabs=v1)) -- Disambiguation of NLP results +- Disambiguation when multiple intents are recognized -## What this template is for +### Required Azure resources -Use this template if you want to... +- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice +- [Azure QnA Maker](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview) +- A storage solution for persistent state storage like Azure Cosmos DB -- Create an assistant-style, or advanced conversational bot -- See examples of more complex conversational flows, and more advanced language understanding and generation - -## Languages +### Supported languages - English (en-US) -## Azure Resource Deployment - -To run this bot you'll need the resources listed below. Create a publishing profile in Composer to provision and publish to your Azure resources for your bot. - -- [LUIS][luis], or another recognizer of your choice -- [QnA Maker](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview) -- A storage solution for persistent state storage like Azure CosmosDB - -## Using this template - -### From Composer - -From Composer you'll use the **New** button on the **Home** screen to create a new bot. After creation, Composer will guide you through making customizations to your bot. If you'd like to extend your bot with code, you can open up your bot using your favorite IDE (like Visual Studio) from the location you choose during the creation flow. - -### From the command-line - -This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). - -## License +### License [MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) diff --git a/generators/generator-bot-core-assistant/generators/app/templates/README.md b/generators/generator-bot-core-assistant/generators/app/templates/README.md index e7b5e3dc98..d332ab28be 100644 --- a/generators/generator-bot-core-assistant/generators/app/templates/README.md +++ b/generators/generator-bot-core-assistant/generators/app/templates/README.md @@ -1,6 +1,6 @@ # Welcome to your new bot -This Bot Project was created using the Assistant Core template. Your bot is an assistant-style bot - it is designed as a base for a bot that will help your users accomplish multiple different tasks. +This bot project was created using the Core Assistant template. Your bot is an assistant-style bot - it is designed as a base for a bot that will help your users accomplish multiple different tasks. ## Next steps diff --git a/generators/generator-bot-core-language/README.md b/generators/generator-bot-core-language/README.md index f04336b961..ec96ca5fd3 100644 --- a/generators/generator-bot-core-language/README.md +++ b/generators/generator-bot-core-language/README.md @@ -1,33 +1,31 @@ # @microsoft/generator-bot-core-language [![NPM version][npm-image]][npm-url] -This template creates a simple conversational bot, with triggers and dialogs for responding to help, welcome and cancel intents, and a simple response for unknown intents. +A simple bot with Azure Language Understanding (LUIS) and common trigger phrases used to direct the conversation flow. -## What this template is for +### Recommended use -Use this template if you want to... +- Create a simple conversational bot with Azure Language Understanding ([LUIS][luis]) +- Customize and extend example dialogs, bot logic, language understanding and bot responses +- Extend your bot with [Azure Bot Framework components](https://aka.ms/ComponentTemplateDocumentation) -- Create a basic conversational bot with natural language processing (NLP) with a recognizer like [LUIS][luis]. -- See the basics of how language understanding, language generation, recognizers and dialogs work together. +### Included capabilities -## Languages +- Welcoming new users +- Asking for help +- Responding to unknown language requests (unknown intents) +- Cancelling a dialog +- Use Azure Language Understanding Service (LUIS) for natural language processing -- English (en-US) - -## Azure Resource Deployment - -To run this bot you'll need to configure the default recognizer for your bot. In Composer, the default recognizer is LUIS. Additionally, you may want to consider a persistent state storage solution like Azure CosmosDB. Both can be provisioned and published to by creating a publishing profile in Composer. +### Required Azure resources -## Using this template +- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice +- A storage solution for persistent state storage like Azure Cosmos DB -### From Composer +### Supported languages -From Composer you'll use the **New** button on the **Home** screen to create a new bot. After creation, Composer will guide you through making customizations to your bot. If you'd like to extend your bot with code, you can open up your bot using your favorite IDE (like Visual Studio) from the location you choose during the creation flow. - -### From the command-line - -This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). +- English (en-US) -## License +### License [MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) diff --git a/generators/generator-bot-core-language/generators/app/templates/README.md b/generators/generator-bot-core-language/generators/app/templates/README.md index a50c0b545c..db6a653e66 100644 --- a/generators/generator-bot-core-language/generators/app/templates/README.md +++ b/generators/generator-bot-core-language/generators/app/templates/README.md @@ -1,6 +1,6 @@ # Welcome to your new bot -This Bot Project was created using the Conversational Core template, and contains support for a base set of conversational flows. +This bot project was created using the Core Bot with Azure Language Understanding template, and contains support for a base set of conversational flows. ## Next steps diff --git a/generators/generator-bot-core-qna/README.md b/generators/generator-bot-core-qna/README.md index 042f56f944..5dd28d5854 100644 --- a/generators/generator-bot-core-qna/README.md +++ b/generators/generator-bot-core-qna/README.md @@ -1,39 +1,27 @@ # @microsoft/generator-bot-core-qna [![NPM version][npm-image]][npm-url] -This template guides you through creating and connecting a bot to a QnA Maker knowledge base. You can connect to an existing knowledge base, create one from scratch using .qna files, or create one from an existing FAQ-style website. +A simple question-and-answer bot with Azure QnA Maker. -## What this template is for +### Recommended use -Use this template if you want to... +- Create a simple question-and-answer bot with Azure QnA Maker +- Customize and extend question-and-answer pairs or connect to your website's FAQ +- Extend your bot with [Azure Bot Framework components](https://aka.ms/ComponentTemplateDocumentation) -- Create a bot and connect it to a QnA Maker knowledge base +### Included capabilities -## Packages +- Answer questions from a QnA Maker knowled gebase -Your bot can use the [Azure Bot Framework component model](https://aka.ms/ComponentTemplateDocumentation) to extend the base functionality. From Composer, use the Package Manager to discover additional packages you can add to your bot. +### Required Azure resources -## Languages +- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice +- [Azure QnA Maker](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview) -- English (en-US) - -## Azure Resource Deployment - -To run this bot you'll need the resources listed below. Create a publishing profile in Composer to provision and publish to your Azure resources for your bot. - -- [LUIS][luis], or another recognizer of your choice -- [QnA Maker](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview) - -## Using this template +### Supported languages -### From Composer - -From Composer you'll use the **New** button on the **Home** screen to create a new bot. After creation, Composer will guide you through making customizations to your bot. If you'd like to extend your bot with code, you can open up your bot using your favorite IDE (like Visual Studio) from the location you choose during the creation flow. - -### From the command-line - -This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). +- English (en-US) -## License +### License [MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) diff --git a/generators/generator-bot-core-qna/generators/app/templates/README.md b/generators/generator-bot-core-qna/generators/app/templates/README.md index 61493a17d7..b5d27b3018 100644 --- a/generators/generator-bot-core-qna/generators/app/templates/README.md +++ b/generators/generator-bot-core-qna/generators/app/templates/README.md @@ -1,6 +1,6 @@ # Welcome to your new bot -This Bot Project was created using the QnA Maker template, and contains minimal bot with a QnA Maker trigger. +This bot project was created using the Core Bot with Azure QnA Maker template, and contains a minimal bot with a QnA Maker trigger. ## Next steps diff --git a/generators/generator-bot-empty/README.md b/generators/generator-bot-empty/README.md index b370d2261f..1d70a2c074 100644 --- a/generators/generator-bot-empty/README.md +++ b/generators/generator-bot-empty/README.md @@ -1,35 +1,28 @@ # @microsoft/generator-bot-empty [![NPM version][npm-image]][npm-url] -This template creates a bot that sends a simple message when interacted with. +A simple bot with a root dialog and greeting dialog. -## What this template is for +### Recommended use -Use this template if you want to... +- Start from scratch, with a basic bot without additions +- Good for first time bot developers, or seasoned pros -- Start from scratch, with minimal pre-built functionality. -- Build your bot by composing an ad-hoc set of packages. +### Included capabilities -## Supported Languages +- Greeting new and returning users -- English (en-US) - -## Azure Resource Deployment - -This template does not rely on any additional Azure Resources. +### Required Azure resources -## Using this template +- This template does not rely on any additional Azure resources -### From Composer +### Supported languages -From Composer you'll use the **New** button on the **Home** screen to create a new bot. After creation, Composer will guide you through making customizations to your bot. If you'd like to extend your bot with code, you can open up your bot using your favorite IDE (like Visual Studio) from the location you choose during the creation flow. - -### From the command-line - -This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). +- English (en-US) -## License +### License [MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) +[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis [npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty.svg [npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-empty diff --git a/generators/generator-bot-empty/generators/app/templates/README.md b/generators/generator-bot-empty/generators/app/templates/README.md index e0c71cc42e..b48822a762 100644 --- a/generators/generator-bot-empty/generators/app/templates/README.md +++ b/generators/generator-bot-empty/generators/app/templates/README.md @@ -1,6 +1,6 @@ # Welcome to your new bot -This Bot Project was created using the Empty Bot template, and contains a minimal set of files necessary to have a working bot. +This bot project was created using the Empty Bot template, and contains a minimal set of files necessary to have a working bot. ## Next steps diff --git a/generators/generator-bot-enterprise-assistant/README.md b/generators/generator-bot-enterprise-assistant/README.md index f602eede62..4623bca93d 100644 --- a/generators/generator-bot-enterprise-assistant/README.md +++ b/generators/generator-bot-enterprise-assistant/README.md @@ -1,48 +1,37 @@ # @microsoft/generator-bot-enterprise-assistant [![NPM version][npm-image]][npm-url] -This template creates an Enterprise Assistant Bot, comprised of a root bot based on the Core Assistant Bot template, and pre-configured with the Enterprise Calendar Bot and Enterprise People Bot templates as skills. [Learn more](https://aka.ms/EnterpriseAssistant) +A bot with Azure Language Understanding (LUIS), Enterprise Calendar skill, Enterprise People skill and common trigger phrases used to direct the conversation flow to help customers accomplish common business tasks. [Learn more](https://aka.ms/EnterpriseAssistant) -Includes support for: +### Recommended use -- Greeting new and returning users -- Asking for help -- Cancelling a dialog -- Submitting feedback about the bot -- Error handling in conversations -- Repeat the previous question -- Chit chat with QnA Maker ([professional personality](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/chit-chat-knowledge-base?tabs=v1)) -- Disambiguation of NLP results +- Create a sophisticated bot +- Customize and extend sophisticated example dialogs, bot logic, language understanding and bot responses +- Enterprise assistant-style bots that use Office 365 features + +### Included capabilities -Included skills: - [Enterprise Calendar Bot](https://aka.ms/EnterpriseCalendarBot) - [Enterprise People Bot](https://aka.ms/EnterprisePeopleBot) +- Greeting new and returning users +- Bot Framework Orchestrator to direct the conversation flow +- Chit chat with QnA Maker ([professional personality](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/chit-chat-knowledge-base?tabs=v1)) +- Asking for help +- Disambiguation when multiple intents are recognized +- Cancelling a dialog +- Error handling +- Repeat previous question +- Getting customer feedback -## What this template is for - -Use this template if you want to... - -- Create a conversational experience for common enterprise scenarios (i.e. calendar management and user directory lookup) -- See examples of more complex conversational flows, and more advanced language understanding and generation -- See an example of a root bot and skills handling complex user interactions including interruptions and Adaptive Cards - -## Packages - -Your bot can use the [Azure Bot Framework component model](https://aka.ms/ComponentTemplateDocumentation) to extend the base functionality. From Composer, use the Package Manager to discover additional packages you can add to your bot. - -This bot starts with the following packages: - -- [Help and Cancel intent handling](https://www.nuget.org/packages/Microsoft.Bot.Components.HelpAndCancel/) -- [Orchestrator](https://www.nuget.org/packages/Microsoft.Bot.Builder.AI.Orchestrator/) - -## Supported Languages +### Included packages -- English (en-US) +- [Help and Cancel Intent Handling](https://www.nuget.org/packages/Microsoft.Bot.Components.HelpAndCancel/) +- [Bot Framework Orchestrator](https://www.nuget.org/packages/Microsoft.Bot.Builder.AI.Orchestrator/) -## Azure Resource Deployment +The Enterprise Assistant Bot uses packages to extend its capabilities. [Learn more](https://aka.ms/ComponentTemplateDocumentation). -To run this bot you'll need the resources listed below. Create a publishing profile in Composer to provision and publish to your Azure resources for your bot. +### Required Azure resources -- Azure Bot Registration configured with Microsoft Azure Active Directory authentication with access to the following scopes: +- Azure Bot Service Registration configured with Microsoft Azure Active Directory authentication with access to the following scopes: - Calendars.ReadWrite - Contacts.Read - Directory.Read.All @@ -50,24 +39,18 @@ To run this bot you'll need the resources listed below. Create a publishing prof - People.Read.All - User.ReadBasic.All - User.Read.All -- [Language Understanding (LUIS)][luis], or another recognizer of your choice -- [QnA Maker](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview) +- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice +- [Azure QnA Maker](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview) - A storage solution for persistent state storage like Azure Cosmos DB -## Using this template - -### From Composer - -From Composer you'll use the **New** button on the **Home** screen to create a new bot. After creation, Composer will guide you through making customizations to your bot. If you'd like to extend your bot with code, you can open up your bot using your favorite IDE (like Visual Studio) from the location you choose during the creation flow. +### Supported Languages -### From the command-line - -This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). +- English (en-US) -## License +### License [MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) [luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis -[npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-enterprise-assistant.svg +[npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant.svg [npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-assistant diff --git a/generators/generator-bot-enterprise-assistant/generators/app/templates/README.md b/generators/generator-bot-enterprise-assistant/generators/app/templates/README.md index 310836ed18..5ba82c7a75 100644 --- a/generators/generator-bot-enterprise-assistant/generators/app/templates/README.md +++ b/generators/generator-bot-enterprise-assistant/generators/app/templates/README.md @@ -1,6 +1,6 @@ # Welcome to your new bot -This Bot Project was created using the **[Enterprise Assistant Bot](https://aka.ms/EnterpriseAssistant)** template, and contains a root bot and two skills. You **must complete the configuration steps outlined below for your bot to function.** +This bot project was created using the **[Enterprise Assistant Bot](https://aka.ms/EnterpriseAssistant)** template, and contains a root bot and two skills. You **must complete the configuration steps outlined below for your bot to function.** ## Configure your Enterprise Assistant Bot To test this bot locally, complete the steps in the **[Enterprise Assistant Bot Tutorial](https://aka.ms/CreateEnterpriseAssistant)**. diff --git a/generators/generator-bot-enterprise-calendar/README.md b/generators/generator-bot-enterprise-calendar/README.md index da192d2f43..b6b5581863 100644 --- a/generators/generator-bot-enterprise-calendar/README.md +++ b/generators/generator-bot-enterprise-calendar/README.md @@ -1,44 +1,36 @@ # @microsoft/generator-bot-enterprise-calendar [![NPM version][npm-image]][npm-url] -This template creates a bot configured to manage Office 365 calendars using the Microsoft Graph API. **[Learn more](https://aka.ms/EnterpriseCalendarBot)** +This bot project was created using the [Enterprise Calendar Bot](https://aka.ms/EnterpriseCalendarBot) template. You **must complete the configuration steps outlined below for your bot to function.** -## What this template is for +### Recommended use -Use this template if you want to... +- Create a sophisticated bot that enables customers to interact with Office 365 Calendar using Microsoft Graph +- Customize and extend sophisticated example dialogs, bot logic, language understanding and bot responses -- Support managing Office 365 calendars using Microsoft Graph -- Start from an advanced template including dialogs, language understanding, and language generation +### Included capabilities -## Packages +- Manage Office 365 calendars using Microsoft Graph -This bot uses the [Azure Bot Framework component model](https://aka.ms/ComponentTemplateDocumentation) to extend its base functionality. The following packages come pre-installed: -- [Microsoft.Bot.Components.Graph](https://www.nuget.org/packages/Microsoft.Bot.Components.Graph/) +### Included packages -## Supported Languages +- [Microsoft Graph](https://www.nuget.org/packages/Microsoft.Bot.Components.Graph/) -- English (en-US) +The Enterprise Calendar Bot uses packages to extend its capabilities. [Learn more](https://aka.ms/ComponentTemplateDocumentation) -## Azure Resource Deployment +### Required Azure resources -This template requires the following Azure resources: -- Azure Bot Registration configured with Microsoft Azure Active Directory authentication with access to the following scopes: +- Azure Bot Service Registration configured with Microsoft Azure Active Directory authentication with access to the following scopes: - Calendars.ReadWrite - Contacts.Read - People.Read - User.ReadBasic.All -- [Language Understanding (LUIS)][luis] authoring resource - -## Using this template - -### From Composer +- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice -From Composer you'll use the **New** button on the **Home** screen to create a new bot. After creation, Composer will guide you through setting up your bot. If you'd like to extend your bot with code, you can open up your bot using your favorite IDE (like Visual Studio) from the location you choose during the creation flow. +### Supported languages -### From the command-line - -This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). +- English (en-US) -## License +### License [MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) diff --git a/generators/generator-bot-enterprise-people/README.md b/generators/generator-bot-enterprise-people/README.md index 663ececabe..2f76a38120 100644 --- a/generators/generator-bot-enterprise-people/README.md +++ b/generators/generator-bot-enterprise-people/README.md @@ -1,46 +1,38 @@ # @microsoft/generator-bot-enterprise-people [![NPM version][npm-image]][npm-url] -This template creates a bot configured to search for users in an Azure Active Directory using Microsoft Graph. **[Learn more](https://aka.ms/EnterprisePeopleBot)** +A bot with the ability to interact with Office 365 users in an Azure Active Directory using Microsoft Graph. [Learn more](https://aka.ms/EnterprisePeopleBot) -## What this template is for +### Recommended use -Use this template if you want to... +- Create a sophisticated bot that enables customers to interact with Azure Active Directory using Microsoft Graph +- Customize and extend sophisticated example dialogs, bot logic, language understanding and bot responses -- Support searching for Azure Active Directory users -- Start from an advanced template including dialogs, language understanding, and language generation +### Included capabilities -## Packages +- Search and interact with Office 365 users in an Azure Active Directory using Microsoft Graph -This bot uses the [Azure Bot Framework component model](https://aka.ms/ComponentTemplateDocumentation) to extend its base functionality. The following packages come pre-installed: -- [Microsoft.Bot.Components.Graph](https://www.nuget.org/packages/Microsoft.Bot.Components.Graph/) +### Included packages -## Supported Languages +- [Microsoft Graph](https://www.nuget.org/packages/Microsoft.Bot.Components.Graph/) -- English (en-US) +The Enterprise People Bot uses packages to extend its capabilities. [Learn more](https://aka.ms/ComponentTemplateDocumentation) -## Azure Resource Deployment +### Required Azure resources -This template requires the following Azure resources: -- Azure Bot Registration configured with Microsoft Azure Active Directory authentication with access to the following scopes: +- Azure Bot Service Registration configured with Microsoft Azure Active Directory authentication with access to the following scopes: - Contacts.Read - Directory.Read.All - People.Read - People.Read.All - User.ReadBasic.All - User.Read.All -- [Language Understanding (LUIS)][luis] authoring resource - -## Using this template - -### From Composer +- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice -From Composer you'll use the **New** button on the **Home** screen to create a new bot. After creation, Composer will guide you through setting up your bot. If you'd like to extend your bot with code, you can open up your bot using your favorite IDE (like Visual Studio) from the location you choose during the creation flow. +### Supported languages -### From the command-line - -This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). +- English (en-US) -## License +### License [MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) diff --git a/generators/generator-bot-enterprise-people/generators/app/templates/README.md b/generators/generator-bot-enterprise-people/generators/app/templates/README.md index 4c83471793..91ebc9654e 100644 --- a/generators/generator-bot-enterprise-people/generators/app/templates/README.md +++ b/generators/generator-bot-enterprise-people/generators/app/templates/README.md @@ -1,8 +1,8 @@ # Welcome to your new bot -This Bot Project was created using the **[Enterprise People Bot](https://aka.ms/EnterprisePeopleBot)** template. You **must complete the configuration steps outlined below for your bot to function.** +This bot project was created using the [Enterprise People Bot](https://aka.ms/EnterprisePeopleBot) template. You **must complete the configuration steps outlined below for your bot to function.** -## Configure your Enterprise Assistant +## Configure your Enterprise People Bot To test this bot locally, complete the steps in the **[Enterprise People Bot Tutorial](https://aka.ms/CreatePeopleBot)**. ## Next steps diff --git a/generators/generator-bot-template-generator/README.md b/generators/generator-bot-template-generator/README.md index 50fe546d71..29dce62c2b 100644 --- a/generators/generator-bot-template-generator/README.md +++ b/generators/generator-bot-template-generator/README.md @@ -1,4 +1,4 @@ -# bot-template-generator +# bot-template-generator [![NPM version][npm-image]][npm-url] Yeoman generator generating a bot template generator for use with the Microsoft Bot Framework. @@ -13,7 +13,7 @@ Yeoman generator generating a bot template generator for use with the Microsoft - Navigate to the root dir of your local version of `generator-bot-template-generator` and run `npm install` - Navigate to the directory where you want to instantiate your bot template generator and run `yo {path to your local versions of generator-bot-template-generator's ./app/index.js file}` - - OR run npm link within the root of the `generator-bot-template-generator` directory and then navigate to where you want to instantiate your bot and run `yo bot-template-generator` + - OR run npm link within the root of the `generator-bot-template-generator` directory and then navigate to where you want to instantiate your bot and run `yo bot-template-generator` ## Commands @@ -37,7 +37,7 @@ All you need to know from a yeomen perspective is that yeomen will run the boots **Thats it! A template is just a list of dependent component packages (declared in index.js) and the glue/routing logic for those packages (bot files in the templates dir)** -For this particular empty bot template in the image above, little post generation config is needed because the tool defaults to generating an empty bot template. However more advanced templates will need some post creation config outlined in the next step. +For this particular empty bot template in the image above, little post generation config is needed because the tool defaults to generating an empty bot template. However more advanced templates will need some post creation config outlined in the next step. ## How to populate your bot specific assets @@ -87,3 +87,6 @@ After making the change, run `yarn build:server` followed by `yarn start:dev`. Y [npm]: https://npmjs.com [nodejs]: https://nodejs.org/ [license]: https://github.com/microsoft/botframework-components/blob/main/LICENSE +[npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive.svg +[npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-adaptive +