QnA Maker 用の Azure リソース

[アーティクル]
01/19/2024

QnA Maker では、それぞれ異なる目的で複数の Azure ソースを使用します。それらが個別にどのように使用されるかを理解すると、正しい価格レベルを計画して選択し、価格レベルを変更する時期を把握できるようになります。これらを "組み合わせて" 使用する方法を理解すると、発生した問題を見つけて修正できるようになります。

Note

QnA Maker サービスは、2025 年 3 月 31 日に廃止される予定です。 Azure AI Language の一部として、質問応答機能の新しいバージョンが提供されました。言語サービス内の質問応答機能については、質問応答に関する記事を参照してください。 QnA Maker の新しいリソースは、2022 年 10 月 1 日以降作成できません。既存の QnA Maker のナレッジベースを質問応答に移行する方法については、移行ガイドを参照してください。

リソースの計画

プロトタイプフェーズで初めて QnA Maker ナレッジベースを開発する場合は、テストと運用の両方で 1 つの QnA Maker リソースを使用することが一般的です。

プロジェクトの開発フェーズに移行するときは、次のことを考慮する必要があります。

ナレッジベースシステムで保持される言語の数
ナレッジベースを使用できるようにする必要があるリージョンの数
システムによって各ドメイン内に保持されるドキュメントの数

1 つの QnA Maker リソースでは、同じ言語、同じリージョン、同じ主題の領域の組み合わせを持つすべてのナレッジベースを保持する計画を立てます。

価格レベルに関する考慮事項

通常、次の 3 つのパラメーターを考慮する必要があります。

サービスに必要なスループット:
- App Service の適切なアプリプランを、実際のニーズに基づいて選択します。アプリはスケールアップまたはスケールダウンすることができます。
- この点は、Azure Cognitive Search の SKU の選択にも影響します。詳細については、こちらを参照してください。さらに、レプリカで Cognitive Search の容量を調整することが必要になる場合があります。
ナレッジベースのサイズと数: 実際のシナリオに合った適切な Azure Search SKU を選択してください。通常は、さまざまな主題の領域の数に基づいて必要なナレッジベースの数を決定します。 (1 つの言語の) 主題の領域を 1 つのナレッジベースに含めるようにします。

Azure Search サービスリソースは 2019 年 1 月以降に作成されている必要があり、無料 (共有) レベルでは使用できません。現在 Azure portal では、カスタマーマネージドキーの構成はサポートされていません。

重要

特定のレベルで発行できるナレッジベースの数は N-1 件です (N は、そのレベルで許容される最大インデックス)。レベルごとに許容されるドキュメントの最大サイズと最大数もチェックしてください。

たとえば、レベルに 15 個の許可されたインデックスがある場合、14 個のナレッジベースを発行できます (発行されたナレッジベースあたり 1 インデックス)。 15 番目のインデックスは、作成およびテスト用にすべてのナレッジベースで使用されます。

ソースとしてのドキュメントの数: QnA Maker 管理サービスの無料の SKU では、ポータルと API で管理できるドキュメントの数が 3 つ (サイズはそれぞれ 1 MB) に限定されます。 Standard SKU では、管理できるドキュメントの数に制限はありません。詳細については、こちらを参照してください。

次の表は、いくつかの基本的なガイドラインを示したものです。

	QnA Maker 管理	App Service	Azure AI Search	制限事項
実験	無料の SKU	Free レベル	Free レベル	発行できる KB は 2 つまで (最大サイズ 50 MB)
Dev/Test 環境	Standard SKU	共有	Basic	発行できる KB は 14 個まで (最大サイズ 2 GB)
運用環境	Standard SKU	Basic	Standard	発行できる KB は 49 個まで (最大サイズ 25 GB)

推奨設定

ターゲット QPS	App Service	Azure AI Search
3	S1、1 つのレプリカ	S1、1 つのレプリカ
50	S3、10 個のレプリカ	S1、12 個のレプリカ
80	S3、10 個のレプリカ	S3、12 個のレプリカ
100	P3V2、10 個のレプリカ	S3、12 個のレプリカ、3 つのパーティション
200 - 250	P3V2、20 個のレプリカ	S3、12 個のレプリカ、3 つのパーティション

