次の方法で共有

Microsoft 365 Copilot 用の既存の API から API プラグインを構築する

重要

API プラグインは、 宣言型エージェント内のアクションとしてのみサポートされます。 Microsoft 365 Copilot では有効になっていません。

API プラグインは、既存の REST API を Microsoft 365 Copilot に接続します。 Microsoft 365 Agents Toolkit を使用して、OpenAPI 仕様の既存の REST API からプラグインを生成できます。

前提条件

ヒント

最適な結果を得るには、「OpenAPI ドキュメントを Copilot の拡張に有効にする方法」に記載されているガイドラインに従ってください。

このガイドに従うために、 Budget Tracker サンプル API を ダウンロードし、ローカル開発マシンで実行するように構成します。 サンプルを少なくとも 1 回ビルドして、API の BudgetTracker.json ファイルを生成します。

プラグインを作成する

注:

このドキュメントの Microsoft 365 Agents Toolkit のユーザー インターフェイスのスクリーンショットと参照は、最新 のリリース バージョン 6.0 を使用して生成されました。 エージェント ツールキットのプレリリース バージョンは、このドキュメントのユーザー インターフェイスとは異なる場合があります。

API プラグインは、次のファイルを含む ZIP ファイルです。

  • REST API の OpenAPI 仕様。
  • 含まれている OpenAPI 仕様を参照し、使用可能な操作、認証方法、応答形式について説明する API プラグイン マニフェスト 。

  1. Visual Studio Code を開きます。 エージェント ツールキットがまだインストールされていない場合は、インストール手順については、「 エージェント ツールキットのインストール 」を参照してください。

  2. 左側のアクティビティ バーで [Microsoft 365 Agents Toolkit ] アイコンを選択します。

  3. [エージェント ツールキット] 作業ウィンドウで [ 新しいエージェント/アプリの作成 ] を選択します。

    エージェント ツールキット インターフェイスのスクリーンショット

  4. [ 宣言型エージェント] を選択します。

  5. [ アクションの追加] を選択し、[ OpenAPI Description Document で開始] を選択します。

  6. [ 参照] を選択し、 ./openapi/BudgetTracker.jsonにある予算トラッカー サンプルから OpenAPI 仕様の場所を参照します。

  7. プラグインに対して有効にする操作をすべて選択します。

    操作を選択するエージェント ツールキット UI

  8. API プラグイン プロジェクトの場所を選択します。

  9. プラグインの名前として「 Budget Tracker 」と入力します。

これらの手順を完了すると、Agents Toolkit によってプラグインに必要なファイルが生成され、プラグイン プロジェクトが読み込まれた新しい Visual Studio Code ウィンドウが開きます。

注:

ID サーバーで Proof Key for Code Exchange (PKCE) が必要な場合は、API プラグイン プロジェクトの m365agents.yml で次の行のコメントを解除します。

# isPKCEEnabled: true

プラグインをパッケージ化してサイドロードする

  1. Visual Studio Code でプラグイン プロジェクトを開きます。

  2. 左側のアクティビティ バーで [Microsoft 365 Agents Toolkit ] アイコンを選択します。

  3. [ アカウント ] ウィンドウ で、[Microsoft 365 にサインイン] を選択します。 (既にサインインしている場合は、次の手順に進みます)。

  4. Microsoft 365 アカウントの [ カスタム アプリアップロードが有効] と [ Copilot Access Enabled]\(有効\) の両方が表示されていることを確認します。 そうでない場合は、organization管理者とチェックします。詳細については、「Copilot 機能拡張オプションの要件」を参照してください。

  5. [ ライフサイクル ] ウィンドウで、[ プロビジョニング] を選択します。

  6. OAuth 登録のクライアント ID を入力するように求められたら、プラグイン クライアント ID を入力します。

  7. OAuth 登録用のクライアント シークレットを入力するように求められたら、プラグイン クライアント シークレットを入力します。

  8. ダイアログでメッセージを読み、[ 確認 ] を選択して続行します。

  9. プロビジョニングが完了したツールキットが報告されるまで待ちます。

    プロビジョニングの成功を確認するエージェント ツールキット メッセージ

プラグインは、Microsoft Teamsの Microsoft 365 Copilot のユーザー アカウントでテストできるようになりました。

プラグインを使用する

  1. ブラウザーで Teams を開き、プラグインのアップロードに使用した Microsoft 365 アカウントでサインインします。

  2. 左側のアクティビティ バーで [ チャット ] を選択します。

  3. [チャット] ウィンドウで [Copilot] を選択します。

  4. 右側の [エージェント] リストで [ 予算トラッカー ] を選択します。 一覧が表示されない場合は、右上隅にある Copilot チャットなどの アイコンを選択します。

    Microsoft Teamsの [エージェント] リストのスクリーンショット

  5. 予算に関する質問をする。 たとえば、 How much is left in the Fourth Coffee lobby renovation budget?してみてください。 メッセージが表示されたら、[ 常に許可 ] または [1 回許可] を選択して続行します。

  6. サインインするように求められたら、[ 予算トラッカーにサインインする] を選択します。

  • Last updated on