クイック スタート:QnA Maker ナレッジ ベースの作成、トレーニング、発行Quickstart: Create, train, and publish your QnA Maker knowledge base

QnA Maker のナレッジ ベース (KB) は、よくあるご質問や製品マニュアルなど、独自のコンテンツから作成できます。You can create a QnA Maker knowledge base (KB) from your own content, such as FAQs or product manuals. この記事には、単純な FAQ Web ページから QnA Maker ナレッジ ベースを作成して、QnA Maker に関する質問に答える例が含まれています。This article includes an example of creating a QnA Maker knowledge base from a simple FAQ webpage, to answer questions QnA Maker.

前提条件Prerequisites

  • Azure サブスクリプションをお持ちでない場合は、開始する前に 無料アカウント を作成してください。If you don't have an Azure subscription, create a free account before you begin.
  • Azure portal で作成された QnA Maker リソースA QnA Maker resource created in the Azure portal. リソースを作成するしたに選択した Azure Active Directory ID、サブスクリプション、QnA リソース名を覚えておいてください。Remember your Azure Active Directory ID, Subscription, QnA resource name you selected when you created the resource.

最初の QnA Maker ナレッジ ベースを作成するCreate your first QnA Maker knowledge base

  1. ご自分の Azure の資格情報を使用して QnAMaker.ai ポータルにサインインします。Sign in to the QnAMaker.ai portal with your Azure credentials.

  2. QnA Maker ポータルで、 [Create a knowledge base](ナレッジ ベースの作成) を選択します。In the QnA Maker portal, select Create a knowledge base.

  3. QnA Maker リソースが既にある場合は、 [Create](作成) ページで、 [Step 1](手順 1) をスキップします。On the Create page, skip Step 1 if you already have your QnA Maker resource.

    リソースをまだ作成していない場合は、 [Create a QnA service](QnA サービスの作成) を選択します。If you haven't created the resource yet, select Create a QnA service. サブスクリプションで QnA Maker サービスを設定するため、Azure portal にリダイレクトされます。You are directed to the Azure portal to set up a QnA Maker service in your subscription. リソースを作成するしたに選択した Azure Active Directory ID、サブスクリプション、QnA リソース名を覚えておいてください。Remember your Azure Active Directory ID, Subscription, QnA resource name you selected when you created the resource.

    Azure portal でリソースの作成が完了したら、QnA Maker ポータルに戻り、ブラウザー ページを最新の状態に更新して、 [Step 2](手順 2) を続けます。When you are done creating the resource in the Azure portal, return to the QnA Maker portal, refresh the browser page, and continue to Step 2.

  4. [Step 3](手順 3) で、Active Directory、サブスクリプション、サービス (リソース)、およびサービスで作成されたすべてのナレッジ ベースの言語を選択します。In Step 3, select your Active directory, subscription, service (resource), and the language for all knowledge bases created in the service.

    QnA Maker サービス ナレッジ ベースの選択のスクリーンショット

  5. [Step 3](手順 3) で、自分のナレッジ ベースに My Sample QnA KB という名前を付けます。In Step 3, name your knowledge base My Sample QnA KB.

  6. [Step 4](手順 4) で、次の表を使用して設定を構成します。In Step 4, configure the settings with the following table:

    設定Setting Value
    Enable multi-turn extraction from URLs, .pdf or .docx files (URL、.pdf、または .docx ファイルからの複数ターンの抽出を有効にする)Enable multi-turn extraction from URLs, .pdf or .docx files. オンChecked
    Default answer text (既定の回答テキスト)Default answer text Quickstart - default answer not found.
    + Add URL (+ URL の追加)+ Add URL https://docs.microsoft.com/azure/cognitive-services/qnamaker/troubleshooting
    Chit-chat (おしゃべり)Chit-chat [Professional](専門家) を選択しますSelect Professional
  7. [Step 5](手順 5) で、 [Create your KB](KB の作成) を選択します。In Step 5, Select Create your KB.

    抽出プロセスでは、ドキュメントを読み取って質問と回答を識別します。これにはしばらくかかります。The extraction process takes a few moments to read the document and identify questions and answers.

    QnA Maker がナレッジ ベースを正常に作成すると、 [Knowledge base](ナレッジ ベース) ページが開きます。After QnA Maker successfully creates the knowledge base, the Knowledge base page opens. このページで、ナレッジ ベースの内容を編集することができます。You can edit the contents of the knowledge base on this page.

