Teams で AI エージェントボットを構築する

[アーティクル]
09/16/2024

Microsoft Teamsの AI エージェントは、大規模言語モデル (LLM) を使用してユーザーと対話する会話型チャットボットです。ユーザーの意図を理解し、一連のアクションを選択して、チャットボットが一般的なタスクを完了できるようにします。

前提条件

インストール	使用するには...
Visual Studio Code	JavaScript、TypeScript、または Python ビルド環境。最新バージョンを使用します。
Teams ツールキット	アプリのプロジェクトスキャフォールディングを作成する Microsoft Visual Studio Code 拡張機能。最新バージョンを使用します。
Node.js	バックエンド JavaScript ランタイム環境。詳細については、「プロジェクトの種類Node.js バージョン互換性テーブル」を参照してください。
Microsoft Teams	Microsoft Teams、チャット、会議、通話のアプリを通じて作業するすべてのユーザーと 1 か所で共同作業を行うことができます。
Azure OpenAI	最初に OpenAI API キーを作成して、OpenAI の生成済み事前トレーニングトランスフォーマー (GPT) を使用します。アプリをホストする場合、または Azure でリソースにアクセスする場合は、Azure OpenAI サービスを作成する必要があります。

新しい AI エージェントプロジェクトを作成する

Visual Studio Code を開きます。
Visual Studio Code アクティビティバーの [Teams Toolkit ] アイコンを選択します
[ 新しいアプリの作成] を選択します。

$Teams Toolkit サイドバーの [Create New Project]$新しいプロジェクトの作成$ リンクの場所を示すスクリーンショット。$
[ カスタムエンジンエージェント] を選択します。
[ AI エージェント] を選択します。

アプリをビルドするには、次のいずれかのオプションを選択します。

新しいビルド
Assistants API

[ Build New]$新規作成$ を選択します。
[ JavaScript] を選択します。
既定では 、OpenAI サービスが選択され、必要に応じて、OpenAI にアクセスするための資格情報を入力できます。 Enter キーを押します。
[ 既定のフォルダー] を選択します。

既定の場所を変更するには、次の手順に従います。
1. [ 参照] を選択します。
2. プロジェクトワークスペースの場所を選択します。
3. [ フォルダーの選択] を選択します。
アプリのアプリ名を入力し、 Enter キーを選択します。

AI エージェントボットが正常に作成されました。
[エクスプローラー] で、env>.env.testtool.user ファイルに移動します。
次の値を更新します。
- SECRET_AZURE_OPENAI_API_KEY=<your-key>
- AZURE_OPENAI_ENDPOINT=<your-endpoint>
- AZURE_OPENAI_DEPLOYMENT_NAME=<your-deployment>
アプリをデバッグするには、 F5 キーを選択するか、左側のウィンドウで [ 実行とデバッグ] (Ctrl + Shift + D) を選択し、ドロップダウンリストから [ テストツール (プレビュー)] で [デバッグ ] を選択します。

テストツールは、Web ページでボットを開きます。

ボットアプリのソースコードのツアーを開始する

フォルダー	コンテンツ
`.vscode`	デバッグ用の Visual Studio Code ファイル。
`appPackage`	Teams アプリマニフェストのテンプレート。
`env`	環境ファイル。
`infra`	Azure リソースをプロビジョニングするためのテンプレート。
`src`	アプリのソースコード。

次のファイルをカスタマイズでき、実装の例を示して作業を開始できます。

File	コンテンツ
`src/index.js`	ボットアプリサーバーを設定します。
`src/adapter.js`	ボットアダプターを設定します。
`src/config.js`	環境変数を定義します。
`src/prompts/planner/skprompt.txt`	プロンプトを定義します。
`src/prompts/planner/config.json`	プロンプトを構成します。
`src/prompts/planner/actions.json`	アクションを定義します。
`src/app/app.js`	AI エージェントのビジネスロジックを処理します。
`src/app/messages.js`	メッセージアクティビティハンドラーを定義します。
`src/app/actions.js`	AI アクションを定義します。

Teams Toolkit 固有のプロジェクトファイルを次に示します。 Teams Toolkit のしくみの詳細については、 GitHub の完全なガイドを参照してください。

File	コンテンツ
`teamsapp.yml`	これは、Teams Toolkit プロジェクトファイルメインです。プロジェクトファイルは、プロパティと構成ステージの定義を定義します。
`teamsapp.local.yml`	これにより、ローカル実行とデバッグを有効にするアクションで `teamsapp.yml` がオーバーライドされます。
`teamsapp.testtool.yml`	これにより、Teams アプリテストツールでローカル実行とデバッグを有効にするアクションで `teamsapp.yml` がオーバーライドされます。

