You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
23
23
24
24
## Testing and updating the knowledge base
25
25
@@ -68,9 +68,4 @@ When you need to go back to a specific version, you need to import that file fro
Copy file name to clipboardExpand all lines: articles/cognitive-services/QnAMaker/How-To/metadata-generateanswer-usage.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ manager: nitinme
8
8
ms.service: cognitive-services
9
9
ms.subservice: qna-maker
10
10
ms.topic: conceptual
11
-
ms.date: 06/27/2019
11
+
ms.date: 10/02/2019
12
12
ms.author: diberry
13
13
---
14
14
@@ -244,4 +244,4 @@ You can search through the published kb, using `isTest=false`, or in the test kb
244
244
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).
245
245
246
246
> [!div class="nextstepaction"]
247
-
> [Create a knowledge base](./create-knowledge-base.md)
247
+
> [Create a knowledge base bot](../tutorials/integrate-qnamaker-luis.md)
Copy file name to clipboardExpand all lines: articles/cognitive-services/QnAMaker/Quickstarts/create-publish-knowledge-base.md
+68-29Lines changed: 68 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,77 +8,96 @@ services: cognitive-services
8
8
ms.service: cognitive-services
9
9
ms.subservice: qna-maker
10
10
ms.topic: quickstart
11
-
ms.date: 10/01/2019
11
+
ms.date: 10/04/2019
12
12
ms.author: diberry
13
13
---
14
14
15
15
# Quickstart: Create, train, and publish your QnA Maker knowledge base
16
16
17
17
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.
18
18
19
+
Include a chit-chat personality to make your knowledge more engaging with your users.
> * If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
25
27
26
-
## Create a QnA Maker knowledge base
28
+
## Create a new QnA Maker knowledge base
27
29
28
30
1. Sign in to the [QnAMaker.ai](https://QnAMaker.ai) portal with your Azure credentials.
29
31
30
32
1. On the QnA Maker portal, select **Create a knowledge base**.
31
33
32
-

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.
35
35
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.
37
37
38
38

39
39
40
-
1. In step 3, name your knowledge base **My Sample QnA KB**.
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
41
57
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:
44
60
45
-

61
+
`How many Azure services are used by a knowledge base?`
46
62
47
-
1.In step 5, select **Create your KB**.
63
+
1.Add the answer formatted with _markdown_:
48
64
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.
1. After QnA Maker successfully creates the knowledge base, the **Knowledge base** page opens. You can edit the contents of the knowledgebase on this page.
67
+

52
68
53
-
## Edit the knowledge base
69
+
The markdown symbol, `*`, is used for bullet points. The `\n` is used for a new line.
54
70
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.
56
72
57
-

73
+
## Save and train
58
74
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.
60
76
61
77
## Test the knowledge base
62
78
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.
64
81
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?`
66
83
67
-

84
+

68
85
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.
70
89
71
90
## Publish the knowledge base
72
91
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.
74
93
75
94

76
95
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.
78
97
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.
80
99
81
-

100
+

82
101
83
102
## Create a bot
84
103
@@ -93,16 +112,36 @@ When you make changes to the knowledge base and republish, you don't need to tak
93
112
94
113

95
114
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.
97
116
98
117
* Don't change the following settings in the Azure portal when creating the bot. They are pre-populated for your existing knowledge base:
99
118
* QnA Auth Key
100
119
* 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
+

103
131
132
+
## Clean up resources
133
+
134
+
Clean up the QnA Maker and Bot framework resources in the Azure portal.
104
135
105
136
## Next steps
106
137
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)
0 commit comments