Bot Framework SDK を使用してボットを作成する

適用対象: SDK v4

この記事では、Bot Framework SDK for C#、Java、JavaScript、または Python を使用して最初のボットを構築する方法と、Bot Framework Emulatorを使用してボットをテストする方法について説明します。

最初のボットを作成するには、Azure サブスクリプションや Azure Bot Service リソースは必要ありません。 このクイックスタートでは、最初のボットをローカルで作成することに重点を置いています。 Azure でボットを作成する方法については、「Azure Bot リソースを作成する」を参照してください。

Note

Bot Framework JavaScript と C# SDK は引き続きサポートされますが、Python SDK と Java SDK は、2023 年 11 月に終了する最終的な長期サポートで廃止されます。 このリポジトリ内の重要なセキュリティとバグの修正のみが行われます。

これらの SDK で構築された既存のボットは引き続き機能します。

新しいボット構築の場合は、 Power Virtual Agents の 使用を検討し、 適切なチャットボット ソリューションの選択に関する記事を参照してください。

詳細については、「 ボット構築の未来」を参照してください。

前提条件

C#

• .NET 6.0 SDK
• Bot Framework Emulator
• C# での ASP.NET Coreと非同期プログラミングに関する知識

C# テンプレート

現在のボット サンプルでは .NET Core 3.1 テンプレートを使用しています。

Visual Studio

• Visual Studio 2022 以降
• Visual Studio 用 Bot Framework v4 SDK テンプレート

ボット テンプレートを Visual Studio に追加するには、 Bot Framework v4 SDK Templates for Visual Studio VSIX ファイルをダウンロードしてインストールします。

Note

Visual Studio 内からテンプレートをインストールできます。

1. メニューで[ 拡張機能 ]、[ 拡張機能の管理] の順に選択します。
2. [ 拡張機能の管理 ] ダイアログで、 Visual Studio 用 Bot Framework v4 SDK テンプレートを検索してインストールします。

.NET ボットを Azure にデプロイする方法については、「ボットを プロビジョニングして発行する方法」を参照してください。

VS Code / CLI

.NET Core テンプレートは、Bot Framework v4 を使用して新しい会話型 AI ボットをすばやく構築するのに役立ちます。 2020 年 5 月の時点で、これらのテンプレートと生成されるコードには .NET Core 3.1 以降が必要です。

Bot Framework テンプレートをインストールするには:

1. コンソール ウィンドウを開きます。

2. .NET Core SDK ダウンロード バージョン 3.1 以降をダウンロードしてインストールします。

3. このコマンドを使用して、インストールされている .NET Core コマンド ライン インターフェイスのバージョンを確認できます。

   dotnet --version
   

4. 3 つの Bot Framework C# テンプレート (エコー、コア、空のボット テンプレート) をインストールします。

   dotnet new -i Microsoft.Bot.Framework.CSharp.EchoBot
   dotnet new -i Microsoft.Bot.Framework.CSharp.CoreBot
   dotnet new -i Microsoft.Bot.Framework.CSharp.EmptyBot
   

5. テンプレートが正しくインストールされていることを確認します。

   dotnet new --list
   

Note

上記の手順では、3 つの Bot Framework テンプレートをすべてインストールします。 すべてのテンプレートをインストールする必要がなく、使用するものだけをインストールできます。 この記事では、 エコー ボット テンプレートを使用します。

Java

• Java 1.8 以降
• Bot Framework Emulator
• ボットのコードを編集する場合は Visual Studio Code または好みの IDE。
• Maven のインストール
• バージョン 12.10 以降 node.js インストールします。
• Azure にデプロイする場合は 、Azure アカウント。

Java テンプレート

Yeoman ジェネレーターを使用して、 Bot Framework v4 のコア AI 機能を使用して会話型 AI ボットをすばやく作成します。 詳細については、「 yeoman.io」を参照してください。

ジェネレーターは、次に示すように 3 つの異なるテンプレート オプションをサポートしています。

