QnA Maker コンテンツのデータ ソースData sources for QnA Maker content

QnA Maker は、Web ページ、PDF ファイル、または MS Word doc ファイルとして保存された FAQ、製品マニュアル、ガイドライン、サポート ドキュメント、ポリシーなどの半構造化コンテンツから質問と回答のペアを自動的に抽出します。QnA Maker automatically extracts question-answer pairs from semi-structured content such as FAQs, product manuals, guidelines, support documents, and policies stored as web pages, PDF files, or MS Word doc files . また、構造化 QnA コンテンツ ファイルのコンテンツをナレッジ ベースに追加することもできます。Content can also be added to the knowledge base from structured QnA content files.

次の表は、QnA Maker でサポートされているコンテンツの種類とファイル形式をまとめたものです。The table below summarizes the types of content and file formats that are supported by QnA Maker.

ソースの種類Source Type コンテンツの種類Content Type Examples
URLURL FAQFAQs
(基本、セクション付き、またはトピックのホーム ページ付き)(Flat, with sections or with a topics homepage)
サポート ページSupport pages
(単一ページのハウツー記事や、トラブルシューティングの記事など)(Single page how-to articles, troubleshooting articles etc.)
基本的な FAQPlain FAQ,
リンク付きの FAQFAQ with links,
トピック ホーム ページ付きの FAQFAQ with topics homepage
サポート記事Support article
PDF / DOCPDF / DOC FAQ、FAQs,
製品マニュアル、Product Manual,
パンフレット、Brochures,
論文、Paper,
チラシ ポリシー、Flyer Policy,
サポート ガイド、Support guide,
構造化 QnA、Structured QnA,
などetc.
Structured QnA.docStructured QnA.doc,
Sample Product Manual.pdfSample Product Manual.pdf,
Sample semi-structured.docSample semi-structured.doc,
Sample white paper.pdfSample white paper.pdf
ExcelExcel 構造化 QnA ファイルStructured QnA file
(RTF、HTML サポートなど)(including RTF, HTML support)
Sample QnA FAQ.xlsSample QnA FAQ.xls
TXT/TSVTXT/TSV 構造化 QnA ファイルStructured QnA file Sample chit-chat.tsvSample chit-chat.tsv

データ ソースの場所Data source locations

ほとんどのデータ ソースの場所には、認証を必要としないパブリック URL またはファイルを指定する必要があります。Most data source locations need to provide public URLs or files, which do not require authentication.

Sharepoint データ ソースの場所には、認証済みのファイルを指定することができます。Sharepoint data source locations are allowed to provide authenticated files. Sharepoint リソースは、Web ページではなく、ファイルになっている必要があります。Sharepoint resources must be files, not web pages.

認証済みのファイルまたは URL がある場合、別のオプションとして、認証済みのサイトからローカル コンピューターにファイルをダウンロードしてから、ローカル コンピューターからナレッジ ベースにファイルを追加できます。If you have an authenticated file or URL, an alternative option is to download the file from the authenticated site to your local computer, then add the file from your local computer to the knowledge base.

FAQ URLFAQ URLs

QnA Maker がサポートできる FAQ ページの形式は、基本的な FAQ ページ、リンク付き FAQ ページ、トピックのホーム ページ付き FAQ ページの 3 種類です。QnA Maker can support FAQ web pages in 3 different forms: Plain FAQ pages, FAQ pages with links, FAQ pages with a Topics Homepage.

基本的な FAQ ページPlain FAQ pages

これは最も一般的なタイプの FAQ ページです。質問と回答が同じページにあり、質問のすぐ下に回答が記載されます。This is the most common type of FAQ page, in which the answers immediately follow the questions in the same page.

次に示すのは、基本的な FAQ ページの例です。Below is an example of a plain FAQ page:

基本的な FAQ ページの例 (ナレッジ ベース)

このタイプの FAQ ページでは、質問が 1 か所に集約され、同じページ上の別のセクションまたは別のページのどちらかにある回答にリンクされます。In this type of FAQ page, questions are aggregated together and are linked to answers that are either in different sections of the same page, or in different pages.

次に示すのは、同じページ上のセクションへのリンクがある FAQ ページの例です。Below is an example of an FAQ page with links in sections that are on the same page:

セクションへのリンクがある FAQ ページの例 (ナレッジ ベース)

トピックのホーム ページ付き FAQ ページFAQ pages with a Topics homepage

このタイプの FAQ にはトピックのホーム ページがあり、それぞれのトピックは別のページにある関連 QnA へのリンクです。This type of FAQ has a home page with the Topics where each Topic is a link to its relevant QnAs in a different page. ここでは、QnA Maker は、リンクされているすべてのページをクロールして、対応する質問と回答を抽出します。Here, QnA Maker crawls all the linked pages to extract the corresponding questions & answers.

