dialogapi

dialogapiは、シナリオのアップロードやコンパイル、そして転送といった画面操作を、コマンドラインから行うツールです。

さらに、dialogapiはボットのテスト機能も提供しており、シナリオのデプロイからテストまでの一連のプロセスを自動化することができます。
これにより、開発者はシナリオの作成に集中できるようになります。

コマンドについての詳細は、こちらをご覧ください。

SUNABA開発環境ではテスト機能のみご利用になれます。

事前準備

サンプルデータをもとにdialogapiのインストールと設定を行います。

1. バージョン 3.7 以上のPythonをインストールします。
2. pipでdialogapiをインストールします。
   1	$ pip install git+https://github.com/docomo-dialog/dialogapi

3. サンプルデータをGithubからクローンします。
   1	$ git clone https://github.com/docomo-dialog/dialogapi.git

4. 自然対話サーバに任意の名称で空のプロジェクトを作成します。
5. クローンしたサンプルデータのsample/daディレクトリに移動します。
   1	$ cd dialogapi/sample/da

6. dialogapiの動作を確認します。
   

   以下のコマンドを実行し、実行結果に上述で作成したプロジェクト名が出力されれば動作確認完了です。

   ※実行前にYOUR_xxxの部分をご利用の環境に合わせて変更してください。
   　（YOUR_HOSTはドメインのみ指定してください）
   　また、必要に応じてconfig.ymlのserversを変更してください。

   1 2 3

   $ USER=YOUR_USER PASSWORD=YOUR_PASSWORD HOST=YOUR_HOST PROJECT=YOUR_PROJECT python -u -m dialogapi.main project list --config config.yml --server TestServer id   name 754  (YOUR_PROJECT)

プロジェクトのデプロイ

サンプルデータをもとに、２つのボット（hellobot、qbot）で構成されるプロジェクトを自然対話サーバにデプロイします。

1. クローンしたサンプルデータのsample/daディレクトリに移動します。
   1	$ cd dialogapi/sample/da

2. プロジェクトをデプロイします。
   

   以下のコマンドを実行します。
   ※実行前にYOUR_xxxの部分をご利用の環境に合わせて変更してください。

   1 2 3 4 5 6 7 8 9 10 11 12 13

   $ USER=YOUR_USER PASSWORD=YOUR_PASSWORD HOST=YOUR_HOST PROJECT=YOUR_PROJECT python -u -m dialogapi.main project setup --config config.yml --server TestServer --project TestProject Adding bot (YOUR_PROJECT)_QBot ... done Uploading AIML qbot/qbot.aiml ... done Compiling bot (YOUR_PROJECT)_QBot ... done Transfering: bot (YOUR_PROJECT)_QBot ... done Adding bot (YOUR_PROJECT)_HelloBot ... done Uploading AIML hellobot/hello.aiml ... done Uploading Set hellobot/hello.set ... done Uploading Map hellobot/hello.map ... done Uploading Config hellobot/hello.config ... done Uploading Property hellobot/hello.property ... done Compiling bot (YOUR_PROJECT)_HelloBot ... done Transfering: bot (YOUR_PROJECT)_HelloBot ... done

   ポイント
   デプロイ内容を変更（ボットの追加や削除など）する場合は、プロジェクト構成ファイル（config.yml）を変更してください。
   詳細はこちらを参照してください。

プロジェクトのテスト

サンプルデータをもとに、自然対話サーバにデプロイ済みの２つのボット（hellobot、qbot）のテストを行います。

1. クローンしたサンプルデータのsample/daディレクトリに移動します。
   1	$ cd dialogapi/sample/da

2. プロジェクトのテストを実行します。
   

   以下のコマンドを実行します。
   ※実行前にYOUR_xxxの部分をご利用の環境に合わせて変更してください。

   1 2 3 4 5 6 7 8 9 10 11 12 13

   $ USER=YOUR_USER PASSWORD=YOUR_PASSWORD HOST=YOUR_HOST PROJECT=YOUR_PROJECT python -u -m dialogapi.main project test --config config.yml --server TestServer --project TestProject Testing bot (YOUR_PROJECT)_QBot - 「こんにちは」に対する名前・年齢質問テスト ... ok. - 「こんにちは」に対する名前・年齢質問テスト ... ok. - 「こんにちは」に対する名前・年齢質問テスト ... ok. - 「こんにちは」に対する名前・年齢質問テスト ... ok. - 「こんにちは」に対する名前・年齢質問テスト ... ok. - 「こんにちは」に対する名前・年齢質問テスト ... ok. - 「こんにちは」に対する名前・年齢質問テスト ... ok. - 「こんにちは」に対する名前・年齢質問テスト ... ok. Testing bot (YOUR_PROJECT)_HelloBot - 挨拶テスト ... ok. - NoMatchテスト ... ok.

   ポイント
   テスト内容を変更する場合は、テストファイルを変更してください。
   詳細はこちらを参照してください。

プロジェクトのリセット

プロジェクトのボットを全て削除し、プロジェクトを作成直後の状態に戻します。

1. クローンしたサンプルデータのsample/daディレクトリに移動します。
   1	$ cd dialogapi/sample/da

2. プロジェクトのリセットを実行します。
   

   以下のコマンドを実行します。
   ※実行前にYOUR_xxxの部分をご利用の環境に合わせて変更してください。

   1 2 3

   $ USER=YOUR_USER PASSWORD=YOUR_PASSWORD HOST=YOUR_HOST PROJECT=YOUR_PROJECT python -u -m dialogapi.main project reset --config config.yml --server TestServer --project TestProject Removing bot (YOUR_PROJECT)_QBot ... done Removing bot (YOUR_PROJECT)_HelloBot ... done