Skip to content

Commit 606c320

Browse files
committed
[CogSvcs] QnA Set -> Pair - 2
1 parent 1d67916 commit 606c320

File tree

8 files changed

+31
-31
lines changed

8 files changed

+31
-31
lines changed

articles/cognitive-services/QnAMaker/Concepts/question-answer-set.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The **optional** settings for a set include:
2828

2929
## Editorially add to knowledge base
3030

31-
If you do not have pre-existing content to populate the knowledge base, you can add QnA sets editorially in the QnA Maker portal. Learn how to update your knowledge base [here](../How-To/edit-knowledge-base.md).
31+
If you do not have pre-existing content to populate the knowledge base, you can add QnA pairs editorially in the QnA Maker portal. Learn how to update your knowledge base [here](../How-To/edit-knowledge-base.md).
3232

3333
## Editing your knowledge base locally
3434

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

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ ms.topic: conceptual
55
ms.date: 03/19/2020
66
---
77

8-
# Edit QnA sets in your knowledge base
8+
# Edit QnA pairs in your knowledge base
99

1010
QnA Maker allows you to manage the content of your knowledge base by providing an easy-to-use editing experience.
1111

12-
QnA sets are added from a datasource, such as a file or URL, or added as an editorial source. An editorial source indicates the QnA set was added in the QnA portal manually. All QnA sets are available for editing.
12+
QnA pairs are added from a datasource, such as a file or URL, or added as an editorial source. An editorial source indicates the QnA pair was added in the QnA portal manually. All QnA pairs are available for editing.
1313

