インポートされたドキュメントおよび URL の形式のガイドライン

  • [アーティクル]

コンテンツに最適な結果を得るには、以下の書式設定ガイドラインを確認してください。

書式設定の考慮事項

ファイルまたは URL をインポートすると、QnA Maker によってコンテンツはマークダウン形式に変換され、保存されます。 変換プロセスによって、テキストに \n\n などの新しい行が追加されます。 マークダウン形式の知識があると、変換されたコンテンツを理解し、ナレッジ ベース コンテンツを管理するために役立ちます。

ナレッジ ベースのコンテンツを直接追加または編集する場合は、マークダウンの書式設定を使用してリッチ テキスト コンテンツを作成するか、既に回答に含まれているマークダウン形式コンテンツを変更します。 QnA Maker は多くのマークダウン形式をサポートしているため、コンテンツにリッチ テキスト機能を取り込むことができます。 ただし、チャット ボットなどのクライアント アプリケーションは、同じマークダウン形式のセットをサポートしていない場合があります。 クライアント アプリケーションの回答の表示をテストすることが重要です。

コンテンツの種類と例の完全な一覧を参照してください。

基本的なドキュメントの書式設定

QnA Maker では、次のような視覚的な手がかりに基づいて、ファイル内のセクション、サブセクション、関係を識別します。

  • フォント サイズ
  • フォント スタイル
  • 番号付け
  • 色

Note

現在、アップロードされたドキュメントからの画像の抽出はサポートされていません。

製品マニュアル

一般にマニュアルは、製品に付属するガイダンス資料です。 ユーザーにとっては、製品のセットアップ、使用、保守、トラブルシューティングにあたっての貴重な情報源となります。 QnA Maker は、マニュアルを処理する際、見出しと小見出しを質問として抽出し、質問に続くコンテンツを回答として抽出します。 こちらの例を参照してください。

次に示すのは、索引ページと階層的なコンテンツを持ったマニュアルの例です

Product Manual example for a knowledge base

Note

抽出の対象として最も適しているのは、目次やインデックス ページがあり、階層化された見出しから成る明確な構造を持ったマニュアルです。

パンフレット、ガイドライン、論文、およびその他のファイル

明確な構造とレイアウトがあれば、他の多くの種類のドキュメントも処理して QA ペアを生成することができます。 これには以下が含まれます。パンフレット、ガイドライン、レポート、ホワイト ペーパー、科学論文、ポリシー、書籍などが含まれます。こちらの例を参照してください。

次に示すのは、索引のない半構造化ドキュメントの例です。

Azure Blob storage semi-structured Doc

非構造化ドキュメントのサポート

カスタム質問と回答で、非構造化ドキュメントがサポートされるようになりました。 コンテンツが十分に定義された階層的な方法で整理されていない、設定された構造が欠落している、またはコンテンツが自由に流れるドキュメントは、非構造化ドキュメントと見なされます。

非構造化 PDF ドキュメントの例を下に示します。

Unstructured document example for a knowledge base

現在、この機能は PDF および DOC ファイル形式のドキュメントのアップロードでのみ使用できます。

重要

非構造化ファイルまたはコンテンツのサポートは、質問応答でのみご利用いただけます。

構造化 QnA ドキュメント

次に示すように、質問と回答の構造化 DOC ファイルの形式は、質問と回答を 1 行おきに並べる、つまり、1 つの質問を 1 行に記述し、次の行にその回答を記述する形式です。

Question1

Answer1

Question2

Answer2

次に示すのは、構造化 QnA Word 文書の例です。

Structured QnA document example for a knowledge base

構造化 TXT、TSV、および XLS ファイル

構造化 .txt、 .tsv、または .xls ファイル形式の QnA を QnA Maker にアップロードして、ナレッジ ベースを作成または拡張することもできます。 これらはプレーン テキストでも、RTF または HTML のコンテンツが含まれていても構いません。 QnA ペアには、QnA ペアをカテゴリにグループ化するために使用できる省略可能なメタデータ フィールドがあります。

Question Answer メタデータ (1 つのキー: 1 つの値)
質問 1 回答 1 Key1:Value1 | Key2:Value2
質問 2 回答 2 Key:Value

これより後の列は、ソース ファイルに含まれていても無視されます。

構造化された Excel ファイルの例

