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
Copy file name to clipboardExpand all lines: articles/cognitive-services/QnAMaker/Quickstarts/add-question-metadata-portal.md
+20-84Lines changed: 20 additions & 84 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,60 +1,48 @@
1
1
---
2
2
title: "Quickstart: Add questions and answer in QnA Maker portal"
3
-
titleSuffix: Azure Cognitive Services
4
3
description: This quickstart shows how to add question and answer sets with metadata so your users can find the right answer to their question.
5
4
services: cognitive-services
6
5
author: diberry
7
6
manager: nitinme
8
7
ms.service: cognitive-services
9
8
ms.subservice: qna-maker
10
9
ms.topic: quickstart
11
-
ms.date: 11/22/2019
10
+
ms.date: 02/08/2020
12
11
ms.author: diberry
13
12
---
14
13
15
14
# Quickstart: Add questions and answer with QnA Maker portal
16
15
17
-
Once a knowledge base is created, add question and answer sets with metadata so your users can find the right answer to their question.
18
-
19
-
The right answer is a single answer but there can be many ways a customer could ask the question that leads to that single answer.
20
-
21
-
For example, the questions in the following table are about Azure service limits, but each has to do with a different Azure service.
16
+
Once a knowledge base is created, add question and answer (QnA) sets with metadata to filter the answer. The questions in the following table are about Azure service limits, but each has to do with a different Azure service.
22
17
23
18
<aname="qna-table"></a>
24
19
25
-
26
20
|Set|Questions|Answer|Metadata|
27
21
|--|--|--|--|
28
22
|#1|`How large a knowledge base can I create?`<br><br>`What is the max size of a knowledge base?`<br><br>`How many GB of data can a knowledge base hold?`|`The size of the knowledge base depends on the SKU of Azure search you choose when creating the QnA Maker service. Read [here](https://docs.microsoft.com/azure/cognitive-services/qnamaker/tutorials/choosing-capacity-qnamaker-deployment) for more details.`|`service=qna_maker`<br>`link_in_answer=true`|
29
23
|#2|`How many knowledge bases can I have for my QnA Maker service?`<br><br>`I selected a Azure Cognitive Search tier that holds 15 knowledge bases, but I can only create 14 - what is going on?`<br><br>`What is the connection between the number of knowledge bases in my QnA Maker service and the Azure Cognitive Search service size?`|`Each knowledge base uses 1 index, and all the knowledge bases share a test index. You can have N-1 knowledge bases where N is the number of indexes your Azure Cognitive Search tier supports.`|`service=search`<br>`link_in_answer=false`|
30
24
31
-
Once metadata is added to a question-and-answer set, the client application can:
25
+
Once metadata is added to a QnA set, the client application can:
32
26
33
27
* Request answers that only match certain metadata.
34
28
* Receive all answers but post-process the answers depending on the metadata for each answer.
35
29
36
-
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
37
30
38
31
## Prerequisites
39
32
40
-
* A QnA Maker service
41
-
* A Knowledge base created in that QnA Maker service
42
-
43
-
Both were created in the [first quickstart](../how-to/create-knowledge-base.md).
33
+
* Complete the [previous quickstart](./quickstarts/create-publish-knowledge-base.md)
44
34
45
35
## Sign in to the QnA Maker portal
46
36
47
37
1. Sign in to the [QnA Maker portal](https://www.qnamaker.ai).
48
38
49
-
1. Select your existing knowledge base. If you don't have a knowledge base, return to the [previous quickstart](../how-to/create-knowledge-base.md) and finish the steps to create your knowledge base.
39
+
1. Select your existing knowledge base from the [previous quickstart](../how-to/create-knowledge-base.md).
50
40
51
41
## Add additional alternatively-phrased questions
52
42
53
-
The current knowledge base, from the [previous quickstart](../how-to/create-knowledge-base.md), has the QnA Maker troubleshooting question and answer sets. These sets were created when the URL was added to the knowledge base during the creation process.
54
-
55
-
When this URL was imported, only one question with one answer was created.
43
+
The current knowledge base has the QnA Maker troubleshooting QnA sets. These sets were created when the URL was added to the knowledge base during the creation process.
56
44
57
-
In this procedure, add additional questions.
45
+
When this URL was imported, only one question with one answer was created. In this procedure, add additional questions.
58
46
59
47
1. From the **Edit** page, use the search textbox above the question and answer sets, to find the question `How large a knowledge base can I create?`
60
48
@@ -71,11 +59,13 @@ In this procedure, add additional questions.
71
59
72
60
`What GB size can a knowledge base be?`
73
61
74
-
The correct answer is returned in markdown format: `The size of the knowledge base depends on the SKU of Azure search you choose when creating the QnA Maker service. Read [here](https://docs.microsoft.com/azure/cognitive-services/qnamaker/tutorials/choosing-capacity-qnamaker-deployment) for more details.`
62
+
The correct answer is returned in markdown format:
63
+
64
+
`The size of the knowledge base depends on the SKU of Azure search you choose when creating the QnA Maker service. Read [here](https://docs.microsoft.com/azure/cognitive-services/qnamaker/tutorials/choosing-capacity-qnamaker-deployment) for more details.`
75
65
76
66
If you select **Inspect** under the returned answer, you can see more answers met the question but not with the same high level of confidence.
77
67
78
-
Do not add every possible combination of alternative phrasing. Turn on QnA Maker's [active learning](../how-to/improve-knowledge-base.md), this finds the alternative phrasings that will best help your knowledge base meet your users' needs.
68
+
Do not add every possible combination of alternative phrasing. When you turn on QnA Maker's [active learning](../how-to/improve-knowledge-base.md), this finds the alternative phrasings that will best help your knowledge base meet your users' needs.
79
69
80
70
1. Select **Test** again to close the test window.
81
71
@@ -87,11 +77,12 @@ Adding metadata to a question and answer set allows your client application to r
87
77
88
78
1. Select **View options**, then select **Show metadata**.
89
79
90
-
1. For the question and answer set you just added, select **Add metadata tags**, then add name of `service` and value of `search`,`service:search`.
80
+
1. For the QnA set you just added, select **Add metadata tags**, then add the name of `service` and the value of `search`. It looks like this:`service:search`.
91
81
92
-
1. Add another metadata tags with name of `link_in_answer` and value of `false`,`link_in_answer:false`.
82
+
1. Add another metadata tag with name of `link_in_answer` and value of `false`. It looks like this:`link_in_answer:false`.
93
83
94
84
1. Search for the first answer in the table, `How large a knowledge base can I create?`.
85
+
95
86
1. Add metadata pairs for the same two metadata tags:
96
87
97
88
`link_in_answer` : `true`<br>
@@ -102,71 +93,16 @@ Adding metadata to a question and answer set allows your client application to r
102
93
1. Select **Save and train** to retrain the knowledge base.
103
94
104
95
1. Select **Publish** in the top menu to go to the publish page.
105
-
1. Select the **Publish** button to publish the current knowledge base to a queryable endpoint.
106
-
1. After the knowledge base is published, select the **Curl** tab to see an example cURL command used to generate an answer from the knowledge base.
107
-
1. Copy the command to a note pad or other editable environment so you can edit the command. Edit for your own resource name, knowledge base ID and endpoint key:
96
+
1. Select the **Publish** button to publish the current knowledge base to the endpoint.
97
+
1. After the knowledge base is published, continue to the next quickstart to learn how to generate an answer from your knowledge base.
Notice the question is just a single word, `size`, which can return either question and answer set. The `strictFilters` array tells the response to reduce to just the `qna_maker` answers.
120
-
121
-
[!INCLUDE [Tip for debug property to JSON request](../includes/tip-debug-json.md)]
122
-
123
-
1. The response includes only the answer that meets the filter criteria.
124
-
125
-
The following cURL response has been formatted for readability:
126
-
127
-
```JSON
128
-
{
129
-
"answers": [
130
-
{
131
-
"questions": [
132
-
"How large a knowledge base can I create?",
133
-
"What is the max size of a knowledge base?",
134
-
"How many GB of data can a knowledge base hold?"
135
-
],
136
-
"answer": "The size of the knowledge base depends on the SKU of Azure search you choose when creating the QnA Maker service. Read [here](https://docs.microsoft.com/azure/cognitive-services/qnamaker/tutorials/choosing-capacity-qnamaker-deployment)for more details.",
If there is a question and answer set that didn't meet the search term but did meet the filter, it would not be returned. Instead, the general answer `No good match found in KB.` is returned.
161
-
162
-
Make sure to keep your metadata name and value pairs within the required limits.
99
+
## What did you accomplish?
163
100
164
-
## Clean up resources
101
+
You edited your knowledge base to support more questions and provided name/value pairs to support filtering during the search for the top answer or postprocessing, after the answer or answers are returned.
165
102
166
-
If you want to clean up and remove a Cognitive Services subscription, you can delete the resource or resource group. Deleting the resource group also deletes any other resources associated with it.
Copy file name to clipboardExpand all lines: articles/cognitive-services/QnAMaker/Quickstarts/create-publish-knowledge-base.md
+29-33Lines changed: 29 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,56 +1,50 @@
1
1
---
2
2
title: "Quickstart: Create, train, and publish knowledge base - QnA Maker"
3
-
titleSuffix: Azure Cognitive Services
4
-
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.
5
-
author: diberry
6
-
manager: nitinme
7
-
services: cognitive-services
8
-
ms.service: cognitive-services
9
-
ms.subservice: qna-maker
3
+
description: 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 QnA Maker.
10
4
ms.topic: quickstart
11
-
ms.date: 01/29/2020
12
-
ms.author: diberry
5
+
ms.date: 02/08/2020
13
6
---
14
7
15
8
# Quickstart: Create, train, and publish your QnA Maker knowledge base
16
9
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.
10
+
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 QnA Maker.
18
11
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.
16
+
> * A QnA Maker [resource](https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesQnAMaker) created in the Azure portal. Remember your Azure Active Directory ID, Subscription, QnA resource name you selected when you created the resource.
27
17
28
-
## Create a new QnA Maker knowledge base
18
+
## Create your first QnA Maker knowledge base
29
19
30
20
1. Sign in to the [QnAMaker.ai](https://QnAMaker.ai) portal with your Azure credentials.
31
21
32
-
1.On the QnA Maker portal, select **Create a knowledge base**.
22
+
1.In the QnA Maker portal, select **Create a knowledge base**.
33
23
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.
24
+
1. On the **Create** page, skip**Step 1** if you already have your QnA Maker resource.
35
25
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. Select an existing tenant, subscription, and the new resource. Select the language. This will be the language used for all knowledge bases in this QnA Maker service.
26
+
If you haven't created the resource yet, 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. Remember your Azure Active Directory ID, Subscription, QnA resource name you selected when you created the resource.
38
27
39
-
28
+
When you are done creating the resource in the Azure portal, return to the QnA Maker portal, refresh the browser page, and continue to **Step 2**.
40
29
41
-
1.Name your knowledge base **My Sample QnA KB**.
30
+
1.In **Step 3**, select your Active directory, subscription, service (resource), and the language for all knowledge bases created in the service.
42
31
43
-
1. Add a sample word document as a URL:
32
+
The extraction process takes a few minutes to read the document and identify questions and answers.
47
+
The extraction process takes a few moments to read the document and identify questions and answers.
54
48
55
49
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.
56
50
@@ -73,7 +67,7 @@ Include a chit-chat personality to make your knowledge more engaging with your u
73
67
74
68
## Save and train
75
69
76
-
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.
70
+
In the upper right, select **Save and train** to save your edits and train QnA Maker . Edits aren't kept unless they're saved.
77
71
78
72
## Test the knowledge base
79
73
@@ -140,19 +134,21 @@ You created a new knowledge base, added a public URL to the knowledge base, adde
140
134
141
135
After publishing the knowledge base, you created a bot, and tested the bot.
142
136
143
-
This was all accomplished in a few minutes without having to write any code and clean the content.
137
+
This was all accomplished in a few minutes without having to write any code or clean the content.
144
138
145
139
## Clean up resources
146
140
147
-
Clean up the QnA Maker and Bot framework resources in the Azure portal.
141
+
If you are not continuing to the next quickstart, delete the QnA Maker and Bot framework resources in the Azure portal.
148
142
149
143
## Next steps
150
144
145
+
> [!div class="nextstepaction"]
146
+
> [Add questions with metadata](add-question-metadata-portal.md)
147
+
151
148
For more information:
152
149
153
150
*[Markdown format in answers](../reference-markdown-format.md)
Copy file name to clipboardExpand all lines: articles/cognitive-services/QnAMaker/Quickstarts/get-answer-from-knowledge-base-using-url-tool.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,13 +9,14 @@ ms.service: cognitive-services
9
9
ms.subservice: qna-maker
10
10
zone_pivot_groups: URL-test-interface
11
11
ms.topic: quickstart
12
-
ms.date: 11/21/2019
12
+
ms.date: 02/08/2020
13
13
ms.author: diberry
14
14
#Customer intent: As an knowledge base manager new to the QnA Maker service, I want to get an answer from a published knowledge base using a URL tool such as Postman or cURL.
15
15
---
16
16
17
17
# Quickstart: Get an answer from knowledge base
18
18
19
+
19
20
::: zone pivot="url-test-tool-curl"
20
21
21
22
[!INCLUDE [Get answer using cURL](../includes/quickstart-test-tool-curl.md)]
0 commit comments