重要
API プラグインは、 宣言型エージェント内のアクションとしてのみサポートされます。 Microsoft 365 Copilotでは有効になっていません。
API プラグインは、既存の REST API をMicrosoft 365 Copilotに接続します。 Microsoft 365 Agents Toolkit (Teams Toolkit の進化) を使用して、 OpenAPI 仕様の既存の REST API からプラグインを生成できます。
前提条件
- 「Copilot 機能拡張オプションの要件」で指定されている要件
- OpenAPI 仕様の既存の REST API (このチュートリアルでは 、Budget Tracker サンプル API を使用します)
- Visual Studio Code
- Microsoft 365 Agents Toolkit
ヒント
最適な結果を得るには、「OpenAPI ドキュメントを Copilot の拡張に有効にする方法」に記載されているガイドラインに従ってください。
このガイドに従うために、 Budget Tracker サンプル API を ダウンロードし、ローカル開発マシンで実行するように構成します。 サンプルを少なくとも 1 回ビルドして、API の BudgetTracker.json ファイルを生成します。
プラグインを作成する
注:
このドキュメントの Microsoft 365 Agents Toolkit (Teams Toolkit の進化) のユーザー インターフェイスに関するスクリーンショットと参照は、最新 のリリース バージョン 6.0 を使用して生成されました。 エージェント ツールキットのプレリリース バージョンは、このドキュメントのユーザー インターフェイスとは異なる場合があります。
API プラグインは、次のファイルを含む ZIP ファイルです。
- REST API の OpenAPI 仕様。
- 含まれている OpenAPI 仕様を参照し、使用可能な操作、認証方法、応答形式について説明する API プラグイン マニフェスト 。
Visual Studio Code を開きます。 エージェント ツールキットがまだインストールされていない場合は、インストール手順については、「 エージェント ツールキットのインストール 」を参照してください。
左側のアクティビティ バーで [Microsoft 365 Agents Toolkit ] アイコンを選択します。
[エージェント ツールキット] 作業ウィンドウで [ 新しいエージェント/アプリの作成 ] を選択します。
[ 宣言型エージェント] を選択します。
[ アクションの追加] を選択し、[ OpenAPI Description Document で開始] を選択します。
[ 参照] を選択し、 ./openapi/BudgetTracker.jsonにある予算トラッカー サンプルから OpenAPI 仕様の場所を参照します。
プラグインに対して有効にする操作をすべて選択します。
API プラグイン プロジェクトの場所を選択します。
プラグインの名前として「
Budget Tracker」と入力します。
これらの手順を完了すると、Agents Toolkit によってプラグインに必要なファイルが生成され、プラグイン プロジェクトが読み込まれた新しい Visual Studio Code ウィンドウが開きます。
注:
ID サーバーで Proof Key for Code Exchange (PKCE) が必要な場合は、API プラグイン プロジェクトの m365agents.yml で次の行のコメントを解除します。
# isPKCEEnabled: true
プラグインをパッケージ化してサイドロードする
Visual Studio Code でプラグイン プロジェクトを開きます。
左側のアクティビティ バーで [Microsoft 365 Agents Toolkit ] アイコンを選択します。
[ アカウント ] ウィンドウ で、[Microsoft 365 にサインイン] を選択します。 (既にサインインしている場合は、次の手順に進みます)。
Microsoft 365 アカウントの [ カスタム アプリアップロードが有効] と [ Copilot Access Enabled]\(有効\) の両方が表示されていることを確認します。 そうでない場合は、organization管理者とチェックします。詳細については、「Copilot 機能拡張オプションの要件」を参照してください。
[ ライフサイクル ] ウィンドウで、[ プロビジョニング] を選択します。
OAuth 登録のクライアント ID を入力するように求められたら、プラグイン クライアント ID を入力します。
OAuth 登録用のクライアント シークレットを入力するように求められたら、プラグイン クライアント シークレットを入力します。
ダイアログでメッセージを読み、[ 確認 ] を選択して続行します。
プロビジョニングが完了したツールキットが報告されるまで待ちます。
プラグインは、Microsoft TeamsのMicrosoft 365 Copilotでユーザー アカウントでテストできるようになりました。
プラグインを使用する
ブラウザーで Teams を開き、プラグインのアップロードに使用した Microsoft 365 アカウントでサインインします。
左側のアクティビティ バーで [ チャット ] を選択します。
[チャット] ウィンドウで [Copilot] を選択します。
右側の [エージェント] リストで [ 予算トラッカー ] を選択します。 一覧が表示されない場合は、右上隅にある Copilot チャットなどの アイコンを選択します。
![Microsoft Teamsの [エージェント] リストのスクリーンショット](assets/images/api-plugins/copilot-agents.png)
予算に関する質問をする。 たとえば、
How much is left in the Fourth Coffee lobby renovation budget?してみてください。 メッセージが表示されたら、[ 常に許可 ] または [1 回許可] を選択して続行します。サインインするように求められたら、[ 予算トラッカーにサインインする] を選択します。