Share via


Teams AI ライブラリのクイック スタート ガイド

LightBot サンプルを使用して Teams AI ライブラリの使用を開始します。これは、Teams AI ライブラリを使用してライトをオンまたはオフにするなど、ライトを制御できるアプリを作成するプロセスを支援するように設計されています。 ボットでは、gpt-3.5-turbo モデルを使用して Microsoft Teams ユーザーとチャットし、会話の範囲内に留まり、丁寧で敬意を払って対応します。

前提条件

開始するには、次のツールがあることを確認します。

インストール 使用するには...
Visual Studio Code JavaScript、TypeScript、Python ビルド環境。 最新バージョンを使用します。
Teams ツールキット アプリのプロジェクト スキャフォールディングを作成する Microsoft Visual Studio Code 拡張機能。 最新バージョンを使用します。
Git Git は、リポジトリ内のさまざまなバージョンのコードを管理するのに役立つバージョン管理システムです。
Node.js バックエンド JavaScript ランタイム環境。 詳細については、「 プロジェクトの種類Node.js バージョン互換性テーブル」を参照してください
Microsoft Teams すべてのユーザーと共同作業を行うには、チャット、会議、通話のアプリを 1 か所で操作します。
OpenAI または Azure OpenAI 最初に OpenAI API キーを作成して、OpenAI の GPT を使用します。 Microsoft Azure でアプリをホストしたりリソースにアクセスしたりする場合は、Azure OpenAI サービスを作成する必要があります。
Microsoft Edge (推奨) または Google Chrome 開発者ツールを備えたブラウザー。
Microsoft 365 開発者アカウント アプリをインストールし、カスタム Teams アプリを有効にし、カスタム アプリの アップロードを有効にする適切なアクセス許可を持つ Teams アカウントにアクセスします。

ランタイム エラーが発生する前に既にサンプルを実行している場合は、次の手順に従って新たに開始します。
  • サンプル内のすべての .env ファイルと env/.env.*.* ファイルを確認し、自動的に設定された値を削除して、Teams Toolkit が新しいリソースを生成することを確認します。
  • Teams Toolkit でアプリ ID とパスワードを生成したくない場合は、ファイル内の と BOT_PASSWORD を独自の.env値で更新BOT_IDします。
  • 競合を回避するために、ファイル内 のSECRET_BOT_PASSWORDTEAMS_APP_UPDATE_TIME の値を .env 削除するか、空白のままにします。

Teams Toolkit では、自動的にプロビジョニングとリソースがプロビジョニングされますBOT_IDBOT_PASSWORD。 独自のリソースを使用する場合は、ファイルに手動で追加する .env 必要があります。 Teams Toolkit では、次のリソースは自動生成されません。

  • Azure OpenAI または OpenAI キー
  • データベースまたは同様のストレージ オプション

サンプル アプリをビルドして実行する

LightBot サンプルを使用して Teams AI ライブラリの使用を開始します。 これにより、コンピューターの localhost で Teams AI ライブラリ ベースのサンプルをすばやく実行できます。

  1. サンプルに移動します。

  2. 次のコマンドを実行して、リポジトリを複製します。

    git clone https://github.com/microsoft/teams-ai.git
    
  3. Visual Studio Code に移動します。

  4. [ファイルを開く] フォルダーを>選択します。

  5. teams-ai リポジトリを複製した場所に移動し、 teams-ai フォルダーを選択します。

  6. [ フォルダーの選択] を選択します

    teams-ai フォルダーと [フォルダーの選択] オプションを示すスクリーンショット。

  7. [ターミナルの表示]> を選択します。 ターミナル ウィンドウが開きます。

  8. ターミナル ウィンドウで、次のコマンドを実行して js フォルダーに移動します。

    cd .\js\
    
  9. 次のコマンドを実行して、依存関係をインストールします。

    yarn install
    
  10. 次のコマンドを実行して、依存関係を構築します。

    yarn build
    
  11. 依存関係がインストールされたら、[ ファイルフォルダーを>開く] を選択します。

  12. teams-ai > js > サンプル> 03.ai-concepts> c.actionMapping-lightBot に移動し、[フォルダーの選択] を選択します。 LightBot サンプルのすべてのファイルは、Visual Studio Code の [エクスプローラー ] セクションの下に一覧表示されます。

  13. 選択した AI サービスに基づいて、次の手順を更新します。

    1. フォルダーに env 移動し、ファイル内の次のコードを ./env/.env.local.user 更新します。

       SECRET_OPENAI_KEY=<your OpenAI key>
      
    2. フォルダーに infra 移動し、ファイル内の次の azure.bicep 行がコメントアウトされていることを確認します。

          // {
          //   name: 'AZURE_OPENAI_KEY'
          //   value: azureOpenAIKey
          // }
          // {
          //   name: 'AZURE_OPENAI_ENDPOINT'
          //   value: azureOpenAIEndpoint
          // }
      
  14. 左側のウィンドウで、[ Teams ツールキット] を選択します。

  15. [ ACCOUNTS] で、次の手順に従ってサインインします。

    • Microsoft 365 アカウント
    • Azure アカウント
  16. アプリをデバッグするには、 F5 キーを選択します。

    ブラウザー タブで、ボットをテナントに追加するように要求する Teams Web クライアントが開きます。

  17. [追加] を選択します。

    LightBot アプリの追加を示すスクリーンショット。

    チャット ウィンドウが開きます。

  18. メッセージ作成領域で、ボットを呼び出すメッセージを送信します。

    LightBot 出力の例を示すスクリーンショット。