14-
## Add an editorial QnA set
15-
1. Sign in to the [QnA portal](https://www.qnamaker.ai/), then select the knowledge base to add the QnA set to.
16-
1. On the **EDIT** page of the knowledge base, select **Add QnA set** to add a new QnA set.
14+
## Add an editorial QnA pair
15+
1. Sign in to the [QnA portal](https://www.qnamaker.ai/), then select the knowledge base to add the QnA pair to.
16+
1. On the **EDIT** page of the knowledge base, select **Add QnA pair** to add a new QnA pair.
1717

18-
1. In the new QnA set row, add the required **Question** and **Answer** fields. The other fields are optional. All fields can be changed at any time.
18+
1. In the new QnA pair row, add the required **Question** and **Answer** fields. The other fields are optional. All fields can be changed at any time.
1919

2020
1. Optionally, add **alternate phrasing**. Alternate phrasing is any form of the question that is significantly different from the original question but should provide the same answer.
2121

@@ -25,42 +25,42 @@ QnA sets are added from a datasource, such as a file or URL, or added as an edit
2525

2626
1. Optionally, add **follow-up prompts**. Follow-up prompts provide additional conversation paths to the client application to present to the user.
2727

28-
1. Select **Save and train** to see predictions including the new QnA set.
28+
1. Select **Save and train** to see predictions including the new QnA pair.
2929

30-
## Edit a QnA set
30+
## Edit a QnA pair
3131

32-
Any field in any QnA set can be edited, regardless of the original data source. Some fields may not be visible due to your current **View Options** settings, found in the context tool bar.
32+
Any field in any QnA pair can be edited, regardless of the original data source. Some fields may not be visible due to your current **View Options** settings, found in the context tool bar.
3333

34-
## Delete a QnA set
34+
## Delete a QnA pair
3535

3636
To delete a QnA, click the **delete** icon on the far right of the QnA row. This is a permanent operation. It can't be undone. Consider exporting your KB from the **Publish** page before deleting sets.
3737

38-
![Delete QnA set](../media/qnamaker-how-to-edit-kb/delete-qnapair.png)
38+
![Delete QnA pair](../media/qnamaker-how-to-edit-kb/delete-qnapair.png)
3939

40-
## Find the QnA set ID
40+
## Find the QnA pair ID
4141

42-
If you need to find the QnA set ID, you can find it in two places:
42+
If you need to find the QnA pair ID, you can find it in two places:
4343

44-
* Hover on the delete icon on the QnA set row you are interested in. The hover text includes the QnA set ID.
45-
* Export the knowledge base. Each QnA set in the knowledge base includes the QnA set ID.
44+
* Hover on the delete icon on the QnA pair row you are interested in. The hover text includes the QnA pair ID.
45+
* Export the knowledge base. Each QnA pair in the knowledge base includes the QnA pair ID.
4646

4747
## Add alternate questions
4848

49-
Add alternate questions to an existing QnA set to improve the likelihood of a match to a user query.
49+
Add alternate questions to an existing QnA pair to improve the likelihood of a match to a user query.
5050

5151
![Add Alternate Questions](../media/qnamaker-how-to-edit-kb/add-alternate-question.png)
5252

53-
## Linking QnA Sets
53+
## Linking QnA pairs
5454

55-
Linking QnA sets is provided with [follow-up prompts](multiturn-conversation.md). This is a logical connection between QnA sets, managed at the knowledge base level. You can edit follow-up prompts in the QnA Maker portal.
55+
Linking QnA pairs is provided with [follow-up prompts](multiturn-conversation.md). This is a logical connection between QnA pairs, managed at the knowledge base level. You can edit follow-up prompts in the QnA Maker portal.
5656

57-
You can't link QnA sets in the answer's metadata.
57+
You can't link QnA pairs in the answer's metadata.
5858

5959
## Add metadata
6060

6161
Add metadata sets by first selecting **View options**, then selecting **Show metadata**. This displays the metadata column. Next, select the **+** sign to add a metadata set. This set consists of one key and one value.
6262

63-
## Save changes to the QnA sets
63+
## Save changes to the QnA pairs
6464

6565
Periodically select **Save and train** after making edits to avoid losing changes.
6666

articles/cognitive-services/QnAMaker/How-To/manage-knowledge-bases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,5 +102,5 @@ If you share your knowledge base with collaborators,](collaborate-knowledge-base
102102

103103
Learn about [managing the language](language-knowledge-base.md) of all knowledge bases in a resource.
104104

105-
* Edit QnA sets
105+
* Edit QnA pairs
106106
* Manage Azure resources used by QnA Maker

articles/cognitive-services/QnAMaker/Quickstarts/add-question-metadata-portal.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Once a knowledge base is created, add question and answer (QnA) sets with metada
2222
|#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`|
2323
|#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`|
2424

25-
Once metadata is added to a QnA set, the client application can:
25+
Once metadata is added to a QnA pair, the client application can:
2626

2727
* Request answers that only match certain metadata.
2828
* Receive all answers but post-process the answers depending on the metadata for each answer.
@@ -40,7 +40,7 @@ Once metadata is added to a QnA set, the client application can:
4040

4141
## Add additional alternatively-phrased questions
4242

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.
43+
The current knowledge base has the QnA Maker troubleshooting QnA pairs. These sets were created when the URL was added to the knowledge base during the creation process.
4444

4545
When this URL was imported, only one question with one answer was created. In this procedure, add additional questions.
4646

@@ -77,7 +77,7 @@ Adding metadata to a question and answer set allows your client application to r
7777

7878
1. Select **View options**, then select **Show metadata**.
7979

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`.
80+
1. For the QnA pair you just added, select **Add metadata tags**, then add the name of `service` and the value of `search`. It looks like this: `service:search`.
8181

8282
1. Add another metadata tag with name of `link_in_answer` and value of `false`. It looks like this: `link_in_answer:false`.
8383

articles/cognitive-services/QnAMaker/Quickstarts/batch-testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Use the following chart to understand how to find the field values for optional
144144
|Charge your Surface Pro 4|
145145
|Check the battery level|
146146

147-
Two QnA sets have the metadata set.
147+
Two QnA pairs have the metadata set.
148148

149149
> [!TIP]
150150
> To see the metadata and QnA IDs of each set, export the knowledge base. Select the **Settings** page, then select **Export** as a `.xls` file. Find this downloaded file and open with Excel reviewing for metadata and ID.
@@ -164,7 +164,7 @@ There are two main scenarios for batch testing:
164164

165165
The following procedure assumes the scenario is to process chat logs with
166166

167-
1. Create a new batch test file to include optional data, `batch-test-data-2.tsv`. Add the 6 rows from the original batch test input file, then add the metadata, top, and QnA set ID for each row.
167+
1. Create a new batch test file to include optional data, `batch-test-data-2.tsv`. Add the 6 rows from the original batch test input file, then add the metadata, top, and QnA pair ID for each row.
168168

169169
To simulate the automated process of checking new text from chat logs against the knowledge base, set the metadata for each column to the same value: `topic:power`.
170170

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ When you make changes to the knowledge base and republish, you don't need to tak
131131

132132
## What did you accomplish?
133133

134-
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.
134+
You created a new knowledge base, added a public URL to the knowledge base, added your own QnA pair, trained, tested, and published the knowledge base.
135135

136136
After publishing the knowledge base, you created a bot, and tested the bot.
137137

articles/cognitive-services/QnAMaker/includes/quickstart-test-tool-curl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ This cURL-based quickstart walks you through getting an answer from your knowled
2929
Use the knowledge base from the previous quick to query for an answer based on metadata.
3030

3131
1. From the knowledge base's **Settings** page, select the **CURL** tab to see an example cURL command used to generate an answer from the knowledge base.
32-
1. Copy the command to an editable environment (such as a text file) so you can edit the command. Edit the question value as follows so that the metadata of `service:qna_maker` is used as a filter for the QnA sets.
32+
1. Copy the command to an editable environment (such as a text file) so you can edit the command. Edit the question value as follows so that the metadata of `service:qna_maker` is used as a filter for the QnA pairs.
3333

3434
```bash
3535
curl -X POST https://replace-with-your-resource-name.azurewebsites.net/qnamaker/knowledgebases/replace-with-your-knowledge-base-id/generateAnswer -H "Authorization: EndpointKey replace-with-your-endpoint-key" -H "Content-type: application/json" -d "{'top':30, 'question':'size','strictFilters': [{'name':'service','value':'qna_maker'}]}"
3636
```
3737

38-
The question is just a single word, `size`, which can return either of the two QnA sets. The `strictFilters` array tells the response to reduce to just the `qna_maker` answers.
38+
The question is just a single word, `size`, which can return either of the two QnA pairs. The `strictFilters` array tells the response to reduce to just the `qna_maker` answers.
3939

4040
1. The response includes only the answer that meets the filter criteria. The following cURL response has been formatted for readability:
4141

articles/cognitive-services/QnAMaker/includes/quickstart-test-tool-postman.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Use this procedure to configure Postman, then read each subsequent section to co
4444

4545
## Use metadata to filter answer
4646

47-
In a previous quickstart, metadata was added to two QnA sets to distinguish between two different questions. Add the metadata to the query to restrict the filter to just the relevant QnA set.
47+
In a previous quickstart, metadata was added to two QnA pairs to distinguish between two different questions. Add the metadata to the query to restrict the filter to just the relevant QnA pair.
4848

4949
1. In Postman, change only the query JSON by adding the `strictFilters` property with the name/value pair of `service:qna_maker`. The body JSON should be:
5050

0 commit comments

Comments
 (0)