次に示すのは、別のページ内の FAQ セクションへのリンクがトピックのホーム ページにある FAQ ページの例です。Below is an example of an FAQ page where a topics homepage has links to FAQ sections in different pages.

ディープ リンクがある FAQ ページの例 (ナレッジ ベース)

サポート URLSupport Urls

QnA Maker では、特定のタスクを実行する方法、特定の問題を診断および解決する方法、特定のプロセスに対するベスト プラクティスについて説明する Web 記事などの半構造化サポート Web ページを処理できます。QnA Maker can process semi-structured support web pages, such as web articles that would describe how to perform a given task, how to diagnose and resolve a given problem, and what are the best practices for a given process. 抽出が最もうまくいくのは、階層的な見出しのある明確な構造を持ったコンテンツです。Extraction works best on content that has a clear structure with hierarchical headings.

注意

サポートの記事の抽出は新機能であり、初期段階にあります。Extraction for support articles is a new feature and is in early stages. 適切に構造化された、複雑なヘッダー/フッターが含まれていないシンプルなページで最適に動作します。It works best for simple pages, that are well structured, and do not contain complex headers/footers.

QnA Maker では、明確な構造が階層的な見出しで表現されている半構造化 Web ページからの抽出がサポートされます

PDF/ DOC ファイルPDF/ DOC files

QnA Maker では、PDF または DOC ファイルの半構造化コンテンツを処理し、QnA に変換することができます。QnA Maker can process semi-structured content in a PDF or DOC file, and convert it into QnAs. 正しく抽出できる適切なファイルは、コンテンツが何らかの構造化形式で整理され、適切に定義されたセクションで表現されているファイルです。A good file that can be extracted well is one where content is organized in some structured form, and is represented in well-defined sections. セクションはさらにサブセクションまたはサブトピックに分けることができます。The sections can further be broken inTO subsections, or subtopics. 抽出が最もうまくいくのは、階層的な見出しのある明確な構造を持ったドキュメントです。Extraction works best on documents that have a clear structure with hierarchical headings.

QnA Maker は、フォント サイズ、フォント スタイル、ナンバリング、色などの視覚的な手がかりに基づいて、ファイル内のセクション、サブセクション、関係を識別します。半構造化 PDF または DOC ファイルには、マニュアル、FAQ、ガイドライン、ポリシー、パンフレット、チラシ、その他多くの種類のファイルがあります。QnA Maker identifies sections and subsections and relationships in the file based on visual clues like font size, font style, numbering, colors, etc. Semi-structured PDF or DOC files could be Manuals, FAQs, Guidelines, Policies, Brochures, Flyers, and many other types of files. 次に示すのは、これらのファイルの種類の例です。Below are some example types of these files.

製品マニュアルProduct manuals

一般にマニュアルは、製品に付属するガイダンス資料です。A manual is typically guidance material that accompanies a product. ユーザーにとっては、製品のセットアップ、使用、保守、トラブルシューティングにあたっての貴重な情報源となります。It helps the user to set up, use, maintain, and troubleshoot the product. QnA Maker は、マニュアルを処理する際、見出しと小見出しを質問として抽出し、質問に続くコンテンツを回答として抽出します。When QnA Maker processes a manual, it extracts the headings and subheadings as questions and the subsequent content as answers. こちらの例を参照してください。See an example here.

次に示すのは、索引ページと階層的なコンテンツを持ったマニュアルの例ですBelow is an example of a manual with an index page, and hierarchical content

製品マニュアルの例 (ナレッジ ベース)

注意

抽出の対象として最も適しているのは、目次やインデックス ページがあり、階層化された見出しから成る明確な構造を持ったマニュアルです。Extraction works best on manuals that have a table of contents and/or an index page, and a clear structure with hierarchical headings.

パンフレット、ガイドライン、論文、およびその他のファイルBrochures, guidelines, papers, and other files

明確な構造とレイアウトがあれば、他の多くの種類のドキュメントも処理して QA ペアを生成することができます。Many other types of documents can also be processed to generate QA pairs, provided they have a clear structure and layout. チェックの内容は次のとおりですパンフレット、ガイドライン、レポート、ホワイト ペーパー、科学論文、ポリシー、書籍などが含まれます。こちらの例を参照してください。These include: Brochures, guidelines, reports, white papers, scientific papers, policies, books, etc. See an example here.

次に示すのは、索引のない半構造化ドキュメントの例です。Below is an example of a semi-structured doc, without an index:

Azure BLOB ストレージ半構造化ドキュメント

構造化 QnA ドキュメントStructured QnA Document

次に示すように、質問と回答の構造化 DOC ファイルの形式は、質問と回答を 1 行おきに並べる、つまり、1 つの質問を 1 行に記述し、次の行にその回答を記述する形式です。The format for structured Question-Answers in DOC files, is in the form of alternating Questions and Answers per line, one question per line followed by its answer in the following line, as shown below:

Question1

Answer1

Question2

Answer2

次に示すのは、構造化 QnA Word 文書の例です。Below is an example of a structured QnA word document:

構造化 QnA ドキュメントの例 (ナレッジ ベース)

構造化 TXTTSV、および XLS ファイルStructured TXT, TSV and XLS Files

構造化 .txt.tsv、または .xls ファイル形式の QnA を QnA Maker にアップロードして、ナレッジ ベースを作成または拡張することもできます。QnAs in the form of structured .txt, .tsv or .xls files can also be uploaded to QnA Maker to create or augment a knowledge base. これらはプレーン テキストでも、RTF または HTML のコンテンツが含まれていても構いません。These can either be plain text, or can have content in RTF or HTML.

質問Question AnswerAnswer メタデータ (1 つのキー: 1 つの値)Metadata (1 key: 1 value)
質問 1Question1 回答 1Answer1 Key1:Value1 | Key2:Value2
質問 2Question2 回答 2Answer2 Key:Value

これより後の列は、ソース ファイルに含まれていても無視されます。Any additional columns in the source file are ignored.

次に示すのは、HTML コンテンツを含む構造化 QnA .xls ファイルの例です。Below is an example of a structured QnA .xls file, with HTML content:

構造化 QnA Excel の例 (ナレッジ ベース)

インポートでの構造化データ形式Structured data format through import

ナレッジ ベースをインポートすると、既にあるナレッジ ベースの内容が置き換えられます。Importing a knowledge base replaces the content of the existing knowledge base. インポートでは、データ ソース情報を含んだ .tsv 形式の構造化ファイルが必要となります。Import requires a structured .tsv file that contains data source information. この情報によって、QnA Maker は質問とその回答のペアをグループ化し、その帰属先となるデータ ソースを特定することができます。This information helps QnA Maker group the question-answer pairs and attribute them to a particular data source.

質問Question AnswerAnswer sourceSource メタデータ (1 つのキー: 1 つの値)Metadata (1 key: 1 value)
質問 1Question1 回答 1Answer1 URL 1Url1 Key1:Value1 | Key2:Value2
質問 2Question2 回答 2Answer2 編集Editorial Key:Value

編集という形でナレッジ ベースに追加するEditorially add to knowledge base

ナレッジ ベースの内容とする既存のコンテンツがない場合は、QnA Maker のナレッジ ベースに編集という形で QnA を追加することができます。If you do not have pre-existing content to populate the knowledge base, you can add QnAs editorially in QnA Maker Knowledge base. ナレッジ ベースの更新方法については、こちらを参照してください。Learn how to update your knowledge base here.

書式設定の考慮事項Formatting considerations

ファイルまたは URL をインポートすると、QnA Maker によってコンテンツはマークダウン形式に変換され、保存されます。After importing a file or URL, QnA Maker converts and stores your content in the markdown format. 変換プロセスによって、テキストに \n\n などの新しい行が追加されます。The conversion process adds new lines in the text, such as \n\n. マークダウン形式の知識があると、変換されたコンテンツを理解し、ナレッジ ベース コンテンツを管理するために役立ちます。A knowledge of the markdown format helps you to understand the converted content and manage your knowledge base content.

ナレッジ ベースのコンテンツを直接追加または編集する場合は、マークダウンの書式設定を使用してリッチ テキスト コンテンツを作成するか、既に回答に含まれているマークダウン形式コンテンツを変更します。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 は多くのマークダウン形式をサポートしているため、コンテンツにリッチ テキスト機能を取り込むことができます。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.

QnA Maker で使用できるマークダウン形式の一覧を次に示します。Following is the list of markdown formats that you can use in QnA Maker:

目的Purpose 形式Format マークダウンの例Example markdown 表示Rendering
チャット ボットの表示as displayed in Chat bot
2 つの文の間の改行。A new line between 2 sentences. \n\n How can I create a bot with \n\n QnA Maker? 2 つの文の間の改行を書式設定する
h1 から h6 までのヘッダー。# の番号はヘッダーを表します。Headers from h1 to h6, the number of # denotes which header. 1 # は h1 です。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...