価格レベルを変更する場合

アップグレード	理由
QnA Maker 管理 SKU のアップグレード	ナレッジベースではさらに多くの QnA ペアまたはドキュメントソースが必要です。
App Service SKU のアップグレード、Azure AI Search のレベルの確認、および Cognitive Search レプリカの作成	ナレッジベースでクライアントアプリ (チャットボットなど) からのより多くの要求に対応する必要がある。
Azure AI Search サービスをアップグレードする	多数のナレッジベースを使用する予定である。

Azure portal で App Service を更新して、最新のランタイム更新プログラムを取得します。

QnA Maker のキー

QnA Maker サービスでは、App Service でホストされるランタイムと共に使用されるオーサリングキーとクエリエンドポイントキーの 2 種類のキーが扱われます。

これらのキーは、API を介してサービスに要求を行うときに使用します。

Key management

名前	場所	目的
オーサリングまたはサブスクリプションキー	Azure Portal	これらのキーは、QnA Maker 管理サービス API へのアクセスに使用されます。これらの API を使用して、ナレッジベース内の質問と回答を編集したり、ナレッジベースを公開したりできます。これらのキーは、新しい QnA Maker サービスを作成するときに作成されます。これらのキーは、「キーとエンドポイント」ページの Azure AI サービスリソースで確認できます。
クエリエンドポイントキー	QnA Maker ポータル	これらのキーは、公開されたナレッジベースのエンドポイントにクエリを実行して、ユーザーの質問に対する回答を取得する目的で使用されます。通常、このクエリエンドポイントは、QnA Maker サービスに接続するチャットボットまたはクライアントアプリケーションコードで使用されます。これらのキーは、QnA Maker ナレッジベースを公開するときに作成されます。これらのキーは、 [サービスの設定] ページで確認できます。このページは、ページの右上にあるドロップダウンメニュー内のユーザーのメニューに含まれています。

Azure portal でオーサリングキーを確認する

QnA Maker リソースを作成した Azure portal で、オーサリングキーの表示とリセットを実行できます。

Azure portal で QnA Maker リソースに移動し、種類が "Azure AI サービス" であるリソースを選択します。
[キーとエンドポイント] に移動します。

QnA Maker ポータルでクエリエンドポイントキーを確認する

ナレッジベースの呼び出しにはエンドポイントキーが使用されるため、エンドポイントはリソースと同じリージョンにあります。

エンドポイントキーは、QnA Maker ポータルから管理することができます。

QnA Maker ポータルにサインインし、お使いのプロファイルに移動してから、 [サービスの設定] を選択します。
キーを表示またはリセットします。

Note

キーが漏えいしていると思われる場合は、キーを更新してください。それに合わせて、クライアントアプリまたはボットのコードの変更が必要になることがあります。

管理サービスのリージョン

QnA Maker の管理サービスは、QnA Maker ポータルと初期データ処理でのみ使用されます。このサービスは、米国西部リージョンでのみ利用できます。この米国西部のサービスでは、顧客データは保存されません。

リソースの名前付けに関する考慮事項

qna-westus-f0-b などの QnA Maker リソースのリソース名は、他のリソースの名前付けにも使用されます。

Azure portal の作成ウィンドウを使うと、QnA Maker リソースを作成し、他のリソースの価格レベルを選択できます。

Screenshot of Azure portal for QnA Maker resource creation

名前の末尾に文字が追加されるオプションの Application Insights リソースを除き、リソースが作成された後は同じ名前になります。

Screenshot of Azure portal resource listing

ヒント

QnA Maker リソースを作成するときに新しいリソースグループを作成します。これで、リソースグループで検索するときに、QnA Maker リソースに関連付けられているすべてのリソースを表示できるようになります。

ヒント

名前付け規則を使用して、リソースまたはリソースグループの名前内の価格レベルを示します。新しいナレッジベースの作成または新しいドキュメントの追加でエラーが発生する場合、Cognitive Search の価格レベルの制限が一般的な問題です。

