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

この記事の対象: SDK v4

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

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

Note

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

Java SDK を使用して構築された既存のボットは引き続き機能します。

新しいボットの構築については、Power Virtual Agents の使用を検討し、適切なチャットボット ソリューションの選択についてお読みください。

詳細については、「The future of bot building」をご覧ください。

前提条件

C#

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

C# テンプレート

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

Visual Studio

• Visual Studio 2022 以降
• Bot Framework v4 SDK Templates for Visual Studio

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

Note

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

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

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

VS Code / CLI

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

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

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

2. .NET Core SDK download バージョン 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 をインストールします
• Node.js バージョン 12.10 以降をインストールします。
• Azure にデプロイ する場合は、Azure アカウントを用意します。

Java テンプレート

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

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

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

Note

Language Understanding (LUIS) は、2025 年 10 月 1 日に廃止されます。 2023 年 4 月 1 日以降は、新しい LUIS リソースを作成することはできません。 より新しいバージョンの言語理解が、現在、Azure AI Language の一部として提供されています。

Azure AI 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. 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

• 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 ボット] プロジェクト タイプを選択します。

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 です。 さまざまなテンプレートの詳細については、お使いの言語の GitHub リポジトリを参照してください (C#、JavaScript、Python、または Java)。
--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 を選択します。
   • このコマンドによって起動設定が更新された場合は、変更を保存してコマンドを再実行します。

   実行されたコマンドによってアプリケーションがビルドされ、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 にデプロイする