Orchestrator で複数の LUIS および QnA モデルを使用します

この記事の対象: SDK v4

ボットが複数の Language Understanding (LUIS) モデルと QnA Maker ナレッジベースを使用する場合、Bot Framework Orchestrator を使用して、どの LUIS モデルまたは QnA Maker ナレッジベースがユーザー入力に最も一致するかを判断できます。 bf orchestrator CLI コマンドを使用して Orchestrator スナップショットファイルを作成し、そのスナップショットファイルを使用して実行時にユーザー入力を正しいモデルにルーティングできます。

この記事では、既存の QnA Maker ナレッジベースを Orchestrator で使用する方法について説明します。

• 新しいボットの場合は、Azure AI Language の質問応答およびオーケストレーション ワークフロー機能の使用を検討してください。
• Orchestrator の詳細については、「Composer での Orchestrator によるインテント認識」を参照してください。
• bf orchestrator コマンドの詳細については、「Bot Framework CLI README」を参照してください。

前提条件

• LUIS アプリを作成するための luis.ai アカウント。
• QnA Maker アカウントと既存の QnA Maker ナレッジ ベース
• C# (アーカイブ済み) または JavaScript (アーカイブ済み) の Orchestrator を使用した NLP サンプルのコピー。
• ボットの基本、LUIS、および QnA Maker に関する知識。
• コマンドライン BF CLI をインストールします。

このサンプルについて

このサンプルは、LUIS および QnA Maker プロジェクトの定義済みセットに基づいています。 ただし、ボットで QnA Maker を使用するには、QnA Maker ポータルに既存のナレッジベースが必要です。 これで、ボットからナレッジ ベースを使用してユーザーの質問に回答できるようになります。

新しいボット開発では、Copilot Studio の使用をご検討ください。 Bot Framework SDK ボットの新しいナレッジ ベースを作成する必要がある場合は、次の Azure AI サービスの記事を参照してください。

• 質問応答とは?
• FAQ ボットを作成する
• .NET 用の Azure Cognitive Language Services の質問応答クライアント ライブラリ

ハンドラーによって LUIS または QnA Maker サービスが呼び出され、生成された結果がユーザーに返されます。

LUIS アプリを作成する

Orchestrator スナップショット ファイルを作成する前に、LUIS アプリと QnA ナレッジベースを作成して公開する必要があります。 この記事で参照されているサンプル ボットは、\CognitiveModels フォルダー内の Orchestrator を使用した NLP サンプルに含まれている次のモデルを使用します。

LUIS アプリの作成

サンプルの認知モデル ディレクトリにある HomeAutomation および Weather .lu ファイルから LUIS アプリを作成します。

1. 次のコマンドを実行して、アプリを本番環境にインポート、トレーニング、公開します。

   bf luis:build --in CognitiveModels --authoringKey <YOUR-KEY> --botName <YOUR-BOT-NAME>
   

2. アプリケーション ID 、表示名、オーサリングキー、および場所を記録します。

詳細については、「LUIS ポータルで LUIS アプリを作成する」と、「ボットに自然言語理解を追加する」の「LUIS アプリに接続するための値を取得する」方法、およびアプリをトレーニングして運用環境に公開する方法についての LUIS ドキュメントを参照してください。

ボットをナレッジ ベースに接続するための値を取得する

既存のナレッジベースと、QnA Maker のホスト名およびエンドポイントキーが必要です。

Orchestrator スナップショットファイルを作成する

Orchestrator ツールの CLI インターフェイスは、実行時に適切な LUIS または QnA Maker アプリにルーティングするための Orchestrator スナップショットファイルを作成します。

1. Visual C++ 再頒布可能パッケージの最新バージョンをインストールする

2. コマンド プロンプトまたはターミナル ウィンドウを開き、ディレクトリをサンプルディレクトリに変更する

3. npm と Bot Framework CLI の最新バージョンがインストールされていることを確認してください。

   npm i -g npm
   npm i -g @microsoft/botframework-cli
   

4. Orchestrator ベースモデルファイルをダウンロードする

   mkdir model
   bf orchestrator:basemodel:get --out ./model
   

5. Orchestrator スナップショットファイルを作成する

   mkdir generated
   bf orchestrator:create --hierarchical --in ./CognitiveModels --out ./generated --model ./model
   

"QnAKnowledgebaseId": "<knowledge-base-id>",
"QnAEndpointKey": "<qna-maker-resource-key>",
"QnAEndpointHostName": "<your-hostname>",

"LuisHomeAutomationAppId": "<app-id-for-home-automation-app>",
"LuisWeatherAppId": "<app-id-for-weather-app>",
"LuisAPIKey": "<your-luis-endpoint-key>",
"LuisAPIHostName": "<your-dispatch-app-region>",

npm install

QnAKnowledgebaseId="<knowledge-base-id>"
QnAEndpointKey="<qna-maker-resource-key>"
QnAEndpointHostName="<your-hostname>"