注:

初めてボットを構築する場合は、Visual Studio Code 用の Teams Toolkit 拡張機能を使用してボットをビルドすることをお勧めします。 「JavaScript を使用して最初のボット アプリをビルドする」を参照してください。

前提条件

開始するには、次のツールがあることを確認します。

インストール 使用するには...
Visual Studio C Sharp ビルド環境。 最新バージョンを使用します。
Teams ツールキット アプリのプロジェクト スキャフォールディングを作成する Microsoft Visual Studio Code 拡張機能。 最新バージョンを使用します。
Git Git は、リポジトリ内のさまざまなバージョンのコードを管理するのに役立つバージョン管理システムです。
Microsoft Teams すべてのユーザーと共同作業を行うには、アプリを使用してチャット、会議、通話をすべて 1 か所で行います。
OpenAI または Azure OpenAI 最初に OpenAI API キーを作成して、OpenAI の GPT を使用します。 Microsoft Azure でアプリをホストしたりリソースにアクセスしたりする場合は、Azure OpenAI サービスを作成する必要があります。
Microsoft Edge (推奨) または Google Chrome 開発者ツールを備えたブラウザー。
Microsoft 365 開発者アカウント アプリをインストールし、カスタム Teams アプリを有効にし、カスタム アプリの アップロードを有効にする適切なアクセス許可を持つ Teams アカウントにアクセスします。

ランタイム エラーが発生する前に既にサンプルを実行している場合は、次の手順に従って新たに開始します。
  • サンプル内のすべての .env ファイルと env/.env.*.* ファイルを確認し、自動的に設定された値を削除して、Teams Toolkit が新しいリソースを生成することを確認します。
  • Teams Toolkit でアプリ ID とパスワードを生成したくない場合は、ファイル内の と MicrosoftAppPassword を独自の.env値で更新MicrosoftAppIdします。
  • 競合を回避するために、ファイル内 のSECRET_BOT_PASSWORDTEAMS_APP_UPDATE_TIME の値を .env 削除するか、空白のままにします。

Teams Toolkit では、自動的にプロビジョニングとリソースがプロビジョニングされますMicrosoftAppIdMicrosoftAppPassword。 独自のリソースを使用する場合は、ファイルに手動で追加する .env 必要があります。 Teams Toolkit では、次のリソースは自動生成されません。

  • Azure OpenAI または OpenAI キー
  • データベースまたは同様のストレージ オプション