新しい質問と回答のセットを追加するAdd a new question and answer set

  1. QnA Maker ポータルの [Edit](編集) ページで、コンテキスト ツール バーから [+ Add QnA pair](+ QnA ペアの追加) を選択します。In the QnA Maker portal, on the Edit page, select + Add QnA pair from the context toolbar.

  2. 次の質問を追加します。Add the following question:

    How many Azure services are used by a knowledge base?

  3. "マークダウン" で書式設定された回答を追加します。Add the answer formatted with markdown:

    * Azure QnA Maker service\n* Azure Cognitive Search\n* Azure web app\n* Azure app plan

    QnA Maker サービス ナレッジ ベースの選択のスクリーンショット

    マークダウン記号 * は、箇条書きに使用されます。The markdown symbol, *, is used for bullet points. \n は、改行に使用されます。The \n is used for a new line.

    [Edit](編集) ページには、マークダウンが表示されます。The Edit page shows the markdown. 後で [Test](テスト) パネルを使用すると、マークダウンが正しく表示されることを確認できます。When you use the Test panel later, you will see the markdown displayed properly.

保存してトレーニングSave and train

右上の [Save and train](保存してトレーニング) を選択し、編集内容を保存して QnA Maker をトレーニングします。In the upper right, select Save and train to save your edits and train QnA Maker . 保存しないと、編集した内容は保持されません。Edits aren't kept unless they're saved.

ナレッジ ベースをテストするTest the knowledge base

  1. QnA Maker ポータルの右上にある [テスト] を選択して、行った変更が反映されたかどうかをテストします。In the QnA Maker portal, in the upper right, select Test to test that the changes you made took effect.

  2. テキスト ボックスにユーザー クエリの例を入力します。Enter an example user query in the textbox.

    How many Azure services are used by a knowledge base?

    QnA Maker サービス ナレッジ ベースの選択のスクリーンショット

  3. [検査] を選択し、詳細に応答を確認します。Select Inspect to examine the response in more detail. テスト ウィンドウは、ナレッジ ベースへの変更を、発行前にテストする際に使用します。The test window is used to test your changes to the knowledge base before publishing your knowledge base.

  4. [Test](テスト) パネルを閉じるには、もう一度 [Test](テスト) を選択します。Select Test again to close the Test panel.

ナレッジ ベースの公開Publish the knowledge base

ナレッジ ベースを発行すると、ナレッジ ベースのコンテンツが、Azure Search の test インデックスから prod インデックスに移動されます。When you publish a knowledge base, the contents of your knowledge base move from the test index to a prod index in Azure search.

ナレッジ ベースのコンテンツ移動のスクリーン ショット

  1. QnA Maker ポータルで、 [発行] を選択します。In the QnA Maker portal, select Publish. 確認のため、ページの [発行] を選択します。Then to confirm, select Publish on the page.

    QnA Maker サービスが正常に発行されました。The QnA Maker service is now successfully published. お使いのアプリケーションまたはボット コードで、エンドポイントを使用できます。You can use the endpoint in your application or bot code.

    正常な発行のスクリーンショット

ボットの作成Create a bot

発行後は、 [発行] ページからボットを作成できます。After publishing, you can create a bot from the Publish page:

  • 複数のボットを迅速に作成し、個々のボットはリージョンや価格プランが異なっていてもすべて同じナレッジ ベースを指すことができます。You can create several bots quickly, all pointing to the same knowledge base for different regions or pricing plans for the individual bots.
  • ナレッジ ベースのボットを 1 つだけにする場合は、 [View all your bots on the Azure portal](Azure portal 上で自分のボットをすべて表示する) リンクを使用して、ご自分の現在のボットの一覧を表示します。If you want only one bot for the knowledge base, use the View all your bots on the Azure portal link to view a list of your current bots.

