基本的な AI チャットボットを構築する

AI チャットボット テンプレートには、ChatGPTと同様に、ユーザーの質問に応答し、ユーザーがMicrosoft Teamsで AI ボットと対話できるボット アプリが紹介されています。 Teams AI ライブラリ を使用してアプリ テンプレートを構築し、AI ベースの Teams アプリケーションを作成する機能を提供します。

前提条件

インストール	使用するには...
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 チャットボット プロジェクトを作成する

1. Visual Studio Code を開きます。

2. Visual Studio Code アクティビティ バーの [Teams Toolkit ] アイコンを選択します

3. [ 新しいアプリの作成] を選択します。

   

4. [ カスタム エンジン エージェント] を選択します。

   

5. [ Basic AI Chatbot] を選択します。

   

6. [ JavaScript] を選択します。

   

7. [ Azure OpenAI] を選択します。

   

8. 選択したサービスに基づいて 、OpenAI または Azure OpenAI の資格情報を入力します。 Enter キーを押します。

   

9. [ 既定のフォルダー] を選択します。

   

   既定の場所を変更するには、次の手順に従います。

   1. [ 参照] を選択します。
   2. プロジェクト ワークスペースの場所を選択します。
   3. [ フォルダーの選択] を選択します。

10. アプリのアプリケーション名を入力し、 Enter キーを選択します。

    

    AI チャット ボット プロジェクト ワークスペースが正常に作成されました。

    

11. [エクスプローラー] で、env>.env.testtool.user ファイルに移動します。

12. 次の詳細を更新します。

    • SECRET_AZURE_OPENAI_API_KEY=<your-key>
    • AZURE_OPENAI_ENDPOINT=<your-endpoint>
    • AZURE_OPENAI_DEPLOYMENT_NAME=<your-deployment>

    

13. アプリをデバッグするには、 F5 キーを選択するか、左側のウィンドウで [ 実行とデバッグ] (Ctrl + Shift + D) を選択し、ドロップダウン リストから [ テスト ツール (プレビュー)] で [デバッグ ] を選択します。

    

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

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

JavaScript

フォルダー	コンテンツ
.vscode	デバッグ用の Visual Studio Code ファイル。
appPackage	Teams アプリケーション マニフェストのテンプレート。
env	環境ファイル。
infra	Azure リソースをプロビジョニングするためのテンプレート。
src	アプリケーションのソース コード。
teamsapp.yml	これは、Teams Toolkit プロジェクト ファイルメインです。 プロジェクト ファイルには、プロパティと構成ステージ定義という 2 つの主要な要素が定義されています。
teamsapp.local.yml	これにより、ローカル実行とデバッグを有効にするアクションで teamsapp.yml がオーバーライドされます。
teamsapp.testtool.yml	これにより、Teams アプリ テスト ツールでローカル実行とデバッグを有効にするアクションで teamsapp.yml がオーバーライドされます。
src/index.js	ボット アプリ サーバーを設定します。
src/adapter.js	ボット アダプターを設定します。
src/config.js	環境変数を定義します。
src/prompts/chat/skprompt.txt	プロンプトを定義します。
src/prompts/chat/config.json	プロンプトを構成します。
src/app/app.js	基本的な AI チャットボットのビジネス ロジックを処理します。

Python

File	コンテンツ
.vscode	デバッグ用の Visual Studio Code ファイル。
appPackage	Teams アプリケーション マニフェストのテンプレート。
env	環境ファイル。
infra	Azure リソースをプロビジョニングするためのテンプレート。
src	アプリケーションのソース コード。
teamsapp.yml	これは、Teams Toolkit プロジェクト ファイルメインです。 プロジェクト ファイルには、プロパティと構成ステージ定義という 2 つの主要な要素が定義されています。
teamsapp.local.yml	これにより、ローカル実行とデバッグを有効にするアクションで teamsapp.yml がオーバーライドされます。
teamsapp.testtool.yml	これにより、Teams アプリ テスト ツールでローカル実行とデバッグを有効にするアクションで teamsapp.yml がオーバーライドされます。
src/app.py	aiohttp API サーバーをホストし、アプリ モジュールをエクスポートします。
src/bot.py	基本的な AI チャットボットのビジネス ロジックを処理します。
src/config.py	環境変数を定義します。
src/prompts/chat/skprompt.txt	プロンプトを定義します。
src/prompts/chat/config.json	プロンプトを構成します。