\n# my h1 \n## my h2\n### my h3 \n#### my h4 \n##### my h5
マークダウン ヘッダーを使用した書式設定
マークダウン ヘッダー H1 から H5 を使用した書式設定
斜体Italics *text* How do I create a bot with *QnA Maker*? 斜体を使用した書式設定
文字列 (太字)String (bold) **text** How do I create a bot with **QnA Maker**? 太字の強力なマーキングを使用した書式設定
リンクの URLURL for link [text](https://www.my.com) How do I create a bot with [QnA Maker](https://www.qnamaker.ai)? URL (ハイパーリンク) の書式設定
* 公開画像の URL*URL for public image ![text](https://www.my.com/image.png) How can I create a bot with ![QnAMaker](https://review.docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/media/qnamaker-how-to-key-management/qnamaker-resource-list.png) 公開画像の URL の書式設定format for public image URL
取り消し線Strikethrough ~~text~~ some ~~questoins~~ questions need to be asked 取り消し線の書式設定
太字と斜体Bold and italics ***text*** How can I create a ***QnA Maker*** bot? 太字と斜体の書式設定
リンクの太字の URLBold URL for link [**text**](https://www.my.com) How do I create a bot with [**QnA Maker**](https://www.qnamaker.ai)? 太字の URL の書式設定
リンクの斜体の URLItalics URL for link [*text*](https://www.my.com) How do I create a bot with [*QnA Maker*](https://www.qnamaker.ai)? 斜体の URL の書式設定
マークダウン記号のエスケープEscape markdown symbols \*text\* How do I create a bot with \*QnA Maker\*? 斜体の URL の書式設定
番号付きリストOrdered list \n 1. item1 \n 1. item2 This is an ordered list: \n 1. List item 1 \n 1. List item 2
上の例では、マークダウンに組み込まれた自動番号付けを使用しています。The preceding example uses automatic numbering built into markdown.
This is an ordered list: \n 1. List item 1 \n 2. List item 2
上の例では明示的な番号付けを使用しています。The preceding example uses explicit numbering.
番号付きリストの書式設定
記号付きリストUnordered list \n * item1 \n * item2
oror
\n - item1 \n - item2
This is an ordered list: \n * List item 1 \n * List item 2 記号付きリストの書式設定
入れ子になったリストNested lists \n * Parent1 \n\t * Child1 \n\t * Child2 \n * Parent2

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

番号付きリストと記号付きリストを一緒に入れ子にすることができます。You can nest ordered and unordered lists together. タブ \t は、子要素のインデント レベルを示します。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

This is an ordered nested list: \n 1. Parent1 \n\t 1. Child1 \n\t 1. Child2 \n 1. Parent2
入れ子になった記号付きリストの書式設定
入れ子になった番号付きリストの書式設定

* QnA Maker ではどのような方法でも画像は処理されません。*QnA Maker doesn't process the image in any way. 画像をレンダリングするのはクライアント アプリケーションの役割です。It is the client application's role to render the image.

ナレッジ ベースのローカルな編集Editing your knowledge base locally

ナレッジ ベースを作成した後は、ローカル ファイルにエクスポートして再インポートするのではなく、QnA Maker ポータルでナレッジ ベースのテキストを編集することをお勧めします。Once a knowledge base is created, it is recommended that you make edits to the knowledge base text in the QnA Maker portal, rather than exporting and reimporting through local files. ただし、ローカル環境でナレッジ ベースを編集することが必要になる場合があります。However, there may be times that you need to edit a knowledge base locally.

[設定] ページからナレッジ ベースをエクスポートした後、Microsoft Excel でナレッジ ベースを編集します。Export the knowledge base from the Settings page, then edit the knowledge base with Microsoft Excel. エクスポートした TSV ファイルを別のアプリケーションで編集した場合、アプリケーションが TSV に完全に準拠していないため、構文エラーが発生する可能性があります。If you choose to use another application to edit your exported TSV file, the application may introduce syntax errors because it is not fully TSV compliant. Microsoft Excel の TSV ファイルでは一般に、書式エラーが発生することはありません。Microsoft Excel's TSV files generally don't introduce any formatting errors.

編集が終わったら、 [設定] ページから TSV ファイルを再インポートします。Once you are done with your edits, reimport the TSV file from the Settings page. これにより、現在のナレッジ ベースが、インポートしたナレッジ ベースに完全に置き換えられます。This will completely replace the current knowledge base with the imported knowledge base.

Markdown のテストTesting your Markdown

Markdown の検証については、 CommonMark のチュートリアルをご覧ください。Use the CommonMark tutorial to validate your Markdown. チュートリアルには、コピー/貼り付けで簡単に検証するための [Try it](試してみる) 機能があります。The tutorial has a Try it feature for quick copy/paste validation.

次の手順Next steps

関連項目See also

QnA Maker の概要QnA Maker overview