Skip to content

Commit e4ee75c

Browse files
authored
Merge pull request #89779 from diberry/0925-qna-quickstart
[Cogsvcs] QnA Maker - switch quickstart
2 parents d547b61 + 871436e commit e4ee75c

File tree

11 files changed

+81
-110
lines changed

11 files changed

+81
-110
lines changed

.openpublishing.redirection.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -779,7 +779,12 @@
779779
"source_path": "articles/cognitive-services/LUIS/luis-how-to-account-settings.md",
780780
"redirect_url": "/azure/cognitive-services/LUIS/luis-how-to-azure-subscription",
781781
"redirect_document_id": false
782-
},
782+
},
783+
{
784+
"source_path": "articles/cognitive-services/QnAMaker/How-To/create-knowledge-base.md",
785+
"redirect_url": "/azure/cognitive-services/QnAMaker/Quickstarts/create-publish-knowledge-base",
786+
"redirect_document_id": false
787+
},
783788
{
784789
"source_path": "articles/cognitive-services/QnAMaker/quickstarts/csharp.md",
785790
"redirect_url": "/azure/cognitive-services/QnAMaker/quickstarts/create-publish-kb-csharp-sdk",
@@ -31706,7 +31711,7 @@
3170631711
},
3170731712
{
3170831713
"source_path": "articles/cognitive-services/QnAMaker/Guides/CreateKB.md",
31709-
"redirect_url": "/azure/cognitive-services/QnAMaker/How-To/create-knowledge-base",
31714+
"redirect_url": "/azure/cognitive-services/QnAMaker/Quickstarts/create-publish-knowledge-base",
3171031715
"redirect_document_id": false
3171131716
},
3171231717
{

articles/cognitive-services/QnAMaker/Concepts/development-lifecycle-knowledge-base.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ QnA Maker learns best in an iterative cycle of model changes, utterance examples
1919
![Authoring cycle](../media/qnamaker-concepts-lifecycle/kb-lifecycle.png)
2020

2121
## Creating a QnA Maker knowledge base
22-
QnA Maker knowledge base (KB) endpoint provides a best-match answer to a user query based on the content of the KB. Creating a knowledge base is a one-time action to setting up a content repository of questions, answers and associated metadata. A knowledge base can be created by crawling pre-existing content such as FAQ pages, product manuals or structured Q-A pairs. Learn how to [create a knowledge base](../How-To/create-knowledge-base.md).
22+
QnA Maker knowledge base (KB) endpoint provides a best-match answer to a user query based on the content of the KB. Creating a knowledge base is a one-time action to setting up a content repository of questions, answers and associated metadata. A knowledge base can be created by crawling pre-existing content such as FAQ pages, product manuals or structured Q-A pairs. Learn how to [create a knowledge base](../quickstarts/create-publish-knowledge-base.md).
2323

2424
## Testing and updating the knowledge base
2525

@@ -68,9 +68,4 @@ When you need to go back to a specific version, you need to import that file fro
6868
## Next steps
6969

7070
> [!div class="nextstepaction"]
71-
> [Confidence score](./confidence-score.md)
72-
73-
## See also
74-
75-
[Knowledge base](./knowledge-base.md)
76-
[QnA Maker overview](../Overview/overview.md)
71+
> [Confidence score](./confidence-score.md)

articles/cognitive-services/QnAMaker/How-To/create-knowledge-base.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

articles/cognitive-services/QnAMaker/How-To/metadata-generateanswer-usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: qna-maker
1010
ms.topic: conceptual
11-
ms.date: 06/27/2019
11+
ms.date: 10/02/2019
1212
ms.author: diberry
1313
---
1414

@@ -244,4 +244,4 @@ You can search through the published kb, using `isTest=false`, or in the test kb
244244
The **Publish** page also provides information to generate an answer with [Postman](../Quickstarts/get-answer-from-kb-using-postman.md) and [cURL](../Quickstarts/get-answer-from-kb-using-curl.md).
245245

246246
> [!div class="nextstepaction"]
247-
> [Create a knowledge base](./create-knowledge-base.md)
247+
> [Create a knowledge base bot](../tutorials/integrate-qnamaker-luis.md)

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

Lines changed: 68 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,77 +8,96 @@ services: cognitive-services
88
ms.service: cognitive-services
99
ms.subservice: qna-maker
1010
ms.topic: quickstart
11-
ms.date: 10/01/2019
11+
ms.date: 10/04/2019
1212
ms.author: diberry
1313
---
1414

1515
# Quickstart: Create, train, and publish your QnA Maker knowledge base
1616

1717
You can create a QnA Maker knowledge base (KB) from your own content, such as FAQs or product manuals. This article includes an example of creating a QnA Maker knowledge base from a simple FAQ webpage, to answer questions on BitLocker key recovery.
1818

19+
Include a chit-chat personality to make your knowledge more engaging with your users.
20+
1921
[!INCLUDE [Custom subdomains notice](../../../../includes/cognitive-services-custom-subdomains-note.md)]
2022

2123
## Prerequisite
2224

2325
> [!div class="checklist"]
2426
> * If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
2527
26-
## Create a QnA Maker knowledge base
28+
## Create a new QnA Maker knowledge base
2729

2830
1. Sign in to the [QnAMaker.ai](https://QnAMaker.ai) portal with your Azure credentials.
2931

3032
1. On the QnA Maker portal, select **Create a knowledge base**.
3133

32-
![Screenshot of QnA Maker portal](../media/qna-maker-create-kb.png)
33-
34-
1. On the **Create** page, in step 1, 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. If the Azure portal times out, select **Try again** on the site. After you connect, your Azure dashboard appears.
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. After you successfully create a new QnA Maker service in Azure, return to qnamaker.ai/create. Select your QnA Maker service from the drop-down lists in step 2. If you created a new QnA Maker service, be sure to refresh the page.
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.
3737

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

40-
1. In step 3, name your knowledge base **My Sample QnA KB**.
40+
1. Name your knowledge base **My Sample QnA KB**.
41+
42+
1. Add a sample word document as a URL:
43+
44+
`https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/troubleshooting`
45+
46+
1. Select `+ Add URL`.
47+
48+
1. Add **_professional_ Chit-chat** to your KB.
49+
50+
1. Select **Create your KB**.
51+
52+
The extraction process takes a few minutes to read the document and identify questions and answers.
53+
54+
After QnA Maker successfully creates the knowledge base, the **Knowledge base** page opens. You can edit the contents of the knowledge base on this page.
55+
56+
## Add a new question and answer set
4157

42-
1. To add content to your knowledge base, select three types of data sources. In step 4, under **Populate your KB**, add the
43-
[BitLocker Recovery FAQ](https://docs.microsoft.com/windows/security/information-protection/bitlocker/bitlocker-overview-and-requirements-faq) URL in the **URL** box.
58+
1. In the QnA Maker portal, on the **Edit** page, select **Add QnA pair**.
59+
1. Add the following question:
4460

45-
![Screenshot of adding data sources](../media/qnamaker-quickstart-kb/add-datasources.png)
61+
`How many Azure services are used by a knowledge base?`
4662

47-
1. In step 5, select **Create your KB**.
63+
1. Add the answer formatted with _markdown_:
4864

49-
1. While QnA Maker creates the knowledge base, a pop-up window appears. The extraction process takes a few minutes to read the HTML page and identify questions and answers.
65+
` * Azure QnA Maker service\n* Azure Search\n* Azure web app\n* Azure app plan`
5066

51-
1. After QnA Maker successfully creates the knowledge base, the **Knowledge base** page opens. You can edit the contents of the knowledge base on this page.
67+
![ Add the question as text and the answer formatted with markdown.](../media/qnamaker-create-publish-knowledge-base/add-question-and-answer.png)
5268

53-
## Edit the knowledge base
69+
The markdown symbol, `*`, is used for bullet points. The `\n` is used for a new line.
5470

55-
1. In the QnA Maker portal, on the **Edit** section, select **Add QnA pair** to add a new row to the knowledge base. Under **Question**, enter **Hi.** Under **Answer**, enter **Hello. Ask me BitLocker questions.**
71+
The **Edit** page shows the markdown. When you use the **Test** panel later, you will see the markdown displayed properly.
5672

57-
![Screenshot of QnA Maker portal](../media/qnamaker-quickstart-kb/add-qna-pair.png)
73+
## Save and train
5874

59-
1. 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.
75+
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.
6076

6177
## Test the knowledge base
6278

63-
1. In the QnA Maker portal, in the upper right, select **Test** to test that the changes you made took effect. Enter `hi there` in the box, and select Enter. You should see the answer you created as a response.
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.
6481

65-
1. Select **Inspect** to examine the response in more detail. The test window is used to test your changes to the knowledge base before they're published.
82+
`How many Azure services are used by a knowledge base?`
6683

67-
![Screenshot of test panel](../media/qnamaker-quickstart-kb/inspect.png)
84+
![ Enter an example user query in the textbox. ](../media/qnamaker-create-publish-knowledge-base/test-panel-in-qna-maker.png)
6885

69-
1. Select **Test** again to close the **Test** pop-up.
86+
1. Select **Inspect** to examine the response in more detail. The test window is used to test your changes to the knowledge base before publishing your knowledge base.
87+
88+
1. Select **Test** again to close the **Test** panel.
7089

7190
## Publish the knowledge base
7291

73-
When you publish a knowledge base, the question and answer contents of your knowledge base moves from the test index to a production index in Azure search.
92+
When you publish a knowledge base, the contents of your knowledge base moves from the `test` index to a `prod` index in Azure search.
7493

7594
![Screenshot of moving the contents of your knowledge base](../media/qnamaker-how-to-publish-kb/publish-prod-test.png)
7695

77-
1. In the QnA Maker portal, in the menu next to **Edit**, select **Publish**. Then to confirm, select **Publish** on the page.
96+
1. In the QnA Maker portal, select **Publish**. Then to confirm, select **Publish** on the page.
7897

79-
1. The QnA Maker service is now successfully published. You can use the endpoint in your application or bot code.
98+
The QnA Maker service is now successfully published. You can use the endpoint in your application or bot code.
8099

81-
![Screenshot of successful publishing](../media/qnamaker-quickstart-kb/publish-sucess.png)
100+
![Screenshot of successful publishing](../media/qnamaker-create-publish-knowledge-base/publish-knowledge-base-to-endpoint.png)
82101

83102
## Create a bot
84103

@@ -93,16 +112,36 @@ When you make changes to the knowledge base and republish, you don't need to tak
93112

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

96-
1. A new browser tab opens for the Azure portal, with the Azure Bot Service's creation page. Configure the Azure bot service. For more information on these configuration settings, see [Create a QnA Bot with Azure Bot Service v4](../tutorials/create-qna-bot.md).
115+
1. A new browser tab opens for the Azure portal, with the Azure Bot Service's creation page. Configure the Azure bot service.
97116

98117
* Don't change the following settings in the Azure portal when creating the bot. They are pre-populated for your existing knowledge base:
99118
* QnA Auth Key
100119
* App service plan and location
101-
* Azure Storage
102-
* The bot and QnA Maker can share the web app service plan, but can't share the web app. This means the **app name** must be different from the app name you used when you created the QnA Maker service.
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.
121+
122+
1. After the bot is created, open the **Bot service** resource.
123+
1. Under **Bot Management**, select **Test in Web Chat**.
124+
1. At the chat prompt of **Type your message**, enter:
125+
126+
`Azure services?`
127+
128+
The chat bot responds with an answer from your knowledge base.
129+
130+
![Enter a user query into the test web chat.](../media/qnamaker-create-publish-knowledge-base/test-web-chat.png)
103131

132+
## Clean up resources
133+
134+
Clean up the QnA Maker and Bot framework resources in the Azure portal.
104135

105136
## Next steps
106137

138+
For more information:
139+
140+
* [Markdown format in answers](../concepts/data-sources-supported.md)
141+
* [Testing your markdown](../concepts/data-sources-supported.md#testing-your-markdown)
142+
* QnA Maker [data sources](../Concepts/data-sources-supported.md).
143+
* [Bot resource configuration settings](../tutorials/create-qna-bot.md).
144+
107145
> [!div class="nextstepaction"]
108-
> [Create a knowledge base](../How-To/create-knowledge-base.md)
146+
> [Add questions with metadata](add-question-metadata-portal.md)
147+

articles/cognitive-services/QnAMaker/index.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ landingContent:
4848
- linkListType: get-started
4949
links:
5050
- text: "Quickstart: Create a new knowledge base"
51-
url: how-to/create-knowledge-base.md
51+
url: quickstarts/create-publish-knowledge-base.md
5252
- text: "Quickstart: Add questions and answer"
5353
url: quickstarts/add-question-metadata-portal.md
5454
- linkListType: how-to-guide
18.2 KB
Loading
Loading
16.8 KB
Loading
42.9 KB
Loading

0 commit comments

Comments
 (0)