次の方法で共有


QnA Maker の回答テキストでサポートされるマークダウン形式

QnA Maker では、回答テキストがマークダウンとして格納されます。 マークダウンには、さまざまな決まりごとがあります。 回答テキストを確実に取得して正しく表示するために、このリファレンスをご利用ください。

Markdown の検証については、 CommonMark のチュートリアルをご覧ください。 チュートリアルには、コピー/貼り付けで簡単に検証するための [Try it](試してみる) 機能があります。

リッチテキスト編集を使用する場合と Markdown を使用する場合の比較

回答のリッチテキスト編集では、作成者は、書式設定ツールバーを使用して、テキストをすばやく選択し、書式設定することができます。

Markdown は、CI/CD パイプラインの一部として、またはバッチ テストのためにインポートされるナレッジ ベースを作成するために、コンテンツを自動生成する必要がある場合に適しています。

サポートされるマークダウン形式

QnA Maker の回答テキストで使用できるマークダウン形式の一覧を次に示します。

目的 Format マークダウンの例 表示
チャット ボットの表示
2 つの文の間の改行。 \n\n How can I create a bot with \n\n QnA Maker? 2 つの文の間の改行を書式設定する
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
マークダウン ヘッダーを使用した書式設定
マークダウン ヘッダー H1 から H5 を使用した書式設定
斜体 *text* How do I create a bot with *QnA Maker*? 斜体を使用した書式設定
強調 (太字) **text** How do I create a bot with **QnA Maker**? 太字の強力なマーキングを使用した書式設定
リンクの URL [text](https://www.my.com) How do I create a bot with [QnA Maker](https://www.qnamaker.ai)? URL (ハイパーリンク) の書式設定
\* 公開画像の 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) 公開画像の URL の書式設定
取り消し線 ~~text~~ some ~~questoins~~ questions need to be asked 取り消し線の書式設定
太字と斜体 ***text*** How can I create a ***QnA Maker*** bot? 太字と斜体の書式設定
リンクの太字の URL [**text**](https://www.my.com) How do I create a bot with [**QnA Maker**](https://www.qnamaker.ai)? 太字の URL の書式設定
リンクの斜体の URL [*text*](https://www.my.com) How do I create a bot with [*QnA Maker*](https://www.qnamaker.ai)? 斜体の URL の書式設定
マークダウン記号のエスケープ \*text\* How do I create a bot with \*QnA Maker\*? マークダウン記号のエスケープの形式。
番号付きリスト \n 1. item1 \n 1. item2 This is an ordered list: \n 1. List item 1 \n 1. List item 2
上の例では、マークダウンに組み込まれた自動番号付けを使用しています。
This is an ordered list: \n 1. List item 1 \n 2. List item 2
上の例では明示的な番号付けを使用しています。
番号付きリストの書式設定
記号付きリスト \n * item1 \n * item2
or
\n - item1 \n - item2
This is an unordered list: \n * List item 1 \n * List item 2 記号付きリストの書式設定
入れ子になったリスト \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
入れ子になった記号付きリストの書式設定
入れ子になった番号付きリストの書式設定

\* QnA Maker ではどのような方法でも画像は処理されません。 画像をレンダリングするのはクライアント アプリケーションの役割です。

ナレッジベースの更新または置換 API を使用してコンテンツを追加する場合で、なおかつ、コンテンツまたはファイルに html タグが含まれている場合は、タグの開始と終了がエンコードされた形式に変換されるようにすることで、ファイル内の HTML を維持できます。

HTML の維持 API 要求での表記 KB での表記
はい
<br>
はい

header

<h3>header</h3>

さらに、CR LF (\r\n) は KB では \n に変換されます。 LF (\n) はそのまま維持されます。 \t や \n のようなエスケープ シーケンスをエスケープする場合は、円記号を使用できます。例: '\\r\\n' および '\\t'

次のステップ

バッチ テストのファイル形式について確認する