Teams AI チャットボットのしくみ

Teams AI ライブラリには、次のように AI 機能を備えたインテリジェント なチャットボットを構築するためのフローが用意されています。

• TurnContext: ターン コンテキスト オブジェクトは、送信者と受信者、チャネル、アクティビティの処理に必要なその他のデータなど、アクティビティに関する情報を提供します。

• TurnState: ターン状態オブジェクトは、Cookie と同様に、現在のターンのデータを格納します。 このオブジェクトは、ターン コンテキストとして、アクティビティ ハンドラーや AI システムなど、アプリケーション ロジック全体を介して実行されます。

• 認証: ユーザー認証が構成されている場合、Teams AI はユーザーのサインインを試みます。 ユーザーが既にサインインしている場合、SDK はアクセス トークンを取得して続行します。 それ以外の場合、SDK はサインイン フローを開始し、現在のターンを終了します。

• アクティビティ ハンドラー: Teams AI ライブラリは、登録されたアクティビティ ハンドラーのセットを実行し、複数の種類のアクティビティを処理できるようにします。 アクティビティ ハンドラー システムは、ボットまたはメッセージ拡張アプリ ロジックを実装するための主要な方法です。 これは、着信アクティビティに基づいてトリガーされる、ルート ハンドラーと呼ばれるコールバックを登録できる一連のメソッドと構成です。 受信アクティビティは、メッセージ、メッセージのリアクション、または Teams アプリ内のほぼすべての操作の形式にすることができます。

• AI システム: Teams AI ライブラリの AI システムは、入力と出力のモデレート、プランの生成、実行を担当します。 これは、スタンドアロンとして使用することも、アプリ オブジェクトによって にルーティングすることもできます。 重要な概念は次のとおりです。

  1. プロンプト マネージャー: プロンプトは、大規模言語モデル (LLM) AI の動作を伝え、指示する上で重要な役割を果たします。
  2. Planner: プランナーは、プロンプトまたはプロンプト テンプレートの形式でユーザーの要求を受け取り、それを満たす計画を返します。 これは、AI を使用して、AI システムに登録されているアクションと呼ばれるアトミック関数を混在させて照合することで実現されます。 これらのアクションは、目標を完了する一連の手順に組み込まれます。
  3. アクション: アクションは、AI システムに登録されるアトミック関数です。

• AfterTurn ハンドラー: アクティビティ ハンドラーまたは AI システムが実行された後、Teams AI ライブラリは afterTurn ハンドラーを実行します。 ハンドラーを使用すると、ターン後にアクションを実行できます。 trueとして返された場合、SDK はターン状態をストレージに保存します。

• ユーザーに応答する: Teams AI ライブラリは状態を保存し、ボットは応答をユーザーに送信できます。

基本的な AI チャットボットをカスタマイズする

次のように、基本的なアプリの上にカスタマイズを追加して、複雑なシナリオを構築できます。

