BotSwitcher（提供終了予定）

提供方法の変更のお知らせ

2020年9月30日（水）10:00を以って、既存のBotSwitcher（旧BotSwitcher）はご利用いただけなくなります。
今後は新BotSwitcherのご利用を推奨いたします。新BotSwitcherについてはこちらをご覧ください。

BotSwitcherを使用すると、複数ボットで構成したチャットボットの制御を簡単に行うことができます。

BotSwitcherはユーザと対話するボットをカレントボットとし、その切り替えや確認を行える関数を提供します。

ポイント

BotSwitcherを使用する際はフロントボットにこちらのシナリオを登録してください。

ご注意

カレントボットは、シナリオ設定の「<sraix>による呼び出し」が「global」のボットのみ指定できます。

関数一覧

利用できる関数の一覧です。関数をクリックすると、関数の詳細へジャンプします。

関数	概要
`#SWITCH botId`	カレントボットを`botId`に変更し、初期発話をリクエストします。
`#SWITCH botId input`	カレントボットを`botId`に変更し、`input`の内容をリクエストします。
`#SET botId`	カレントボットを`botId`に変更します。
`#GET`	カレントボットのボットIDを取得します。
`#RELAY input`	カレントボットに`input`の内容をリクエストします。
`#CLEAR`	カレントボットをクリアします。
`#ONECE botId`	カレントボットを変更せずに、一度だけ`botId`に初期発話をリクエストします。
`#ONECE botId input`	カレントボットを変更せずに、一度だけ`botId`に`input`の内容をリクエストします。

関数詳細

#SWITCH botId

カレントボットをbotIdに変更し、初期発話をリクエストします。

パラメータ

botId カレントボットのボットID。
※シナリオ設定の「<sraix>による呼び出し」が「global」のボットのみ指定できます。

戻り値

カレントボットに初期発話をリクエストした際のレスポンス。

Example

カレントボットを以下のダミーボットに変更する例です。

ダミーボット（DummyBot）

<star/>

</template>

</category>

xAIML

<sraix botid="BotSwitcher">#SWITCH DummyBot</sraix>

</template>

</category>

実行結果

1 2	user > test bot > init

#SWITCH botId input

カレントボットをbotIdに変更し、inputの内容をリクエストします。

パラメータ

botId カレントボットのボットID。
※シナリオ設定の「<sraix>による呼び出し」が「global」のボットのみ指定できます。
input カレントボットにリクエストする発話。

戻り値

カレントボットにinputの内容をリクエストした際のレスポンス。

Example

カレントボットを以下のダミーボットに変更する例です。

ダミーボット（DummyBot）

<star/>

</template>

</category>

xAIML

<sraix botid="BotSwitcher">#SWITCH DummyBot テスト</sraix>

</template>

</category>

実行結果

1 2	user > test bot > テスト

#SET botId

カレントボットをbotIdに変更します。

パラメータ

botId カレントボットのボットID。
※シナリオ設定の「<sraix>による呼び出し」が「global」のボットのみ指定できます。

戻り値

カレントボットのボットID。

Example

カレントボットを変更する例です。

xAIML

<sraix botid="BotSwitcher">#SET DummyBot</sraix>

</template>

</category>

実行結果

1 2	user > test bot > DummyBot

#GET

カレントボットのボットIDを取得します。

パラメータ

なし

戻り値

カレントボットのボットID。

Example

カレントボットのボットIDを取得する例です。

xAIML

<think><sraix botid="BotSwitcher">#SET DummyBot</sraix></think>

</template>

</category>

実行結果

1 2	user > test bot > DummyBot

#RELAY input

カレントボットにinputの内容をリクエストします。

パラメータ

input カレントボットにリクエストする発話。

戻り値

BotSwitcherの状態に応じて下表のとおり戻り値が設定されます。

カレントボットの有無	有効期限の状態^※	戻り値
有り	有効	カレントボットに`input`の内容をリクエストした際のレスポンス。
有り	無効	`EXPIRED`
無し	–	`NOTFOUND`

※カレントボットには有効期限が設けられています。有効期限を更新するには、#SWITCH、#SET、#RELAYのいずれかの関数を実行してください。

Example

以下のダミーボットがカレントボットに設定されている状態で、#RELAYを実行する例です。

ダミーボット（DummyBot）

<star/>

</template>

</category>

xAIML

<think><sraix botid="BotSwitcher">#SET DummyBot</sraix></think>

<sraix botid="BotSwitcher">#RELAY テスト</sraix>

</template>

</category>

実行結果

1 2	user > test bot > テスト

#CLEAR

カレントボットをクリアします。

カレントボットのレスポンス内に文字列#TALKENDを含んでいる場合も#CLEARと同じ動作をします。

パラメータ

なし

戻り値

Example

カレントボットをクリアする例です。

xAIML

<sraix botid="BotSwitcher">#CLEAR</sraix>

</template>

</category>

実行結果

1 2	user > test bot > OK

#ONECE botId

カレントボットを変更せずに、一度だけbotIdに初期発話をリクエストします。

パラメータ

botId 呼び出したいボットID。
※シナリオ設定の「<sraix>による呼び出し」が「global」のボットのみ指定できます。

戻り値

botIdに初期発話をリクエストした際のレスポンス。

Example

以下のダミーボットに#ONECEを行う例です。

ダミーボット（DummyBot）

<star/>

</template>

</category>

xAIML

<sraix botid="BotSwitcher">#ONECE DummyBot</sraix>

</template>

</category>

実行結果

1 2	user > test bot > init

#ONECE botId input

カレントボットを変更せずに、一度だけbotIdにinputの内容をリクエストします。

パラメータ

botId 呼び出したいボットID。
※シナリオ設定の「<sraix>による呼び出し」が「global」のボットのみ指定できます。
input 呼び出したいボットにリクエストする発話。

戻り値

botIdにinputの内容をリクエストした際のレスポンス。

Example

以下のダミーボットに#ONECEを行う例です。

ダミーボット（DummyBot）

<star/>

</template>

</category>

xAIML

<sraix botid="BotSwitcher">#ONECE DummyBot テスト</sraix>

</template>

</category>

実行結果

1 2	user > test bot > テスト

BotSwitcherシナリオ

BotSwitcherを使用する際に必要となるシナリオ（BotSwitcher.aiml）です。
特に理由がない場合はこのまま登録して使用してください。

<?xml version="1.0" encoding="UTF-8"?>

<think>

<set name="_var_botswitcher_result"><sraix botid="BotSwitcher">#RELAY <get name="input"/></sraix></set>

</li>

</condition>

</think>

</template>

</category>

</aiml>