次に示すのは、HTML コンテンツを含む構造化 QnA .xls ファイルの例です。

Structured QnA excel example for a knowledge base

Excel ファイルにおける 1 つの回答に対する代替質問の例

以下は構造化されている QnA .xls ファイルの例です。1 つの回答に対して代替質問がいくつかあります。

Example of alternate questions for single answer in Excel file

ファイルがインポートされた後、次に示すように、質問と回答の組み合わせがナレッジ ベースに入ります。

Screenshot of alternate questions for single answer imported into knowledge base

インポートでの構造化データ形式

ナレッジ ベースをインポートすると、既にあるナレッジ ベースの内容が置き換えられます。 インポートでは、データ ソース情報を含んだ .tsv 形式の構造化ファイルが必要となります。 この情報によって、QnA Maker は質問とその回答のペアをグループ化し、その帰属先となるデータ ソースを特定することができます。 QnA ペアには、QnA ペアをカテゴリにグループ化するために使用できる省略可能なメタデータ フィールドがあります。

Question Answer source メタデータ (1 つのキー: 1 つの値)
質問 1 回答 1 URL 1 Key1:Value1 | Key2:Value2
質問 2 回答 2 編集 Key:Value

複数ターンのドキュメントの書式設定

  • 階層を示すには、見出しとサブ見出しを使用する。 たとえば、親 QnA を示すために h1、プロンプトとして使用する必要がある QnA を示すために h2 を使用できます。 後続の階層を示すには、小さい見出しサイズを使用する。 スタイル、色、その他のメカニズムを、ドキュメント内の構造を暗黙に示すために使用しないでください。QnA Maker では複数ターンのプロンプトが抽出されることはありません。
  • 見出しの最初の文字は大文字にしなくてはなりません。
  • 見出しの末尾に疑問符 ? を付けないでください。

サンプル ドキュメント:
Surface Pro (docx)
Contoso Benefits (docx)
Contoso Benefits (pdf)

FAQ URL

QnA Maker がサポートできる FAQ ページの形式は、

  • 基本的な FAQ ページ
  • リンク付き FAQ ページ
  • トピック ホームページがある FAQ ページ

基本的な FAQ ページ

これは最も一般的なタイプの FAQ ページです。質問と回答が同じページにあり、質問のすぐ下に回答が記載されます。

次に示すのは、基本的な FAQ ページの例です。

Plain FAQ page example for a knowledge base

このタイプの FAQ ページでは、質問が 1 か所に集約され、同じページ上の別のセクションまたは別のページのどちらかにある回答にリンクされます。

次に示すのは、同じページ上のセクションへのリンクがある FAQ ページの例です。

Section Link FAQ page example for a knowledge base

親トピック ページの子回答ページへのリンク

この種類の FAQ にはトピック ページがあり、各トピックが別ページの対応する質問と回答のセットにリンクされています。 QnA Maker は、リンクされているすべてのページをクロールして、対応する質問と回答を抽出します。

次に、別ページの FAQ セクションへのリンクがあるトピック ページの例を示します。

Deep link FAQ page example for a knowledge base

サポート URL

QnA Maker では、特定のタスクを実行する方法、特定の問題を診断および解決する方法、特定のプロセスに対するベスト プラクティスについて説明する Web 記事などの半構造化サポート Web ページを処理できます。 抽出が最もうまくいくのは、階層的な見出しのある明確な構造を持ったコンテンツです。

Note

サポートの記事の抽出は新機能であり、初期段階にあります。 適切に構造化された、複雑なヘッダー/フッターが含まれていないシンプルなページで最適に動作します。

QnA Maker supports extraction from semi-structured web pages where a clear structure is presented with hierarchical headings

ナレッジ ベースのインポートとエクスポート

エクスポートされたナレッジ ベースからの TSV ファイルと XLS ファイルは、QnA Maker ポータルの [設定] ページからファイルをインポートすることによってのみ使用できます。 ナレッジベースの作成中に、または [設定] ページの [+ ファイルの追加] 機能または [+ URL の追加] 機能から、それらをデータ ソースとして使用することはできません。

これらの TSV および XLS ファイルを通じてナレッジ ベースをインポートする場合、QnA ペアは、エクスポートされたナレッジ ベースでの QnA の抽出元のソースではなく、編集ソースに追加されます。

次のステップ

コンテンツの種類と例の完全な一覧を参照してください