Skip to content

Commit b456f66

Browse files
Merge pull request #116554 from diberry/diberry/0526-qnamaker-sets-to-pairs
[Cogsvcs] QnA Maker - set -> pair - 1
2 parents 3bfa79a + c3cefd6 commit b456f66

File tree

10 files changed

+43
-43
lines changed

10 files changed

+43
-43
lines changed

articles/cognitive-services/QnAMaker/Concepts/content-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ Learn more about the [format guidelines](../reference-document-format-guidelines
4444

4545
## Next steps
4646

47-
Understand what information is stored in a [question and answer (QnA) set](question-answer-set.md).
47+
Understand what information is stored in a [question and answer (QnA) pair](question-answer-set.md).

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Importing from data sources - QnA Maker
3-
description: A QnA Maker knowledge base consists of a set of question-and-answer (QnA) sets and optional metadata associated with each QnA pair.
3+
description: A QnA Maker knowledge base consists of a set of question-and-answer (QnA) pairs and optional metadata associated with each QnA pair.
44
ms.topic: conceptual
55
ms.date: 03/16/2020
66
---
77

88
# Importing from data sources
99

10-
A knowledge base consists of question and answer sets brought in by public URLs and files.
10+
A knowledge base consists of question and answer pairs brought in by public URLs and files.
1111

1212
## Data source locations
1313

@@ -21,7 +21,7 @@ The Chit chat QnA content set is offered as a complete content data source in se
2121

2222
## Structured data format through import
2323

24-
Importing a knowledge base replaces the content of the existing knowledge base. Import requires a structured `.tsv` file that contains questions and answer. This information helps QnA Maker group the question-answer sets and attribute them to a particular data source.
24+
Importing a knowledge base replaces the content of the existing knowledge base. Import requires a structured `.tsv` file that contains questions and answer. This information helps QnA Maker group the question-answer pairs and attribute them to a particular data source.
2525

2626
| Question | Answer | Source| Metadata (1 key: 1 value) |
2727
|-----------|---------|----|---------------------|
@@ -53,7 +53,7 @@ The **displayOrder** is numeric and the **displayText** is text that shouldn't i
5353

5454
If you are unsure how to represent your QnA pair in the `.tsv` file:
5555
* Use this [downloadable example from GitHub](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/qna-maker/data-source-formats/Structured-multi-turn-format.xlsx?raw=true)
56-
* Or create the set in the QnA Maker portal, save, then export the knowledge base for an example of how to represent the set.
56+
* Or create the pair in the QnA Maker portal, save, then export the knowledge base for an example of how to represent the pair.
5757

5858
## Next steps
5959

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
22
title: Design knowledge base - QnA Maker
3-
description: A QnA Maker knowledge base consists of a set of question-and-answer (QnA) sets and optional metadata associated with each QnA pair.
3+
description: A QnA Maker knowledge base consists of a set of question-and-answer (QnA) pairs and optional metadata associated with each QnA pair.
44
ms.topic: conceptual
55
ms.date: 01/27/2020
66
---
77

8-
# Question and answer set concepts
8+
# Question and answer pair concepts
99

10-
A knowledge base consists of question and answer (QnA) sets. Each set has one answer and a set contains all the information associated with that _answer_. An answer can loosely resemble a database row or a data structure instance.
10+
A knowledge base consists of question and answer (QnA) pairs. Each pair has one answer and a pair contains all the information associated with that _answer_. An answer can loosely resemble a database row or a data structure instance.
1111

12-
## Question and answer sets
12+
## Question and answer pairs
1313

14-
The **required** settings in a question-and-answer (QnA) set are:
14+
The **required** settings in a question-and-answer (QnA) pair are:
1515

1616
* a **question** - text of user query, used to QnA Maker's machine-learning, to align with text of user's question with different wording but the same answer
17-
* the **answer** - the set's answer is the response that's returned when a user query is matched with the associated question
17+
* the **answer** - the pair's answer is the response that's returned when a user query is matched with the associated question
1818

19-
Each set is represented by an **ID**.
19+
Each pair is represented by an **ID**.
2020

21-
The **optional** settings for a set include:
21+
The **optional** settings for a pair include:
2222

2323
* **Alternate forms of the question** - this helps QnA Maker return the correct answer for a wider variety of question phrasings
2424
* **Metadata**: Metadata are tags associated with a QnA pair and are represented as key-value pairs. Metadata tags are used to filter QnA pairs and limit the set over which query matching is performed.

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Adding chit-chat to a QnA Maker knowledge base
33
titleSuffix: Azure Cognitive Services
4-
description: Adding personal chit-chat to your bot makes it more conversational and engaging when you create a KB. QnA Maker allows you to easily add a pre-populated set of the top chit-chat, into your KB.
4+
description: Adding personal chit-chat to your bot makes it more conversational and engaging when you create a KB. QnA Maker allows you to easily add a pre-populated set of the top chit-chat, into your KB.
55
services: cognitive-services
66
author: diberry
77
manager: nitinme
@@ -15,9 +15,9 @@ ms.custom: seodec18
1515

1616
# Add Chit-chat to a knowledge base
1717

18-
Adding chit-chat to your bot makes it more conversational and engaging. The chit-chat feature in QnA maker allows you to easily add a pre-populated set of the top chit-chat, into your knowledge base (KB). This can be a starting point for your bot's personality, and it will save you the time and cost of writing them from scratch.
18+
Adding chit-chat to your bot makes it more conversational and engaging. The chit-chat feature in QnA maker allows you to easily add a pre-populated set of the top chit-chat, into your knowledge base (KB). This can be a starting point for your bot's personality, and it will save you the time and cost of writing them from scratch.
1919

20-
This dataset has about 100 scenarios of chit-chat in the voice of multiple personas, like Professional,Friendly and Witty. Choose the persona that most closely resembles your bot's voice. Given a user query, QnA Maker tries to match it with the closest known chit-chat QnA.
20+
This dataset has about 100 scenarios of chit-chat in the voice of multiple personas, like Professional,Friendly and Witty. Choose the persona that most closely resembles your bot's voice. Given a user query, QnA Maker tries to match it with the closest known chit-chat QnA.
2121

2222
Some examples of the different personalities are below. You can see all the personality [datasets](https://github.com/Microsoft/BotBuilder-PersonalityChat/tree/master/CSharp/Datasets) along with details of the personalities.
2323

@@ -52,23 +52,23 @@ Chit-chat data sets are supported in the following languages:
5252

5353

5454
## Add chit-chat during KB creation
55-
During knowledge base creation, after adding your source URLs and files, there is an option for adding chit-chat. Choose the personality that you want as your chit-chat base. If you do not want to add chit-chat, or if you already have chit-chat support in your data sources, choose **None**.
55+
During knowledge base creation, after adding your source URLs and files, there is an option for adding chit-chat. Choose the personality that you want as your chit-chat base. If you do not want to add chit-chat, or if you already have chit-chat support in your data sources, choose **None**.
5656

5757
## Add Chit-chat to an existing KB
58-
Select your KB, and navigate to the **Settings** page. There is a link to all the chit-chat datasets in the appropriate **.tsv** format. Download the personality you want, then upload it as a file source. Make sure not to edit the format or the metadata when you download and upload the file.
59-
58+
Select your KB, and navigate to the **Settings** page. There is a link to all the chit-chat datasets in the appropriate **.tsv** format. Download the personality you want, then upload it as a file source. Make sure not to edit the format or the metadata when you download and upload the file.
59+
6060
![Add chit-chat to existing KB](../media/qnamaker-how-to-chit-chat/add-chit-chat-dataset.png)
6161

6262
## Edit your chit-chat questions and answers
63-
When you edit your KB, you will see a new source for chit-chat, based on the personality you selected. You can now add altered questions or edit the responses, just like with any other source.
63+
When you edit your KB, you will see a new source for chit-chat, based on the personality you selected. You can now add altered questions or edit the responses, just like with any other source.
6464

6565
![Edit chit-chat QnAs](../media/qnamaker-how-to-chit-chat/edit-chit-chat.png)
6666

6767
To view the metadata, select **View Options** in the toolbar, then select **Show metadata**.
6868

6969
## Add additional chit-chat questions and answers
70-
You can add new chit-chat QnA that is not in the predefined set. Ensure that you are not duplicating a QnA pair that is already covered in the chit-chat set. When you add any new chit-chat QnA, it gets added to your **Editorial** source. To ensure the ranker understands that this is chit-chat, add the metadata key/value pair "Editorial: chitchat", as seen in the following image:
71-
70+
You can add a new chit-chat QnA pair that is not in the predefined data set. Ensure that you are not duplicating a QnA pair that is already covered in the chit-chat set. When you add any new chit-chat QnA, it gets added to your **Editorial** source. To ensure the ranker understands that this is chit-chat, add the metadata key/value pair "Editorial: chitchat", as seen in the following image:
71+
7272
![![Add chit-chat QnAs](../media/qnamaker-how-to-chit-chat/add-new-chit-chat.png)](../media/qnamaker-how-to-chit-chat/add-new-chit-chat.png#lightbox)
7373

7474
## Delete chit-chat from an existing KB
@@ -81,6 +81,6 @@ Select your KB, and navigate to the **Settings** page. Your specific chit-chat s
8181
> [!div class="nextstepaction"]
8282
> [Import a knowledge base](../Tutorials/migrate-knowledge-base.md)
8383
84-
## See also
84+
## See also
8585

8686
[QnA Maker overview](../Overview/overview.md)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Any field in any QnA pair can be edited, regardless of the original data source.
7979

8080
## Delete a QnA pair
8181

82-
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.
82+
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 pairs.
8383

8484
![Delete QnA pair](../media/qnamaker-how-to-edit-kb/delete-qnapair.png)
8585

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Metadata with GenerateAnswer API - QnA Maker
33
titleSuffix: Azure Cognitive Services
4-
description: QnA Maker lets you add metadata, in the form of key/value pairs, to your question/answer sets. You can filter results to user queries, and store additional information that can be used in follow-up conversations.
4+
description: QnA Maker lets you add metadata, in the form of key/value pairs, to your question/answer pairs. You can filter results to user queries, and store additional information that can be used in follow-up conversations.
55
services: cognitive-services
66
author: diberry
77
manager: nitinme
@@ -16,7 +16,7 @@ ms.author: diberry
1616

1717
To get the predicted answer to a user's question, use the GenerateAnswer API. When you publish a knowledge base, you can see information about how to use this API on the **Publish** page. You can also configure the API to filter answers based on metadata tags, and test the knowledge base from the endpoint with the test query string parameter.
1818

19-
QnA Maker lets you add metadata, in the form of key and value pairs, to your sets of questions and answers. You can then use this information to filter results to user queries, and to store additional information that can be used in follow-up conversations. For more information, see [Knowledge base](../Concepts/knowledge-base.md).
19+
QnA Maker lets you add metadata, in the form of key and value pairs, to your pairs of questions and answers. You can then use this information to filter results to user queries, and to store additional information that can be used in follow-up conversations. For more information, see [Knowledge base](../Concepts/knowledge-base.md).
2020

2121
<a name="qna-entity"></a>
2222

@@ -32,7 +32,7 @@ Each QnA entity has a unique and persistent ID. You can use the ID to make updat
3232

3333
## Get answer predictions with the GenerateAnswer API
3434

35-
You use the [GenerateAnswer API](https://docs.microsoft.com/rest/api/cognitiveservices/qnamakerruntime/runtime/generateanswer) in your bot or application to query your knowledge base with a user question, to get the best match from the question and answer sets.
35+
You use the [GenerateAnswer API](https://docs.microsoft.com/rest/api/cognitiveservices/qnamakerruntime/runtime/generateanswer) in your bot or application to query your knowledge base with a user question, to get the best match from the question and answer pairs.
3636

3737
<a name="generateanswer-endpoint"></a>
3838

@@ -191,7 +191,7 @@ Because results are required only for the restaurant "Paradise", you can set a f
191191

192192
## Use question and answer results to keep conversation context
193193

194-
The response to the GenerateAnswer contains the corresponding metadata information of the matched question and answer set. You can use this information in your client application to store the context of the previous conversation for use in later conversations.
194+
The response to the GenerateAnswer contains the corresponding metadata information of the matched question and answer pair. You can use this information in your client application to store the context of the previous conversation for use in later conversations.
195195

196196
```json
197197
{

articles/cognitive-services/QnAMaker/Overview/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ Once a QnA Maker knowledge base is published, a client application sends a quest
3535

3636
## What is a knowledge base?
3737

38-
QnA Maker [imports your content](../concepts/knowledge-base.md) into a knowledge base of question and answer sets. The import process extracts information about the relationship between the parts of your structured and semi-structured content to imply relationships between the question and answer sets. You can edit these question and answer sets or add new sets.
38+
QnA Maker [imports your content](../concepts/knowledge-base.md) into a knowledge base of question and answer pairs. The import process extracts information about the relationship between the parts of your structured and semi-structured content to imply relationships between the question and answer pairs. You can edit these question and answer pairs or add new pairs.
3939

40-
The content of the question and answer set includes:
40+
The content of the question and answer pair includes:
4141
* All the alternate forms of the question
4242
* Metadata tags used to filter answer choices during the search
4343
* Follow-up prompts to continue the search refinement
@@ -48,7 +48,7 @@ After you publish your knowledge base, a client application sends a user's quest
4848

4949
## Create, manage, and publish to a bot without code
5050

51-
The QnA Maker portal provides the complete knowledge base authoring experience. You can import documents, in their current form, to your knowledge base. These documents (such as an FAQ, product manual, spreadsheet, or web page) are converted into question and answer sets. Each set is analyzed for follow-up prompts and connected to other sets. The final _markdown_ format supports rich presentation including images and links.
51+
The QnA Maker portal provides the complete knowledge base authoring experience. You can import documents, in their current form, to your knowledge base. These documents (such as an FAQ, product manual, spreadsheet, or web page) are converted into question and answer pairs. Each pair is analyzed for follow-up prompts and connected to other pairs. The final _markdown_ format supports rich presentation including images and links.
5252

5353
Once your knowledge base is edited, publish the knowledge base to a working [Azure Web App bot](https://azure.microsoft.com/services/bot-service/) without writing any code. Test your bot in the [Azure portal](https://portal.azure.com) or download and continue development.
5454

@@ -58,7 +58,7 @@ QnA Maker's system is a layered ranking approach. The data is stored in Azure se
5858

5959
## QnA Maker improves the conversation process
6060

61-
QnA Maker provides multi-turn prompts and active learning to help you improve your basic question and answer sets.
61+
QnA Maker provides multi-turn prompts and active learning to help you improve your basic question and answer pairs.
6262

6363
**Multi-turn prompts** give you the opportunity to connect question and answer pairs. This connection allows the client application to provide a top answer and provides more questions to refine the search for a final answer.
6464

0 commit comments

Comments
 (0)