Skip to content

Commit e73f3b6

Browse files
authored
Merge pull request #99201 from diberry/diberry/1217-allup-fresh
[Cogsvcs] QnA - fresh - create-pub-bot
2 parents 1531458 + 7bd7ec1 commit e73f3b6

File tree

1 file changed

+39
-26
lines changed

1 file changed

+39
-26
lines changed

articles/cognitive-services/QnAMaker/Quickstarts/create-publish-knowledge-base.md

Lines changed: 39 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: "Quickstart: Create, train, and publish knowledge base - QnA Maker"
3-
titleSuffix: Azure Cognitive Services
3+
titleSuffix: Azure Cognitive Services
44
description: This quickstart shows how to create a QnA Maker knowledge base (KB) from your own content, such as FAQs or product manuals. The QnA Maker knowledge base in this example is created from a simple FAQ webpage to answer questions on BitLocker key recovery.
55
author: diberry
66
manager: nitinme
77
services: cognitive-services
88
ms.service: cognitive-services
99
ms.subservice: qna-maker
1010
ms.topic: quickstart
11-
ms.date: 10/14/2019
11+
ms.date: 12/17/2019
1212
ms.author: diberry
1313
---
1414

@@ -31,21 +31,22 @@ Include a chit-chat personality to make your knowledge more engaging with your u
3131

3232
1. On the QnA Maker portal, select **Create a knowledge base**.
3333

34-
1. On the **Create** page, select **Create a QnA service**. You are directed to the [Azure portal](https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesQnAMaker) to set up a QnA Maker service in your subscription.
34+
1. On the **Create** page, select **Create a QnA service**. You are directed to the [Azure portal](https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesQnAMaker) to set up a QnA Maker service in your subscription.
3535

36-
1. In the QnA Maker portal, select your QnA Maker service from the drop-down lists. If you created a new QnA Maker service, be sure to refresh the page.
36+
1. In the Azure portal, create the resource. Remember your Azure Active Directory ID, Subscription, QnA resource name you selected when creating the resource.
37+
1. Return to the QnA Maker portal, refresh the web page in the portal, to continue creating your knowledge base.
3738

3839
![Screenshot of selecting a QnA Maker service knowledge base](../media/qnamaker-quickstart-kb/qnaservice-selection.png)
3940

4041
1. Name your knowledge base **My Sample QnA KB**.
4142

42-
1. Add a sample word document as a URL:
43+
1. Add a sample word document as a URL:
4344

4445
`https://docs.microsoft.com/azure/cognitive-services/qnamaker/troubleshooting`
4546

4647
1. Select `+ Add URL`.
4748

48-
1. Add **_professional_ Chit-chat** to your KB.
49+
1. Add **_professional_ Chit-chat** to your KB.
4950

5051
1. Select **Create your KB**.
5152

@@ -55,8 +56,8 @@ Include a chit-chat personality to make your knowledge more engaging with your u
5556

5657
## Add a new question and answer set
5758

58-
1. In the QnA Maker portal, on the **Edit** page, select **Add QnA pair**.
59-
1. Add the following question:
59+
1. In the QnA Maker portal, on the **Edit** page, select **+ Add QnA pair** from the context toolbar.
60+
1. Add the following question:
6061

6162
`How many Azure services are used by a knowledge base?`
6263

@@ -66,20 +67,20 @@ Include a chit-chat personality to make your knowledge more engaging with your u
6667

6768
![ Add the question as text and the answer formatted with markdown.](../media/qnamaker-create-publish-knowledge-base/add-question-and-answer.png)
6869

69-
The markdown symbol, `*`, is used for bullet points. The `\n` is used for a new line.
70+
The markdown symbol, `*`, is used for bullet points. The `\n` is used for a new line.
7071

71-
The **Edit** page shows the markdown. When you use the **Test** panel later, you will see the markdown displayed properly.
72+
The **Edit** page shows the markdown. When you use the **Test** panel later, you will see the markdown displayed properly.
7273

7374
## Save and train
7475

7576
In the upper right, select **Save and train** to save your edits and train the QnA Maker model. Edits aren't kept unless they're saved.
7677

7778
## Test the knowledge base
7879

79-
1. In the QnA Maker portal, in the upper right, select **Test** to test that the changes you made took effect.
80-
1. Enter an example user query in the textbox.
80+
1. In the QnA Maker portal, in the upper right, select **Test** to test that the changes you made took effect.
81+
1. Enter an example user query in the textbox.
8182