テンプレート	説明
エコー ボット	「Hello World」より少し多くしたいが、それほど多くを必要としない場合は、良いテンプレート。 このテンプレートは、ボットにメッセージを送信し、ボットがメッセージをユーザーに繰り返して処理することの基本を処理します。 このテンプレートは、ユーザーがボットに対して何を言った場合でも、単にユーザーに "エコー" するボットを生成します。
空のボット	Bot Framework v4 に精通していて、基本的なスケルトン プロジェクトが必要な場合は、優れたテンプレートです。 また、ドキュメントからサンプル コードを取得し、それを最小限のボットに貼り付けて学習する場合にも適しています。
コア ボット	高度なボットを作成する場合は、マルチターン ダイアログと AI ベースのコグニティブ サービスである LUIS を使用して言語理解を実装する場合に適したテンプレートです。 このテンプレートは、フライトを予約する場所と日付を抽出できるボットを作成します。

Note

Language Understanding (LUIS) は、2025 年 10 月 1 日に廃止されます。 2023 年 4 月 1 日から、新しい LUIS リソースを作成することはできません。 新しいバージョンの言語理解が、Azure Cognitive Service for Language の一部として利用できるようになりました。

Azure Cognitive Service for Language の機能である会話言語理解 (CLU) は、LUIS の更新バージョンです。 Bot Framework SDK での言語理解のサポートの詳細については、「 自然言語理解」を参照してください。

Yeoman のインストール

1. バージョン 12.10 以降 node.js インストールしていることを確認します。

2. 最新の npm をインストールします。

   npm install -g npm
   

3. Yeoman をインストールします。 必ずグローバルにインストールしてください。

   npm install -g yo
   

4. generator-botbuilder-java をインストールします。 必ずグローバルにインストールしてください。

   npm install -g generator-botbuilder-java
   

5. Yeoman と generator-botbuilder-java が正しくインストールされていることを確認します。

   yo botbuilder-java --help
   

JavaScript

• Node.js
• Bot Framework Emulator
• restify および JavaScript での非同期プログラミングに関する知識
• ボットのコードを編集する場合は Visual Studio Code または好みの IDE。

JavaScript テンプレートと TypeScript テンプレート

Bot Framework v4 用の Yeoman ジェネレーターと Yeoman ジェネレーターをインストールするには:

1. ターミナルまたは管理者特権でのコマンド プロンプトを開きます。

2. JavaScript ボットのディレクトリに切り替えます。 まだない場合は最初に作成します。

   mkdir myJsBots
   cd myJsBots
   

3. npm と Yeoman の最新バージョンがあることを確認します。

   npm install -g npm
   npm install -g yo
   

4. Yeoman ジェネレーターをインストールします。 Yeoman は、アプリケーションを作成するためのツールです。 詳細については、「 yeoman.io」を参照してください。

   npm install -g generator-botbuilder
   

   Note

   下記の Windows ビルド ツールのインストールは、開発用オペレーティング システムとして Windows を使用している場合にのみ必要となります。 一部のインストールでは、restify のインストール手順で に node-gyp関連するエラーが発生しています。 該当する場合は、管理者特権のアクセス許可を使用してこのコマンドを実行してみてください。 Python がシステムに既にインストールされている場合、この呼び出しは終了せずにハングする可能性もあります。

   このコマンドは、Windows を使用している場合にのみ実行します。

   npm install -g windows-build-tools
   

Python

• Python 3.8.3
• Bot Framework Emulator
• Python での非同期プログラミングに関する知識

仮想環境を作成して有効にする

仮想環境は、グローバル設定とは異なる特定の Python インタープリターとライブラリの組み合わせです。 仮想環境はプロジェクトに固有であり、プロジェクト フォルダーに保持されます。 仮想環境を使用する利点は、時間の経過と同時にプロジェクトを開発するときに、仮想環境に常にプロジェクトの正確な依存関係が反映される点です。 仮想環境の詳細については、「仮想環境 の作成」を参照してください。

ボットを作成するディレクトリに移動します。 次に、お好みのプラットフォームに対して次のコマンドを実行します。 仮想環境をアクティブ化した後、コマンド ライン/ターミナルの前に を付ける (venv)必要があります。 これにより、仮想環境がアクティブであることを確認できます。 仮想環境はいつでも、次のように入力 deactivateして非アクティブ化できます。

macOS/Linux

python3 -m venv venv
source venv/bin/activate

Windows

python -m venv venv
venv\Scripts\activate.bat