サンプル アプリをビルドして実行する

  1. サンプルに移動します。

  2. リポジトリを複製して、サンプル アプリをテストします。

    git clone https://github.com/microsoft/teams-ai.git
    
  3. dotnet フォルダーに移動します。

    cd teams-ai/dotnet
    
  4. リポジトリを複製したフォルダーに移動し、 04.ai.c.actionMapping.lightBot を選択します。

  5. [ LightBot.sln] を選択します。 ソリューションが Visual Studio で開きます。

  6. Visual Studio で、ファイル内の OpenAI 関連の設定を appsettings.Development.json 更新します。

    "Azure": {
    "OpenAIApiKey": "<your-azure-openai-api-key>",
    "OpenAIEndpoint": "<your-azure-openai-endpoint>"
    },
    
  7. ファイル内skprompt.txtの次のコードにPrompts/sequence/skprompt.txt移動して更新します。

    The following is a conversation with an AI assistant. 
    The assistant can turn a light on or off.
    The assistant must return the following JSON structure:
    
    {"type":"plan","commands":[{"type":"DO","action":"<name>","entities":{"<name>":<value>}},{"type":"SAY","response":"<response>"}]}
    
    The following actions are supported:
    
    - LightsOn
    - LightsOff
    - Pause time=<duration in ms>
    - LightStatus
    
    The lights are currently {{getLightStatus}}.
    
    Always respond in the form of a JSON based plan. Stick with DO/SAY.
    
  8. [デバッグ] ドロップダウン メニューで、[Dev Tunnel>Create Tunnel... を選択します。

    Visual Studio の Dev Tunnel オプションと Create トンネル オプションの例を示すスクリーンショット。

  9. トンネルの作成に使用する アカウント を選択します。 Azure、Microsoft アカウント (MSA)、GitHub アカウントがサポートされています。 次のオプションを更新します。

    1. [名前]: トンネルの名前を入力します。
    2. トンネルの種類: [永続的] または [ 一時的] を選択します。
    3. アクセス: [ パブリック] を選択します。
    4. [OK] を選択します。 Visual Studio では、トンネルが作成されたことを示す確認メッセージが表示されます。

    作成したトンネルは、 Dev Tunnel (トンネル > の名前) の下に一覧表示されます。

  10. [ソリューション エクスプローラー] に移動し、プロジェクトを選択します。

  11. メニューを右クリックし、[Teams ツールキット>] [Teams アプリの依存関係の準備] を選択します。

    Visual Studio の [Teams ツールキット] セクションの [準備済み Teams アプリの依存関係] オプションの例を示すスクリーンショット。

    メッセージが表示されたら、Microsoft 365 アカウントにサインインします。 Teams アプリの依存関係が正常に準備されたことを示すメッセージが表示されます。

  12. [OK] を選択します。

  13. [F5] を選択するか、[デバッグ>の開始] を選択します。

  14. [追加] を選択します。 アプリが Teams に追加され、チャット ウィンドウが開きます。

    LightBot アプリの追加を示すスクリーンショット。

  15. メッセージ作成領域で、ボットを呼び出すメッセージを送信します。

    LightBot 出力の例を示すスクリーンショット。

Teams Toolkit を使用して、サンプルを Azure にデプロイすることもできます。 デプロイするには、次の手順に従います。

  1. Visual Studio で、[ソリューション エクスプローラー] に移動し、プロジェクトを選択します。
  2. メニューを右クリックし、[クラウドでのTeams Toolkit> プロビジョニング] を選択します。 Toolkit は、サンプルを Azure にプロビジョニングします。
  3. メニューを右クリックし、[Teams ToolkitDeploy to the Cloud]\(>クラウドへのデプロイ\) を選択します。

前提条件

開始するには、次のツールがあることを確認します。

インストール 使用するには...
Visual Studio Code JavaScript、TypeScript、Python ビルド環境。 最新バージョンを使用します。
Teams ツールキット アプリのプロジェクト スキャフォールディングを作成する Microsoft Visual Studio Code 拡張機能。 最新バージョンを使用します。
Python Python は、動的セマンティクスを持つ解釈されたオブジェクト指向のプログラミング言語です。 3.8 から 4.0 のバージョンを使用します。
Python 用の依存関係管理とパッケージ化ツール。
Python VSCode 拡張機能 VSCode での Python の豊富なサポートを提供します。
Git Git は、リポジトリ内のさまざまなバージョンのコードを管理するのに役立つバージョン管理システムです。
Microsoft Teams すべてのユーザーと共同作業を行うには、アプリを使用してチャット、会議、通話をすべて 1 か所で行います。
OpenAI または Azure OpenAI 最初に OpenAI API キーを作成して、OpenAI の GPT を使用します。 Microsoft Azure でアプリをホストしたりリソースにアクセスしたりする場合は、Azure OpenAI サービスを作成する必要があります。
Microsoft Edge (推奨) または Google Chrome 開発者ツールを備えたブラウザー。
Microsoft 365 開発者アカウント アプリをインストールし、カスタム Teams アプリを有効にし、カスタム アプリの アップロードを有効にする適切なアクセス許可を持つ Teams アカウントにアクセスします。

ランタイム エラーが発生する前に既にサンプルを実行している場合は、次の手順に従って新たに開始します。
  • サンプル内のすべての .env ファイルと env/.env.*.* ファイルを確認し、自動的に設定された値を削除して、Teams Toolkit が新しいリソースを生成することを確認します。
  • Teams Toolkit でアプリ ID とパスワードを生成したくない場合は、ファイル内の と BOT_PASSWORD を独自の.env値で更新BOT_IDします。
  • 競合を回避するために、ファイル内 のSECRET_BOT_PASSWORDTEAMS_APP_UPDATE_TIME の値を .env 削除するか、空白のままにします。

Teams Toolkit では、自動的にプロビジョニングとリソースがプロビジョニングされますBOT_IDBOT_PASSWORD。 独自のリソースを使用する場合は、ファイルに手動で追加する .env 必要があります。 Teams Toolkit では、次のリソースは自動生成されません。

  • Azure OpenAI または OpenAI キー
  • データベースまたは同様のストレージ オプション

サンプル アプリをビルドして実行する

  1. サンプルに移動します。

  2. リポジトリを複製して、サンプル アプリをテストします。

    git clone https://github.com/microsoft/teams-ai.git
    
  3. Python フォルダーに移動します。

    cd teams-ai/python
    
  4. リポジトリを複製したフォルダーに移動し、 04.ai.c.actionMapping.lightBot を選択します。 LightBot サンプルのすべてのファイルは、Visual Studio Code の [エクスプローラー ] セクションの下に一覧表示されます。

  5. エクスプローラーでsample.env ファイルを複製し、重複するファイルを .env に更新します。

    フォルダーに env 移動し、ファイル内の次のコードを ./env/.env.local.user 更新します。

    SECRET_OPENAI_KEY=<your OpenAI key>
    
    
  6. 次の依存関係をインストールするには、[ターミナル表示]> に移動し、次のコマンドを実行します。

    依存関係 command
    python-dotenv pip install python-dotenv
    load-dotenv pip install load-dotenv
    teams-ai pip install teams-ai
    botbuilder-core pip install botbuilder-core
  7. bot.py をモデルのデプロイ名で更新config.jsonします。

  8. [コマンド パレット表示>]に移動するか、Ctrl + Shift + P キーを押します。

  9. 「Python: Create Environment」と入力して、仮想環境を作成します。

  10. アプリをデバッグするには、 F5 キーを選択します。

    ブラウザー タブで、ボットをテナントに追加するように要求する Teams Web クライアントが開きます。

  11. [追加] を選択します。

    LightBot アプリの追加を示すスクリーンショット。

    チャット ウィンドウが開きます。

  12. メッセージ作成領域で、ボットを呼び出すメッセージを送信します。

    LightBot 出力の例を示すスクリーンショット。

その他のツール

次のツールを使用して、サンプルを実行して設定することもできます。

  1. Teams Toolkit CLI: Teams Toolkit CLI を使用して、コマンド ラインから Teams アプリを作成および管理できます。 詳細については、「 Teams Toolkit CLI のセットアップ手順」を参照してください。

  2. Bot Framework Emulator: Bot Framework Emulatorは、ボットをローカルでテストおよびデバッグできるデスクトップ アプリケーションです。 ボットのエンドポイント URL と Microsoft アプリ ID とパスワードを入力して、ボットに接続できます。 その後、ボットにメッセージを送信し、その応答をリアルタイムで確認できます。 詳細については、「Bot Framework Emulatorセットアップ手順」を参照してください。

  3. 手動セットアップ: リソースを手動で設定する場合は、それぞれのサービスによって提供される手順に従って設定できます。 詳細については、「 手動セットアップ手順」を参照してください。

次の手順