82-
`How many Azure services are used by a knowledge base?`
83+
`How many Azure services are used by a knowledge base?`
8384

8485
![ Enter an example user query in the textbox. ](../media/qnamaker-create-publish-knowledge-base/test-panel-in-qna-maker.png)
8586

@@ -101,45 +102,57 @@ When you publish a knowledge base, the contents of your knowledge base moves fro
101102

102103
## Create a bot
103104

104-
After publishing, you can create a bot from the **Publish** page:
105+
After publishing, you can create a bot from the **Publish** page:
105106

106-
* You can create several bots quickly, all pointing to the same knowledge base for different regions or pricing plans for the individual bots.
107-
* If you want only one bot for the knowledge base, use the **View all your bots on the Azure portal** link to view a list of your current bots.
107+
* You can create several bots quickly, all pointing to the same knowledge base for different regions or pricing plans for the individual bots.
108+
* If you want only one bot for the knowledge base, use the **View all your bots on the Azure portal** link to view a list of your current bots.
108109

109110
When you make changes to the knowledge base and republish, you don't need to take further action with the bot. It's already configured to work with the knowledge base, and works with all future changes to the knowledge base. Every time you publish a knowledge base, all the bots connected to it are automatically updated.
110111

111112
1. In the QnA Maker portal, on the **Publish** page, select **Create bot**. This button appears only after you've published the knowledge base.
112113

113114
![Screenshot of creating a bot](../media/qnamaker-create-publish-knowledge-base/create-bot-from-published-knowledge-base-page.png)
114115

115-
1. A new browser tab opens for the Azure portal, with the Azure Bot Service's creation page. Configure the Azure bot service.
116-
117-
* Don't change the following settings in the Azure portal when creating the bot. They are pre-populated for your existing knowledge base:
118-
* QnA Auth Key
119-
* App service plan and location
120-
* The bot and QnA Maker can share the web app service plan, but can't share the web app. This means the **app name** for the bot must be different from the app name for the QnA Maker service.
116+
1. A new browser tab opens for the Azure portal, with the Azure Bot Service's creation page. Configure the Azure bot service. The bot and QnA Maker can share the web app service plan, but can't share the web app. This means the **app name** for the bot must be different from the app name for the QnA Maker service.
117+
118+
* **Do**
119+
* Change bot handle - if it is not unique.
120+
* Select SDK Language. Once the bot is created, you can download the code to your local development environment and continue the development process.
121+
* **Don't**
122+
* change the following settings in the Azure portal when creating the bot. They are pre-populated for your existing knowledge base:
123+
* QnA Auth Key
124+
* App service plan and location
121125

122-
1. After the bot is created, open the **Bot service** resource.
126+
127+
1. After the bot is created, open the **Bot service** resource.
123128
1. Under **Bot Management**, select **Test in Web Chat**.
124129
1. At the chat prompt of **Type your message**, enter:
125130

126131
`Azure services?`
127132

128-
The chat bot responds with an answer from your knowledge base.
133+
The chat bot responds with an answer from your knowledge base.
129134

130135
![Enter a user query into the test web chat.](../media/qnamaker-create-publish-knowledge-base/test-web-chat.png)
131136

137+
## What did you accomplish?
138+
139+
You created a new knowledge base, added a public URL to the knowledge base, added your own QnA set, trained, tested, and published the knowledge base.
140+
141+
After publishing the knowledge base, you created a bot, and tested the bot.
142+
143+
This was all accomplished in a few minutes without having to write any code and clean the content.
144+
132145
## Clean up resources
133146

134-
Clean up the QnA Maker and Bot framework resources in the Azure portal.
147+
Clean up the QnA Maker and Bot framework resources in the Azure portal.
135148

136149
## Next steps
137150

138151
For more information:
139152

140153
* [Markdown format in answers](../concepts/data-sources-supported.md)
141154
* [Testing your markdown](../concepts/data-sources-supported.md#testing-your-markdown)
142-
* QnA Maker [data sources](../Concepts/data-sources-supported.md).
155+
* QnA Maker [data sources](../Concepts/data-sources-supported.md).
143156
* [Bot resource configuration settings](../tutorials/create-qna-bot.md).
144157

145158
> [!div class="nextstepaction"]

0 commit comments

Comments
 (0)