WeatherLuisAppId=<app-id-for-weather-app>
HomeAutomationLuisAppId=<app-id-for-home-automation-app>
LuisAPIKey=<your-luis-endpoint-key>
LuisAPIHostName=<your-dispatch-app-region>

ボットからサービスに接続する

LUIS および QnA Maker サービスに接続するために、ボットは設定ファイルから情報を取得します。

ボットからのサービスを呼び出す

ユーザーからの入力ごとに、ボット ロジックはユーザー入力を Orchestrator Recognizer に渡し、返された最上位のインテントを見つけ、その情報を使用して入力に適したサービスを呼び出します。

認識結果を操作する

ボットをテストする

1. ご自身の開発環境を使用して、サンプル コードを開始します。 アプリによって開かれたブラウザウィンドウのアドレスバーに表示される次の localhost アドレスをメモします。https://localhost:<Port_Number>

2. Bot Framework エミュレーターを開き、[ボットを開く] ボタンをクリックします。

3. [ボットを開く] ダイアログ ボックスで、ボットのエンドポイント URL (http://localhost:3978/api/messages など) を入力します。 [Connect] をクリックします。

4. 参考のために、ご自身のボット用に作成されたサービスに含まれる質問とコマンドの一部を次に示します。

   • QnA Maker
     • hi, good morning
     • what are you, what do you do
   • LUIS (ホーム オートメーション)
     • turn on bedroom light
     • turn off bedroom light
     • make some coffee
   • LUIS (天気)
     • whats the weather in redmond washington
     • what's the forecast for london
     • show me the forecast for nebraska

ユーザーの発話を QnA Maker にルーティングする

1. エミュレーターで、テキスト hi を入力し、発話を送信します。 ボットはこのクエリを Orchestrator に送信し、どの子アプリがこの発話を取得してさらに処理する必要があるかを示す応答を返します。

2. ログ内の Orchestrator Recognition Trace 行を選択すると、エミュレーターで JSON 応答を確認できます。 Orchestrator の結果がインスペクターに表示されます。

   {
   "type": "trace",
   "timestamp": "2021-05-01T06:26:04.067Z",
   "serviceUrl": "http://localhost:58895",
   "channelId": "emulator",
   "from": {
     "id": "36b2a460-aa43-11eb-920f-7da472b36492",
     "name": "Bot",
     "role": "bot"
   },
   "conversation": {
     "id": "17ef3f40-aa46-11eb-920f-7da472b36492|livechat"
   },
   "recipient": {
     "id": "5f8c6123-2596-45df-928c-566d44426556",
     "role": "user"
   },
   "locale": "en-US",
   "replyToId": "1a3f70d0-aa46-11eb-8b97-2b2a779de581",
   "label": "Orchestrator Recognition",
   "valueType": "OrchestratorRecognizer",
   "value": {
     "text": "hi",
     "alteredText": null,
     "intents": {
       "QnAMaker": {
         "score": 0.9987310956576168
       },
       "HomeAutomation": {
         "score": 0.3402091165577196
       },
       "Weather": {
         "score": 0.24092200496795158
       }
     },
     "entities": {},
     "result": [
       {
         "Label": {
           "Type": 1,
           "Name": "QnAMaker",
           "Span": {
             "Offset": 0,
             "Length": 2
           }
         },
         "Score": 0.9987310956576168,
         "ClosestText": "hi"
       },
       {
         "Label": {
           "Type": 1,
           "Name": "HomeAutomation",
           "Span": {
             "Offset": 0,
             "Length": 2
           }
         },
         "Score": 0.3402091165577196,
         "ClosestText": "make some coffee"
       },
       {
         "Label": {
           "Type": 1,
           "Name": "Weather",
           "Span": {
             "Offset": 0,
             "Length": 2
           }
         },
         "Score": 0.24092200496795158,
         "ClosestText": "soliciting today's weather"
       }
     ]
   },
   "name": "OrchestratorRecognizerResult",
   "id": "1ae65f30-aa46-11eb-8b97-2b2a779de581",
   "localTimestamp": "2021-04-30T23:26:04-07:00"
   }
   

   発話 hi は Orchestrator の QnAMaker インテントの一部であり、topScoringIntent として選択されているため、ボットは今度は同じ発話を使用して QnA Maker アプリに 2 番目のリクエストを送信します。

3. エミュレータログの QnAMaker Trace 行を選択します。 インスペクターに QnA Maker の結果が表示されます。

   {
       "questions": [
           "hi",
           "greetings",
           "good morning",
           "good evening"
       ],
       "answer": "Hello!",
       "score": 1,
       "id": 96,
       "source": "QnAMaker.tsv",
       "metadata": [],
       "context": {
           "isContextOnly": false,
           "prompts": []
       }
   }
   

[Python (アーカイブ済み)]: https://github.com/microsoft/BotBuilder-Samples/tree/main/archive/samples/python/14.nlp-with-orchestrator