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/Concepts/data-sources-supported.md
+2-30Lines changed: 2 additions & 30 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: 09/25/2019
11
+
ms.date: 01/09/2020
12
12
ms.author: diberry
13
13
---
14
14
@@ -183,35 +183,7 @@ After importing a file or URL, QnA Maker converts and stores your content in the
183
183
184
184
If you add or edit your content directly in your knowledge base, use **markdown formatting** to create rich text content or change the markdown format content that is already in the answer. QnA Maker supports much of the markdown format to bring rich text capabilities to your content. However, the client application, such as a chat bot may not support the same set of markdown formats. It is important to test the client application's display of answers.
185
185
186
-
Following is the list of markdown formats that you can use in QnA Maker:
187
-
188
-
|Purpose|Format|Example markdown|Rendering<br>as displayed in Chat bot|
189
-
|--|--|--|--|
190
-
A new line between 2 sentences.|`\n\n`|`How can I create a bot with \n\n QnA Maker?`||
191
-
|Headers from h1 to h6, the number of `#` denotes which header. 1 `#` is the h1.|`\n# text \n## text \n### text \n####text \n#####text`|`## Creating a bot \n ...text.... \n### Important news\n ...text... \n### Related Information\n ....text...`<br><br>`\n# my h1 \n## my h2\n### my h3 \n#### my h4 \n##### my h5`|<br>|
192
-
|Italics |`*text*`|`How do I create a bot with *QnA Maker*?`||
193
-
|String (bold)|`**text**`|`How do I create a bot with **QnA Maker**?`||
194
-
|URL for link|`[text](https://www.my.com)`|`How do I create a bot with [QnA Maker](https://www.qnamaker.ai)?`||
195
-
|*URL for public image|``|`How can I create a bot with `||
196
-
|Strikethrough|`~~text~~`|`some ~~questoins~~ questions need to be asked`||
197
-
|Bold and italics|`***text***`|`How can I create a ***QnA Maker*** bot?`||
198
-
|Bold URL for link|`[**text**](https://www.my.com)`|`How do I create a bot with [**QnA Maker**](https://www.qnamaker.ai)?`||
199
-
|Italics URL for link|`[*text*](https://www.my.com)`|`How do I create a bot with [*QnA Maker*](https://www.qnamaker.ai)?`||
200
-
|Escape markdown symbols|`\*text\*`|`How do I create a bot with \*QnA Maker\*?`||
201
-
|Ordered list|`\n 1. item1 \n 1. item2`|`This is an ordered list: \n 1. List item 1 \n 1. List item 2`<br>The preceding example uses automatic numbering built into markdown.<br>`This is an ordered list: \n 1. List item 1 \n 2. List item 2`<br>The preceding example uses explicit numbering.||
202
-
|Unordered list|`\n * item1 \n * item2`<br>or<br>`\n - item1 \n - item2`|`This is an ordered list: \n * List item 1 \n * List item 2`||
203
-
|Nested lists|`\n * Parent1 \n\t * Child1 \n\t * Child2 \n * Parent2`<br><br>`\n * Parent1 \n\t 1. Child1 \n\t * Child2 \n 1. Parent2`<br><br>You can nest ordered and unordered lists together. The tab, `\t`, indicates the indentation level of the child element.|`This is an unordered list: \n * List item 1 \n\t * Child1 \n\t * Child2 \n * List item 2`<br><br>`This is an ordered nested list: \n 1. Parent1 \n\t 1. Child1 \n\t 1. Child2 \n 1. Parent2`|<br>|
204
-
205
-
*QnA Maker doesn't process the image in any way. It is the client application's role to render the image.
206
-
207
-
If you want to add content using update/replace knowledgebase APIs and the content/file contains html tags, you can preserve the HTML in your file by ensuring that opening and closing of the tags are converted in the encoded format.
208
-
209
-
| Preserve HTML | Representation in the API request | Representation in KB |
Additionally, CR LF(\r\n) are converted to \n in the KB. LF(\n) is kept as is. If you want to escape any escape sequence like a \t or \n you can use backslash, for example: '\\\\r\\\\n' and '\\\\t'
186
+
Refer to the markdown examples provided in the [QnA Maker markdown reference](../reference-markdown-format.md) for more information.
description: Following is the list of markdown formats that you can use in QnA Maker's answer text.
4
+
ms.topic: reference
5
+
ms.date: 01/09/2020
6
+
---
7
+
8
+
# Markdown format supported in QnA Maker answer text
9
+
10
+
QnA Maker stores answer text as markdown. There are many flavors of markdown. In order to make sure the answer text is returned and displayed correctly, use this reference.
11
+
12
+
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.
13
+
14
+
## Supported markdown format
15
+
16
+
Following is the list of markdown formats that you can use in QnA Maker's answer text.
17
+
18
+
|Purpose|Format|Example markdown|Rendering<br>as displayed in Chat bot|
19
+
|--|--|--|--|
20
+
A new line between 2 sentences.|`\n\n`|`How can I create a bot with \n\n QnA Maker?`||
21
+
|Headers from h1 to h6, the number of `#` denotes which header. 1 `#` is the h1.|`\n# text \n## text \n### text \n####text \n#####text`|`## Creating a bot \n ...text.... \n### Important news\n ...text... \n### Related Information\n ....text...`<br><br>`\n# my h1 \n## my h2\n### my h3 \n#### my h4 \n##### my h5`|<br>|
22
+
|Italics |`*text*`|`How do I create a bot with *QnA Maker*?`||
23
+
|String (bold)|`**text**`|`How do I create a bot with **QnA Maker**?`||
24
+
|URL for link|`[text](https://www.my.com)`|`How do I create a bot with [QnA Maker](https://www.qnamaker.ai)?`||
25
+
|*URL for public image|``|`How can I create a bot with `||
26
+
|Strikethrough|`~~text~~`|`some ~~questoins~~ questions need to be asked`||
27
+
|Bold and italics|`***text***`|`How can I create a ***QnA Maker*** bot?`||
28
+
|Bold URL for link|`[**text**](https://www.my.com)`|`How do I create a bot with [**QnA Maker**](https://www.qnamaker.ai)?`||
29
+
|Italics URL for link|`[*text*](https://www.my.com)`|`How do I create a bot with [*QnA Maker*](https://www.qnamaker.ai)?`||
30
+
|Escape markdown symbols|`\*text\*`|`How do I create a bot with \*QnA Maker\*?`||
31
+
|Ordered list|`\n 1. item1 \n 1. item2`|`This is an ordered list: \n 1. List item 1 \n 1. List item 2`<br>The preceding example uses automatic numbering built into markdown.<br>`This is an ordered list: \n 1. List item 1 \n 2. List item 2`<br>The preceding example uses explicit numbering.||
32
+
|Unordered list|`\n * item1 \n * item2`<br>or<br>`\n - item1 \n - item2`|`This is an ordered list: \n * List item 1 \n * List item 2`||
33
+
|Nested lists|`\n * Parent1 \n\t * Child1 \n\t * Child2 \n * Parent2`<br><br>`\n * Parent1 \n\t 1. Child1 \n\t * Child2 \n 1. Parent2`<br><br>You can nest ordered and unordered lists together. The tab, `\t`, indicates the indentation level of the child element.|`This is an unordered list: \n * List item 1 \n\t * Child1 \n\t * Child2 \n * List item 2`<br><br>`This is an ordered nested list: \n 1. Parent1 \n\t 1. Child1 \n\t 1. Child2 \n 1. Parent2`|<br>|
34
+
35
+
*QnA Maker doesn't process the image in any way. It is the client application's role to render the image.
36
+
37
+
If you want to add content using update/replace knowledge base APIs and the content/file contains html tags, you can preserve the HTML in your file by ensuring that opening and closing of the tags are converted in the encoded format.
38
+
39
+
| Preserve HTML | Representation in the API request | Representation in KB |
Additionally, CR LF(\r\n) are converted to \n in the KB. LF(\n) is kept as is. If you want to escape any escape sequence like a \t or \n you can use backslash, for example: '\\\\r\\\\n' and '\\\\t'
0 commit comments