Python テンプレート

次 pip install のコマンドを実行して、必要なパッケージをインストールします。

pip install botbuilder-core
pip install asyncio
pip install aiohttp
pip install cookiecutter==1.7.0

重要

32 ビット バージョンの Python を使用している場合は、 も実行 pip install cryptography==2.8してください。

ボットの作成

C#

Visual Studio

Visual Studio で、新しいボット プロジェクトを作成し、 Echo Bot (Bot Framework v4 - .NET Core 3.1) テンプレートを使用します。 ボット テンプレートのみを表示するには、 AI Bots プロジェクトの種類を選択します。

VS Code

.NET Core 3.1 以降がインストールされていることを確認します。

1. Visual Studio Code で、新しいターミナル ウィンドウを開きます。

2. ボット プロジェクトを作成するディレクトリに移動します。

3. 次のコマンドを使用して、新しいエコー ボット プロジェクトを作成します。 をボット プロジェクトに使用する名前に置き換えます <your-bot-name> 。

   dotnet new echobot -n <your-bot-name>
   

CLI

1. 新しいターミナル ウィンドウを開きます。

2. ボット プロジェクトを作成するディレクトリに移動します。

3. 次のコマンドを使用して、新しいエコー ボット プロジェクトを作成します。 をボット プロジェクトに使用する名前に置き換えます <your-bot-name> 。

   dotnet new echobot -n <your-bot-name>
   

テンプレートのおかげで、プロジェクトには、このクイックスタートでボットを作成するために必要なすべてのコードが含まれています。 ボットをテストするためにこれ以上のコードは必要ありません。

問題が発生したエコー ボットを作成しました

Java

次のコマンドを実行して、テンプレートからエコー ボットを作成します。 コマンドは、パラメーターに既定のオプションを使用します。

yo botbuilder-java -T "echo"

Yeoman により、作成するボットに関する情報の入力が求められます。 このチュートリアルでは、既定値を使います。

? What's the name of your bot? (echo)
? What's the fully qualified package name of your bot? (com.mycompany.echo)
? Which template would you like to start with? (Use arrow keys) Select "Echo Bot"
? Looking good.  Shall I go ahead and create your new bot? (Y/n) Enter "y"

ジェネレーターでは、ジェネレーターの既定値の変更やプロンプトの事前シードに使用できる多くのコマンド ライン オプションがサポートされています。 オプションでは大文字と小文字が区別されます。

コマンドライン オプション	説明
--help, -h	サポートされているすべてのコマンド ライン オプションのヘルプ テキストを一覧表示する
--botName, -N	ボット プロジェクトに指定された名前
--packageName, -P	ボットに使用する Java パッケージ名
--template, -T	プロジェクトの生成に使用するテンプレート。 オプションは、echo、empty、core です。 さまざまなテンプレートの詳細については、言語、 C#、 JavaScript、 Python、または Java の GitHub リポジトリを参照してください。
--noprompt	ジェネレーターは、新しいボットを作成する前に確認を求めるメッセージを表示しません。 コマンド ラインで渡されない要件オプションでは、適切な既定値が使用されます。 このオプションは、テスト目的でボットの自動生成を有効にすることを目的としています。

テンプレートのおかげで、プロジェクトには、このクイック スタートでボットを作成するのに必要なすべてのコードが含まれています。 ボットをテストするために他のコードは必要ありません。

問題が発生したエコー ボットを作成しました

JavaScript

1. ジェネレーターを使用してエコー ボットを作成します。

   yo botbuilder
   

   Yeoman により、作成するボットに関する情報の入力が求められます。 このチュートリアルでは、既定値を使います。

   ? What's the name of your bot? my-chat-bot
   ? What will your bot do? Demonstrate the core capabilities of the Microsoft Bot Framework
   ? What programming language do you want to use? JavaScript
   ? Which template would you like to start with? Echo Bot - https://aka.ms/bot-template-echo
   ? Looking good.  Shall I go ahead and create your new bot? Yes
   

テンプレートのおかげで、プロジェクトには、このクイック スタートでボットを作成するのに必要なすべてのコードが含まれています。 ボットをテストするために他のコードは必要ありません。

問題が発生したエコー ボットを作成しました

