Skip to content

Commit 1f771cf

Browse files
authored
Merge pull request #110408 from diberry/diberry/0406-qna-public-issue-51787
[Cogsvcs] QnA Maker - public issue 51787
2 parents 5905e96 + c82f2c5 commit 1f771cf

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

articles/cognitive-services/QnAMaker/reference-document-format-guidelines.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Import document format guidelines - QnA Maker
33
description: Understand how the types of URLs are used to import and create QnA sets.
44
ms.topic: reference
5-
ms.date: 01/02/2020
5+
ms.date: 04/06/2020
66
---
77

88
# Format guidelines for imported documents and URLs
@@ -15,6 +15,8 @@ After importing a file or URL, QnA Maker converts and stores your content in the
1515

1616
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.
1717

18+
See a full list of [content types and examples](./Concepts/content-types.md#file-and-url-data-types).
19+
1820
## Basic document formatting
1921

2022
QnA Maker identifies sections and subsections and relationships in the file based on visual clues like:
@@ -24,12 +26,6 @@ QnA Maker identifies sections and subsections and relationships in the file base
2426
* numbering
2527
* colors
2628

27-
|Document examples|
28-
|--|
29-
||
30-
31-
32-
3329
## Product manuals
3430

3531
A manual is typically guidance material that accompanies a product. It helps the user to set up, use, maintain, and troubleshoot the product. When QnA Maker processes a manual, it extracts the headings and subheadings as questions and the subsequent content as answers. See an example [here](https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf).
@@ -111,7 +107,8 @@ Importing a knowledge base replaces the content of the existing knowledge base.
111107
* First character of heading must be capitalized.
112108
* Do not end a heading with a question mark, `?`.
113109

110+
**Sample documents**:<br>[Surface Pro (docx)](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/qna-maker/data-source-formats/multi-turn.docx)<br>[Contoso Benefits (docx)](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/qna-maker/data-source-formats/Multiturn-ContosoBenefits.docx)<br>[Contoso Benefits (pdf)](https://github.com/Azure-Samples/cognitive-services-sample-data-files/blob/master/qna-maker/data-source-formats/Multiturn-ContosoBenefits.pdf)
111+
112+
## Next steps
114113

115-
|Document examples|
116-
|--|
117-
||
114+
See a full list of [content types and examples](./Concepts/content-types.md#file-and-url-data-types)

0 commit comments

Comments
 (0)