ナレッジ ベースに変更を加えて再発行しても、ボットに対して追加のアクションを実行する必要はありません。When you make changes to the knowledge base and republish, you don't need to take further action with the bot. ナレッジ ベースと連携するように既に構成されており、ナレッジ ベースに対する今後のすべての変更に対応します。It's already configured to work with the knowledge base, and works with all future changes to the knowledge base. ナレッジ ベースを発行するたびに、それに接続されているすべてのボットが自動的に更新されます。Every time you publish a knowledge base, all the bots connected to it are automatically updated.

  1. QnA Maker ポータルの [発行] ページで、 [Create bot](ボットの作成) を選択します。In the QnA Maker portal, on the Publish page, select Create bot. このボタンは、ナレッジ ベースの発行後にのみ表示されます。This button appears only after you've published the knowledge base.

    ボットの作成のスクリーンショット

  2. Azure portal の新しいブラウザー タブが開き、Azure Bot Service の作成ページが表示されます。A new browser tab opens for the Azure portal, with the Azure Bot Service's creation page. Azure Bot Service を構成します。Configure the Azure bot service. ボットと QnA Maker は、Web App Service プランを共有できますが、Web アプリを共有することはできません。The bot and QnA Maker can share the web app service plan, but can't share the web app. そのため、ボットのアプリ名は、QnA Maker サービスのアプリ名とは異なる必要があります。This means the app name for the bot must be different from the app name for the QnA Maker service.

    • すべきことDo
      • ボット ハンドルが一意でない場合に、ボット ハンドルを変更する。Change bot handle - if it is not unique.
      • SDK 言語を選択する。Select SDK Language. ボットの作成後、ローカル開発環境にコードをダウンロードして、開発プロセスを続行できます。Once the bot is created, you can download the code to your local development environment and continue the development process.
    • やってはいけないことDon't
      • ボットを作成するときに、Azure portal 上で次の設定を変更する。change the following settings in the Azure portal when creating the bot. これらはご自分の既存のナレッジ ベースのために事前に設定されています。They are pre-populated for your existing knowledge base:
        • QnA 認証キーQnA Auth Key
        • App Service プランと場所App service plan and location
  3. ボットが作成された後、 [Bot service](ボット サービス) リソースを開きます。After the bot is created, open the Bot service resource.

  4. [Bot Management](ボット管理) で、 [Test in Web Chat](Web チャットでのテスト) を選択します。Under Bot Management, select Test in Web Chat.

  5. チャット プロンプトの [Type your message](メッセージを入力) で、以下のように入力します。At the chat prompt of Type your message, enter:

    Azure services?

    チャット ボットが、ナレッジ ベースからの回答で応答します。The chat bot responds with an answer from your knowledge base.

    QnA Maker サービス ナレッジ ベースの選択のスクリーンショット

ここで行ったことWhat did you accomplish?

新しいナレッジ ベースを作成してそこにパブリック URL を追加し、独自の QnA ペアを追加しました。また、ナレッジ ベースをトレーニング、テストして、発行しました。You created a new knowledge base, added a public URL to the knowledge base, added your own QnA pair, trained, tested, and published the knowledge base.

ナレッジ ベースの発行後、ボットを作成し、テストしました。After publishing the knowledge base, you created a bot, and tested the bot.

コードを記述したりコンテンツを整理したりする必要はなく、作業は数分で終了しました。This was all accomplished in a few minutes without having to write any code or clean the content.

リソースをクリーンアップするClean up resources

次のクイックスタートに進まない場合は、Azure portal で QnA Maker と Bot フレームワークのリソースを削除します。If you are not continuing to the next quickstart, delete the QnA Maker and Bot framework resources in the Azure portal.

次のステップNext steps

詳細:For more information: