Skip to content

Commit 0bea2b8

Browse files
authored
Merge pull request #107973 from diberry/diberry/0317-qna-rich-text-only
[Cogsvcs] Post keynote - QnA Maker - rich-text editing (only)
2 parents 92939d1 + c411a61 commit 0bea2b8

10 files changed

+67
-9
lines changed

articles/cognitive-services/QnAMaker/How-To/add-sharepoint-datasources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You can add all QnA Maker-supported [file types](../Concepts/content-types.md) f
2727

2828
![Get the SharePoint file URL by selecting the file's ellipsis menu then copying the URL.](../media/add-sharepoint-datasources/get-sharepoint-file-url.png)
2929

30-
1. In the QnA Maker portal, on the **Settings** page, [add the URL](manage-knowledge-bases.md#edit-knowledge-base) to the knowledge base.
30+
1. In the QnA Maker portal, on the **Settings** page, add the URL to the knowledge base.
3131

3232
### Images with SharePoint files
3333

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

Lines changed: 59 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,77 @@
22
title: Edit a knowledge base - QnA Maker
33
description: QnA Maker allows you to manage the content of your knowledge base by providing an easy-to-use editing experience.
44
ms.topic: conceptual
5-
ms.date: 04/06/2020
5+
ms.date: 04/15/2020
66
---
7-
87
# Edit QnA pairs in your knowledge base
98

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

1211
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.
1312

13+
<a name="add-an-editorial-qna-set"></a>
14+
1415
## Add an editorial QnA pair
16+
1517
1. Sign in to the [QnA portal](https://www.qnamaker.ai/), then select the knowledge base to add the QnA pair to.
1618
1. On the **EDIT** page of the knowledge base, select **Add QnA pair** to add a new QnA pair.
1719

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.
20+
> [!div class="mx-imgBorder"]
21+
> ![Add QnA pair](../media/qnamaker-how-to-edit-kb/add-qnapair.png)
1922
20-
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.
23+
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.
24+
25+
1. Optionally, add **[alternate phrasing](../Quickstarts/add-question-metadata-portal.md#add-additional-alternatively-phrased-questions)**. Alternate phrasing is any form of the question that is significantly different from the original question but should provide the same answer.
2126

2227
When your knowledge base is published, and you have [active learning](use-active-learning.md) turned on, QnA Maker collects alternate phrasing choices for you to accept. These choices are selected in order to increase the prediction accuracy.
2328

24-
1. Optionally, add **metadata**. To view metadata, select **View options** in the context menu. Metadata provides filters to the answers that the client application, such as a chat bot, provides.
29+
1. Optionally, add **[metadata](../Quickstarts/add-question-metadata-portal.md#add-metadata-to-filter-the-answers)**. To view metadata, select **View options** in the context menu. Metadata provides filters to the answers that the client application, such as a chat bot, provides.
2530

26-
1. Optionally, add **follow-up prompts**. Follow-up prompts provide additional conversation paths to the client application to present to the user.
31+
1. Optionally, add **[follow-up prompts](multiturn-conversation.md)**. Follow-up prompts provide additional conversation paths to the client application to present to the user.
2732

2833
1. Select **Save and train** to see predictions including the new QnA pair.
2934

35+
## Rich-text editing for answer
36+
37+
Rich-text editing of your answer text gives you markdown styling from a simple toolbar.
38+
39+
1. Select the text area for an answer, the rich-text editor toolbar displays on the QnA pair row.
40+
41+
> [!div class="mx-imgBorder"]
42+
> ![Screenshot of the rich-text editor with the question and answer of a QnA pair row.](../media/qnamaker-how-to-edit-kb/rich-text-control-qna-pair-row.png)
43+
44+
Any text already in the answer displays correctly as your user will see it from a bot.
45+
46+
1. Edit the text. Select formatting features from the rich-text editing toolbar or use the toggle feature to switch to markdown syntax.
47+
48+
> [!div class="mx-imgBorder"]
49+
> ![Use the rich-text editor to write and format text and save as markdown.](../media/qnamaker-how-to-edit-kb/rich-text-display-image.png)
50+
51+
|Rich-text editor features|Keyboard shortcut|
52+
|--|--|
53+
|Toggle between rich-text editor and markdown. `</>`|CTRL+M|
54+
|Bold. **B**|CTR+LB|
55+
|Italics, indicated with an italicized **_I_**|CTRL+I|
56+
|Unordered list||
57+
|Ordered list||
58+
|Paragraph style||
59+
|Image - add an image available from a public URL.|CTRL+G|
60+
|Add link to publicly available URL.|CTRL+K|
61+
|Emoticon - add from a selection of emoticons.|CTRL+E|
62+
|Advanced menu - undo|CTRL+Z|
63+
|Advanced menu - redo|CTRL+Y|
64+
65+
1. Add an image to the answer using the Image icon in the rich-text toolbar. The in-place editor needs the publicly accessible image URL and the alternate text for the image.
66+
67+
68+
> [!div class="mx-imgBorder"]
69+
> ![Use the rich-text editor add a publicly accessible image and its ALT text.](../media/qnamaker-how-to-edit-kb/add-image-url-alternate-text.png)
70+
71+
1. Add a link to a URL by either selecting the text in the answer, then selecting the Link icon in the toolbar or by selecting the Link icon in the toolbar then entering new text and the URL.
72+
73+
> [!div class="mx-imgBorder"]
74+
> ![Use the rich-text editor add a publicly accessible image and its ALT text.](../media/qnamaker-how-to-edit-kb/add-link-to-answer-rich-text-editor.png)
75+
3076
## Edit a QnA pair
3177

3278
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.
@@ -66,9 +112,15 @@ Periodically select **Save and train** after making edits to avoid losing change
66112

67113
![Add Metadata](../media/qnamaker-how-to-edit-kb/add-metadata.png)
68114

115+
## When to use rich-text editing versus markdown
116+
117+
[Rich-text editing](#add-an-editorial-qna-set) of answers allows you, as the author, to use a formatting toolbar to quickly select and format text.
118+
119+
[Markdown](../reference-markdown-format.md) is a better tool when you need to autogenerate content to create knowledge bases to be imported as part of a CI/CD pipeline or for [batch testing](../Quickstarts/batch-testing.md).
120+
69121
## Next steps
70122

71123
> [!div class="nextstepaction"]
72124
> [Collaborate on a knowledge base](./collaborate-knowledge-base.md)
73125
74-
* [Manage Azure resources used by QnA Maker](set-up-qnamaker-service-azure.md)
126+
* [Manage Azure resources used by QnA Maker](set-up-qnamaker-service-azure.md)
207 KB
Loading
220 KB
Loading
48 KB
Loading
537 Bytes
Loading
222 KB
Loading
198 KB
Loading
18.4 KB
Loading

articles/cognitive-services/QnAMaker/reference-markdown-format.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Markdown format - QnA Maker
33
description: Following is the list of markdown formats that you can use in QnA Maker's answer text.
44
ms.topic: reference
5-
ms.date: 01/09/2020
5+
ms.date: 03/19/2020
66
---
77

88
# Markdown format supported in QnA Maker answer text
@@ -11,6 +11,12 @@ QnA Maker stores answer text as markdown. There are many flavors of markdown. In
1111

1212
Use the **[CommonMark](https://commonmark.org/help/tutorial/index.html)** tutorial to validate your Markdown. The tutorial has a **Try it** feature for quick copy/paste validation.
1313

14+
## When to use rich-text editing versus markdown
15+
16+
[Rich-text editing](How-To/edit-knowledge-base.md#add-an-editorial-qna-set) of answers allows you, as the author, to use a formatting toolbar to quickly select and format text.
17+
18+
Markdown is a better tool when you need to autogenerate content to create knowledge bases to be imported as part of a CI/CD pipeline or for [batch testing](Quickstarts/batch-testing.md).
19+
1420
## Supported markdown format
1521

1622
Following is the list of markdown formats that you can use in QnA Maker's answer text.

0 commit comments

Comments
 (0)