Формат Markdown, поддерживаемый в тексте ответов QnA Maker

  • Статья

QnA Maker хранит текст ответов в формате Markdown. Существует много видов формата Markdown. Чтобы убедиться, что текст ответа возвращается и отображается правильно, используйте этот справочник.

Используйте CommonMark для проверки Markdown. Руководство содержит функцию Попробовать для быстрой проверки копирования и вставки.

Когда следует использовать редактирование форматированного текста и Markdown

Редактирование форматированного текста ответов позволяет автору использовать панель инструментов форматирования для быстрого выделения и форматирования текста.

Markdown лучше использовать, когда необходимо автоматически создавать содержимое для баз знаний и импортировать его в рамках конвейера CI/CD или для пакетного тестирования.

Поддерживаемый формат Markdown

Ниже приведен список форматов Markdown, которые можно использовать в тексте ответов QnA Maker.

Характер использования Формат Пример разметки Отрисовка
как отображается в чат-боте
Новая строка между двумя предложениями. \n\n How can I create a bot with \n\n QnA Maker? format new line between two sentences
Заголовки от H1 до H6, количество # определяет, какой заголовок будет использоваться. 1 # — это 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...

\n# my h1 \n## my h2\n### my h3 \n#### my h4 \n##### my h5		 format with markdown headers
format with markdown headers H1 to H5
Курсив *text* How do I create a bot with *QnA Maker*? format with italics
Полужирный **text** How do I create a bot with **QnA Maker**? format with strong marking for bold
URL-адрес для ссылки [text](https://www.my.com) How do I create a bot with [QnA Maker](https://www.qnamaker.ai)? format for URL (hyperlink)
* URL-адрес для общедоступного образа. ![text](https://www.my.com/image.png) How can I create a bot with ![QnAMaker](https://review.learn.microsoft.com/azure/ai-services/qnamaker/media/qnamaker-how-to-key-management/qnamaker-resource-list.png) format for public image URL
Зачеркнутый ~~text~~ some ~~questoins~~ questions need to be asked format for strikethrough
Полужирный и курсив ***text*** How can I create a ***QnA Maker*** bot? format for bold and italics
URL-адрес полужирным шрифтом для ссылки [**text**](https://www.my.com) How do I create a bot with [**QnA Maker**](https://www.qnamaker.ai)? format for bold URL
URL-адрес курсивом для ссылки [*text*](https://www.my.com) How do I create a bot with [*QnA Maker*](https://www.qnamaker.ai)? format for italics URL
Escape-символы Markdown \*text\* How do I create a bot with \*QnA Maker\*? Format for escape markdown symbols.
Упорядоченный список \n 1. item1 \n 1. item2 This is an ordered list: \n 1. List item 1 \n 1. List item 2
В предыдущем примере используется автоматическая нумерация, встроенная в Markdown.
This is an ordered list: \n 1. List item 1 \n 2. List item 2
В предыдущем примере используется явная нумерация.		 format for ordered list
Неупорядоченный список \n * item1 \n * item2
or
\n - item1 \n - item2		 This is an unordered list: \n * List item 1 \n * List item 2 format for unordered list
Вложенные списки \n * Parent1 \n\t * Child1 \n\t * Child2 \n * Parent2

\n * Parent1 \n\t 1. Child1 \n\t * Child2 \n 1. Parent2

Упорядоченные и неупорядоченные списки можно превращать во вложенные. Вкладка \t указывает уровень отступа дочернего элемента.		 This is an unordered list: \n * List item 1 \n\t * Child1 \n\t * Child2 \n * List item 2

This is an ordered nested list: \n 1. Parent1 \n\t 1. Child1 \n\t 1. Child2 \n 1. Parent2		 format for nested unordered list
format for nested ordered list

* QnA Maker никак не обрабатывает изображение. Отображать изображение должно клиентское приложение.

Если необходимо добавить содержимое с помощью API обновления или замены базы знаний, а содержимое или файл содержит теги HTML, можно оставить HTML в файле, убедившись, что открытие и закрытие тегов преобразуются в закодированном формате.

Сохранение HTML Представление в запросе API Представление в базе знаний
Да < br> <Br>
Да < h3> header <h3>header</h3>

Кроме того, CR LF (\r\n) преобразуется в \n в базе знаний. LF(\n) сохраняется как есть. Если вы хотите экранировать любую escape-последовательность, например \t или \n, можно использовать обратную косую черту: "\\r\\n" и "\\t".

Следующие шаги

Просмотрите форматы файлов для пакетного тестирования.