[ Build with Assistants API Preview]$アシスタントを使用したビルド API プレビュー$ を選択します。
[ JavaScript] を選択します。
注:
- ビルドエージェントが [Assistants API を使用したビルド] として選択されている場合、Azure OpenAI サービスは Assistants API のサポートを提供していません。
- Teams AI ライブラリの AssistantsPlanner はプレビュー段階です。
[ Azure OpenAI ] または [OpenAI] を選択します。
選択したサービスに基づいて 、Azure OpenAI または OpenAI の資格情報を入力します。 Enter キーを押します。
Enter キーを押します。
[ 既定のフォルダー] を選択します。

既定の場所を変更するには、次の手順に従います。
1. [ 参照] を選択します。
2. プロジェクトワークスペースの場所を選択します。
3. [ フォルダーの選択] を選択します。
アプリのアプリ名を入力し、 Enter キーを選択します。

AI エージェントボットが正常に作成されました。

独自の OpenAI アシスタントを作成する

ボットを実行またはデバッグする前に、次の手順に従って独自の OpenAI Assistant を設定します。

まだアシスタントを設定していない場合
- このアプリテンプレートは、アシスタントの作成に役立つスクリプト src/creator.jsを提供します。スクリプトの指示と設定を変更して、アシスタントをカスタマイズできます。
- 作成後、 OpenAI でアシスタントを変更および管理できます。
1. ターミナルを開き、次のコマンドを実行して、すべての依存関係パッケージをインストールします。
```
> npm install
```
2. 次のコマンドを実行して、アシスタントを実行します。
```
> npm run assistant:create -- <your-openai-api-key>
```
3. [Create a new アシスタント]$新しいアシスタントの作成$ の ID が [asst_xxx...] という出力が表示されます。
Visual Studio Code の [エクスプローラー] で、env>.env.*.users ファイルを選択します。
次の値を更新します。
- SECRET_OPENAI_API_KEY=<your-openai-api-key>
- OPENAI_ASSISTANT_ID=<your-openai-assistant-id>
アプリをデバッグするには、 F5 キーを選択するか、左側のウィンドウで [ 実行とデバッグ] (Ctrl + Shift + D) を選択し、ドロップダウンリストから [ テストツール (プレビュー)] で [デバッグ ] を選択します。

テストツールは、Web ページでボットを開きます。

ボットアプリのソースコードのツアーを開始する

フォルダー	コンテンツ
`.vscode`	デバッグ用の Visual Studio Code ファイル。
`appPackage`	Teams アプリケーションマニフェストのテンプレート。
`env`	環境ファイル。
`infra`	Azure リソースをプロビジョニングするためのテンプレート。
`src`	アプリケーションのソースコード。

次のファイルをカスタマイズでき、実装の例を示して作業を開始できます。

File	コンテンツ
`src/index.js`	ボットアプリサーバーを設定します。
`src/adapter.js`	ボットアダプターを設定します。
`src/config.js`	環境変数を定義します。
`src/creator.js`	OpenAI Assistant を作成するための 1 回限りのツール。
`src/app/app.js`	AI エージェントのビジネスロジックを処理します。
`src/app/messages.js`	メッセージアクティビティハンドラーを定義します。
`src/app/actions.js`	AI アクションを定義します。

Teams Toolkit 固有のプロジェクトファイルを次に示します。 Teams Toolkit のしくみの詳細については、 GitHub の完全なガイドを参照してください。

File	コンテンツ
`teamsapp.yml`	これは、Teams Toolkit プロジェクトファイルメインです。プロジェクトファイルには、プロパティと構成ステージ定義という 2 つの主要な要素が定義されています。
`teamsapp.local.yml`	これにより、ローカル実行とデバッグを有効にするアクションで `teamsapp.yml` がオーバーライドされます。
`teamsapp.testtool.yml`	これにより、Teams アプリテストツールでローカル実行とデバッグを有効にするアクションで `teamsapp.yml` がオーバーライドされます。

Teams AI ライブラリを使用して AI エージェントを作成する

新しいビルド

Teams AI ライブラリには、独自の AI エージェントを構築するプロセスを簡略化する包括的なフローが用意されています。理解する必要がある重要な概念は次のとおりです。

アクション: アクションは、AI システムに登録されるアトミック関数です。
Planner: プランナーは、プロンプトまたはプロンプトテンプレートの形式でユーザーの要求を受け取り、それを満たす計画を返します。これは、AI を使用して、AI システムに登録されているアクションと呼ばれるアトミック関数を混在させて照合することで実現されます。これらのアクションは、目標を完了する一連の手順に組み込まれます。
アクション Planner: アクション Plannerは LLM を使用してプランを生成します。パラメーター化されたアクションをトリガーし、テキストベースの応答をユーザーに送信できます。

Assistants API を使用したビルド