Python

1. 作業ディレクトリから次のコマンドを実行して、 エコー ボット テンプレートとその依存関係をダウンロードします。

   cookiecutter https://github.com/microsoft/BotBuilder-Samples/releases/download/Templates/echo.zip
   

2. ボットに名前と説明を入力するように求められます。 次の値を入力します。

   • bot_name: echo_bot
   • bot_description: ユーザーの応答をエコーバックするボット。

   

問題が発生したエコー ボットを作成しました

ボットの起動

C#

Visual Studio

Visual Studio:

1. ボット プロジェクトを開きます。
2. デバッグせずにプロジェクトを実行します。
3. Visual Studio によってアプリケーションがビルドされ、localhost にデプロイされ、Web ブラウザーが起動してアプリケーションの default.htm ページが表示されます。

この時点では、ボットはローカルのポート 3978 で実行されています。

VS Code

Visual Studio Code:

1. ボット プロジェクト フォルダーを開きます。

   プロジェクトの選択を求めるメッセージが表示されたら、作成したボットのプロジェクトを選択します。

2. メニューから [ 実行] を選択し、[ デバッグなしで実行] を選択します。

   • 環境の選択を求められたら、[.Net Core] を選択します。
   • このコマンドによって起動設定が更新された場合は、変更を保存してコマンドを再実行します。

   run コマンドは、アプリケーションをビルドし、localhost にデプロイし、Web ブラウザーを起動してアプリケーションの default.htm ページを表示します。

この時点では、ボットはローカルのポート 3978 で実行されています。

CLI

コマンド プロンプトまたはターミナルから:

1. ボットのプロジェクト フォルダーにディレクトリを変更します。

2. を使用して dotnet run ボットを開始します。

   dotnet run
   

3. このコマンドは、アプリケーションをビルドし、localhost にデプロイします。

アプリケーションの既定の Web ページは表示されませんが、この時点では、ボットはポート 3978 でローカルで実行されています。

私は問題に遭遇したエコーボットを開始しました

Java

1. ターミナルから bot を保存したディレクトリに移動し、以下に示すコマンドを実行します。

2. Maven プロジェクトをビルドし、 それを .jar ファイル (アーカイブ) にパッケージ化します。

   mvn package
   

3. ボットをローカルで実行します。 archive-name を、前のコマンドの実際の名前に置き換えます。

   java -jar .\target\<archive-name>.jar
   

これでエミュレーターを起動する準備ができました。

私は問題に遭遇したエコーボットを開始しました

JavaScript

ターミナルまたはコマンド プロンプトで、ボット用に作成したディレクトリに変更し、npm start でボットを起動します。

cd my-chat-bot
npm start

この時点では、ボットはローカルのポート 3978 で実行されています。

私は問題に遭遇したエコーボットを開始しました

Python

1. コマンド ラインまたはターミナルから、ディレクトリを に echo_bot変更します。

   cd echo_bot
   

2. エコー ボット テンプレートの依存関係をインストールします。

   pip install -r requirements.txt 
   

3. 依存関係がインストールされたら、次のコマンドを実行してボットを起動します。

   python app.py
   

   次のスクリーンショットに示されている最後の行が表示されたら、ボットをテストする準備ができていることがわかります。

   

4. 最後の行の http アドレスをコピーします。 エミュレーターを使用してボットと対話するときに必要になります。

私は問題に遭遇したエコーボットを開始しました

エミュレーターの起動とボットの接続

1. Bot Framework Emulator を起動します。

2. エミュレーターの [ようこそ] タブで [ボットを開く] を選択します。

3. ボットの URL (ローカル ホストとポート) を入力し、 /api/messages パスに を追加します。 通常、アドレスは です。 http://localhost:3978/api/messages

   

4. 次に、 [接続]\(Connect\) を選択します。

   ボットにメッセージを送信すると、ボットが応答します。

   

エミュレーターを起動し、ボットに接続しました。問題が発生しました

次の手順

• Visual Studio または Visual Studio Code とBot Framework Emulatorを使用してデバッグする方法については、「ボットのデバッグ」を参照してください。
• ngrok の詳細については、「 トンネリング (ngrok)」を参照してください。

ボットを Azure にデプロイする