1. プロンプトのカスタマイズ: プロンプトは、LLMs AI の動作を伝え、指示する上で重要な役割を果たします。 これらは、ユーザーがモデルから特定の応答を引き出すために提供できる入力またはクエリとして機能します。 LLM に名前の提案を求めるプロンプトを次に示します。

   要求

   Give me 3 name suggestions for my pet golden retriever.
   

   Response

   Some possible name suggestions for a pet golden retriever are:
   - Bailey
   - Sunny
   - Cooper
   

   Teams Toolkit で生成されたプロジェクトを使用するには、 src/prompts/chat/skprompt.txt ファイルでプロンプトを作成します。 このファイルに書き込まれたプロンプトは、LLM に指示するために使用されるプロンプトに挿入されます。 Teams AI ライブラリでは、プロンプト テキストで使用できる次の構文が定義されています。

   構文 1

   1. {{ $[scope].property }}: Teams AI ライブラリは、ターン状態内でスコープが設定され、定義されているプロパティの値をレンダリングします。 一時、ユーザー、会話の 3 つのスコープを定義します。 スコープが指定されていない場合、ライブラリは既定で一時スコープを使用します。

   2. {{$[scope].property}}は、次の方法で使用されます。

      JavaScript

      1. src/app/turnState.ts ファイルで、一時状態、ユーザー状態、会話状態、アプリのターン状態を定義します。 turnState.ts ファイルがプロジェクトに存在しない場合は、src/appの下に作成します。

         import { DefaultConversationState, DefaultTempState, DefaultUserState, TurnState } from "@microsoft/teams-ai";
         
         export interface TempState extends DefaultTempState {  }
         export interface UserState extends DefaultUserState {  }
         export interface ConversationState extends DefaultConversationState {
             tasks: Record<string, Task>;
         }
         
         export interface Task {
             title: string;
             description: string;
         }
         
         export type ApplicationTurnState = TurnState<ConversationState, UserState, TempState>;
         

      2. src/app/app.ts ファイルで、アプリのターン状態を使用してアプリを初期化します。

         const storage = new MemoryStorage();
         const app = new Application<ApplicationTurnState>({
           storage,
           ai: {
             planner,
           },
         });
         

      3. src/prompts/chat/skprompt.txt ファイルで、スコープ付き状態プロパティ ({{$conversation.tasks}} など) を使用します。

      Python

      1. src/state.py ファイルで、一時状態、ユーザー状態、会話状態、アプリのターン状態を定義します。

         from teams.state import TempState, ConversationState, UserState, TurnState
         
         class AppConversationState(ConversationState):
         tasks: Dict[str, Task] # Your data definition here
         
             @classmethod
             async def load(cls, context: TurnContext, storage: Optional[Storage] = None) -> "AppConversationState":
                 state = await super().load(context, storage)
                 return cls(**state)
         
         class AppTurnState(TurnState[AppConversationState, UserState, TempState]):
             conversation: AppConversationState
         
             @classmethod
             async def load(cls, context: TurnContext, storage: Optional[Storage] = None) -> "AppTurnState":
                 return cls(
                     conversation=await AppConversationState.load(context, storage),
                     user=await UserState.load(context, storage),
                     temp=await TempState.load(context, storage),
                 )
         

      2. src/bot.py ファイルで、ユーザー アプリの状態を回してアプリを初期化します。

         from state import AppTurnState
         
         app = Application[AppTurnState](...)
         

      3. src/prompts/chat/skprompt.txt ファイルで、スコープ付き状態プロパティ ({{$conversation.tasks}} など) を使用します。 `

   構文 2

   1. {{ functionName }}: 外部関数を呼び出して結果をテキストに埋め込むには、 {{ functionName }} 構文を使用します。 たとえば、タスク 項目の一覧を返すことができる getTasks という関数がある場合は、結果をプロンプトに埋め込むことができます。

      JavaScript

      1. src/app/app.ts ファイルのプロンプト マネージャーに関数を登録します。

         prompts.addFunction("getTasks", async (context: TurnContext, memory: Memory, functions: PromptFunctions, tokenizer: Tokenizer, args: string[]) => {
         return ...
         });
         

      2. src/prompts/chat/skprompt.txt: Your tasks are: {{ getTasks }}で 関数を使用します。

      Python

      1. src/bot.py ファイルのプロンプト マネージャーに関数を登録します。

         @prompts.function("getTasks")
         async def get_tasks(
             _context: TurnContext,
             state: MemoryBase,
             _functions: PromptFunctions,
             _tokenizer: Tokenizer,
             _args: List[str],
         ):
             return state.get("conversation.tasks")
         

      2. src/prompts/chat/skprompt.txt: Your tasks are: {{ getTasks }}で 関数を使用します。

   構文 3

   {{ functionName arg1 arg2 }}: この構文を使用すると、指定された引数を使用して指定された関数を呼び出し、結果をレンダリングできます。 関数の呼び出しの使用法と同様に、次のことができます。

   1. プロンプト マネージャーで関数を登録します。

      • JavaScript 言語の場合は、 src/app/app.tsに登録します。
      • Python 言語の場合は、 src/bot.pyに登録します。

   2. src/prompts/chat/skprompt.txt: Your task の関数は{{ getTasks taskTitle }}' で使用します。

2. ユーザー入力をカスタマイズする: Teams AI ライブラリを使用すると、ユーザー入力を含めることで LLM に送信されるプロンプトを拡張できます。 ユーザー入力を含める場合は、src/prompts/chat/config.jsonで true にcompletion.include_inputを設定して、プロンプト構成ファイルで指定する必要があります。 必要に応じて、completion.max_input_tokensを変更することで、src/prompts/chat/config.jsonのユーザー入力トークンの最大数を構成することもできます。 これは、トークンの制限を超えないようにユーザー入力の長さを制限する場合に便利です。

3. 会話履歴のカスタマイズ: SDK によって会話履歴が自動的に管理され、次のようにカスタマイズできます。

   • src/prompts/chat/config.jsonで、completion.include_historyを構成します。 true場合、LLM が会話コンテキストを認識できるように、履歴がプロンプトに挿入されます。

   • 履歴メッセージの最大数。 PromptManagerを初期化するときにmax_history_messagesを構成します。

     JavaScript

     
     const prompts = new PromptManager({
     promptsFolder: path.join(__dirname, "../prompts"),
     max_history_messages: 3,
     });
     

     Python

     
     prompts = PromptManager(PromptManagerOptions(
         prompts_folder=f"{os.getcwd()}/prompts",
         max_history_messages=3,
     ))
     
     

   • 履歴トークンの最大数。 PromptManagerを初期化するときに、max_conversation_history_tokens を構成します。

     JavaScript

     
     const prompts = new PromptManager({
         promptsFolder: path.join(__dirname, "../prompts"),
         max_conversation_history_tokens: 1000,
     });
     
     

     Python

     
     prompts = PromptManager(PromptManagerOptions(
         prompts_folder=f"{os.getcwd()}/prompts",
         max_conversation_history_tokens=1000,
     ))
     
     

4. モデルの種類をカスタマイズする: プロンプトに特定のモデルを使用できます。 src/prompts/chat/config.json ファイルで、completion.modelを構成します。 プロンプトに対してモデルが構成されていない場合は、 OpenAIModel で構成された既定のモデルが使用されます。

   SDK をサポートするモデルは次のとおりです。

   モデル	サポートされている
   gpt-3.5-turbo	サポート
   gpt-3.5-turbo-16k	サポートされている
   gpt-3.5-turbo-instruct	1.1.0 からサポートされていません
   gpt-4	サポート
   gpt-4-32k	サポートされている
   gpt-4-vision	サポートされている
   gpt-4-turbo	サポートされている
   DALL·E	非サポート
   囁く	サポート対象外
   TTS	非サポート

5. モデル パラメーターをカスタマイズする:

   src/prompts/chat/config.json ファイルで、完了時にモデル パラメーターを次のように構成します。

   • Max_tokens: 生成するトークンの最大数。
   • 温度: 温度を 0 ~ 2 の数値としてモデルします。
   • Top_p: モデルは、0 から 2 までの数値として top_p されます。
   • Presence_penalty: モデルは、0 ~ 1 の数値として presence_penalty されます。
   • Frequency_penalty: モデルは、0 ~ 1 の数値として frequency_penalty されます。
   • Stop_sequences: ヒット時に生成を停止する停止シーケンスの配列。

関連項目

Teams AI ライブラリ