Skip to content
This repository has been archived by the owner on Jan 15, 2025. It is now read-only.

docs: R13 fit and finish for template README.md files #1079

Merged
merged 4 commits into from
May 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
48 changes: 17 additions & 31 deletions generators/generator-bot-core-assistant/README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
36 changes: 17 additions & 19 deletions generators/generator-bot-core-language/README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
38 changes: 13 additions & 25 deletions generators/generator-bot-core-qna/README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
31 changes: 12 additions & 19 deletions generators/generator-bot-empty/README.md
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Loading