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

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

C# テンプレート

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

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

Java テンプレート

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

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

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
   

• 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. Yeomen と npm が最新バージョンであることを確認してください。

   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 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

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

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

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"

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

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

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
   

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

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

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

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

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

   

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

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

   mvn package
   

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

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

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

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

cd my-chat-bot
npm start

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

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

   cd echo_bot
   

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

   pip install -r requirements.txt 
   

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

   python app.py
   

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

   

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