リソースの目的

QnA Maker で作成される各 Azure リソースには特定の目的があります。

QnA Maker リソース
Cognitive Search リソース
App Service
App Plan サービス
Application Insights サービス

QnA Maker リソース

QnA Maker リソースを使用すると、作成と発行の API にアクセスできます。

QnA Maker リソースの構成設定

QnA Maker ポータルで新しいナレッジベースを作成する場合、リソースレベルで適用される設定は言語設定のみです。リソースに最初のナレッジベースを作成するときに、言語を選択します。

Cognitive Search リソース

Cognitive Search リソースは次の目的で使用されます。

QnA ペアを格納する
実行時に QnA ペアの初期順位 (ランカー #1) を指定する

インデックスの使用量

リソースには、テストインデックスとして機能する 1 つのインデックスが保持され、残りのインデックスは、それぞれ 1 つの公開されたナレッジベースに関連付けられます。

15 個のインデックスを保持できる価格設定のリソースには、14 個の公開されたナレッジベースが保持され、1 つのインデックスがすべてのナレッジベースのテストに使用されます。このテストインデックスはナレッジベースによってパーティション分割されているため、対話型テストペインを使用するクエリにはテストインデックスが使用されますが、特定のナレッジベースに関連付けられた特定のパーティションの結果のみが返されます。

言語の使用方法

QnA Maker リソースで作成された最初のナレッジベースは、Cognitive Search リソースとそのすべてのインデックス用の "1 つの" 言語セットを決定するために使用されます。 1 つの QnA Maker サービスには "1 つの言語セット" のみを使用できます。

1 つの Cognitive Search サービスの使用

ポータルを使用して QnA サービスとその依存関係 (Search など) を作成すると、Search サービスが自動的に作成され、QnA Maker サービスにリンクされます。これらのリソースが作成された後、既存の Search サービスを使用するように App Service 設定を更新して、先ほど作成されたサービスを削除できます。

QnA Maker リソース作成プロセスの一環で作成されたものとは異なる Azure AI サービスリソースを使用するように QnA Maker を構成する方法を確認してください。

App Service と App Service プラン

App Service は、クライアントアプリケーションからランタイムエンドポイントを介して公開されたナレッジベースにアクセスするときに使用されます。アプリサービスには、実行時に QnA ペアの中で自然言語処理 (NLP) ベースの 2番目の順位のレイヤー (ランカー #2) が含まれています。 2 番目の順位では、メタデータとフォローアッププロンプトを含めることができるインテリジェントフィルターが適用されます。

公開されたナレッジベースのクエリを実行する場合、公開されたナレッジベースにはすべて同じ URL エンドポイントが使用されますが、ルート内のナレッジベース ID を指定します。

{RuntimeEndpoint}/qnamaker/knowledgebases/{kbId}/generateAnswer

Application Insights

Application Insights は、チャットログとテレメトリを収集するために使用されます。サービスの詳細については、一般的な Kusto クエリに関する記事を参照してください。

QnA Maker はいくつかの Azure リソースを作成します。管理を軽減し、コスト共有のメリットを得るために、次の表を使用して、共有できるものとできないものを理解してください。

サービス	共有	理由
Azure AI サービス	x	仕様により不可能
App Service プラン	✔	App Service プランに対して固定のディスク領域が割り当てられています。同じ App Service プランを共有している他のアプリによって大量のディスク領域が使用された場合、QnA Maker App Service インスタンスで問題が発生します。
App Service	X	仕様により不可能
Application Insights	✔	共有できます
検索サービス	✔	1. `testkb` は QnA Maker サービス用の予約された名前です。他のサービスで使用することはできません。 2.`synonym-map` という名前のシノニムマップは、QnA Maker サービス用に予約されています。 3.公開されるナレッジベースの数は、Search サービスのレベルによって制限されます。使用可能な空きインデックスがある場合は、他のサービスでそれらを使用できます。

次のステップ

QnA Maker のナレッジベースについて確認します
ナレッジベースのライフサイクルを理解します
サービスとナレッジベースの制限を確認します