OpenAI の Assistants API は、AI エージェントの作成の開発作業を簡略化します。プラットフォームとしての OpenAI には、コードインタープリター、ナレッジ取得、関数呼び出しなどの事前構築済みのツールが用意されており、一般的なシナリオで記述する必要があるコードが簡略化されます。

比較	新しいビルド	Assistants API を使用したビルド
コスト	LLM サービスのコストのみ	LLM サービスのコストと、Assistants API でツールを使用する場合は、追加のコストが発生します。
開発作業	中	比較的小さい
LLM サービス	Azure OpenAI または OpenAI	OpenAI のみ
テンプレートの実装例	このアプリテンプレートは、チャットを行い、ユーザーがタスクを管理するのに役立ちます。	このアプリテンプレートでは、コードインタープリターツールを使用して数学の問題を解決し、関数呼び出しツールを使用して都市の天気を取得します。
制限事項	該当なし	Teams AI ライブラリでは、ナレッジ取得ツールはサポートされていません。

アプリテンプレートをカスタマイズする

プロンプト拡張をカスタマイズする

SDK には、プロンプトを拡張する機能が用意されています。

src/prompts/planner/actions.json ファイルで定義されているアクションがプロンプトに挿入されます。これにより、LLM は使用可能な関数を認識できます。
プロンプトテキストの内部部分がプロンプトに挿入され、LLM に、使用可能な関数に基づいて呼び出す関数を決定するように指示します。このプロンプトテキストは、構造化された json 形式で応答を生成するために LLM を注文します。
SDK は LLM 応答を検証し、応答の形式が間違っている場合に LLM で応答を修正または絞り込むことができます。

src/prompts/planner/config.json ファイルで、augmentation.augmentation_typeを構成します。以下のオプションがあります:

Sequence: 複数のステップまたは複雑なロジックを必要とするタスクに適しています。
Monologue:自然言語の理解と生成、柔軟性と創造性を必要とするタスクに適しています。

新しい追加関数をビルドする

src/prompts/planner/actions.json ファイルで、アクションスキーマを定義します。

[
    ...
    {
        "name": "myFunction",
        "description": "The function description",
        "parameters": {
            "type": "object",
            "properties": {
                "parameter1": {
                    "type": "string",
                    "description": "The parameter1 description"
                },
            },
            "required": ["parameter1"]
        }
    }
]

src/app/actions.ts ファイルで、アクションハンドラーを定義します。

// Define your own function
export async function myFunction(context: TurnContext, state: TurnState, parameters): Promise<string> {
  // Implement your function logic
  ...
  // Return the result
  return "...";
}

src/app/app.ts ファイルで、アクションを登録します。
```
app.ai.action("myFunction", myFunction);
```

アシスタント作成をカスタマイズする

src/creator.ts ファイルによって、新しい OpenAI Assistant が作成されます。命令、モデル、ツール、関数などのパラメーターを更新することで、アシスタントをカスタマイズできます。

Assistants API add Functions を使用したビルド

アシスタントが関数とその引数を提供して実行する場合、SDK はこの関数を事前登録されたアクションに合わせます。後でアクションハンドラーをアクティブ化し、結果をアシスタントに送信します。関数を統合するには、アプリ内でアクションを登録します。

src/app/actions.ts ファイルで、アクションハンドラーを定義します。

// Define your own function
export async function myFunction(context: TurnContext, state: TurnState, parameters): Promise<string> {
  // Implement your function logic
  ...
  // Return the result
  return "...";
}

src/app/app.ts ファイルで、アクションを登録します。
```
app.ai.action("myFunction", myFunction);
```

次の方法で共有

Teams で AI エージェントボットを構築する

前提条件

新しい AI エージェントプロジェクトを作成する

ボットアプリのソースコードのツアーを開始する

ボットアプリのソースコードのツアーを開始する

Teams AI ライブラリを使用して AI エージェントを作成する

新しいビルド

Assistants API を使用したビルド

アプリテンプレートをカスタマイズする

プロンプト拡張をカスタマイズする

新しい追加関数をビルドする

アシスタント作成をカスタマイズする

Assistants API add Functions を使用したビルド

関連項目

その他のリソース

次の方法で共有

Teams で AI エージェント ボットを構築する

前提条件

新しい AI エージェント プロジェクトを作成する

ボット アプリのソース コードのツアーを開始する

Teams AI ライブラリを使用して AI エージェントを作成する

新しいビルド

Assistants API を使用したビルド

アプリ テンプレートをカスタマイズする

プロンプト拡張をカスタマイズする

新しい追加関数をビルドする

アシスタント作成をカスタマイズする

Assistants API add Functions を使用したビルド

関連項目

その他のリソース

Teams で AI エージェントボットを構築する

新しい AI エージェントプロジェクトを作成する

ボットアプリのソースコードのツアーを開始する

アプリテンプレートをカスタマイズする