SUNABAを使ってみよう

SUNABAでは、シナリオをxAIMLというXML形式の言語で作成し、それをボットに設定することで対話を行います。
ボットにシナリオを設定する際は、作成したxAIMLをSUNABA上でコンパイルし、DAT形式に変換したものを対話サーバに転送します。

このチュートリアルは、初めてSUNABAを使う方を対象に「実際にxAIMLを動作させて簡単な対話を行う」ことを目標にしています。

それでは、手順に沿って実際にSUNABAを使ってみましょう。

ログイン/新規登録する

  1. こちらの手順に従い、ログインまたは新規登録してください。

ボットを追加する

  1. ボット作成編集画面の下部にある「追加」を押下してください。(押下するとダイアログが表示されます)
  2. ダイアログに以下の通り値を入力し、「OK」を押下してください。
  3. 画面に「BOT情報を登録しました。」と表示されれば完了です。

シナリオを登録する

  1. ローカル環境に、ファイル「hello.aiml」を以下の内容で作成してください。
    ポイント
    テキストファイルを保存する場合の文字コードは、UTF-8(BOMなし)にしてください。

  2. ボット作成編集画面で登録したボットの「シナリオ」を押下してください。
  3. 「アップロード/ダウンロード」を押下してください。
  4. ファイルアップロード欄で、ローカル環境に作成した「hello.aiml」を選択してください。
    ポイント
    タイプは「AIMLファイル」を選択してください。
  5. ファイルアップロードの「Upload」を押下してください。
  6. 画面に「ファイルのアップロードに成功しました。」と表示されれば完了です。

シナリオをコンパイルする

  1. 「コンパイル/転送」を押下してください。
  2. 「コンパイル」を押下してください。(押下すると確認ダイアログが表示されます)
  3. 確認ダイアログで「OK」を押下してください。
  4. すべての項目にチェックが入れば完了です。「閉じる」を押して画面を閉じてください。

DATファイルを転送する

  1. 「コンパイル/転送」画面で「転送」を押下してください。(押下すると確認ダイアログが表示されます)
  2. 確認ダイアログで「OK」を押下してください。
  3. すべての項目にチェックが入れば完了です。「閉じる」を押して画面を閉じてください。

ボットと対話する

SUNABAでは、作成したボットとHTTPのPOSTメソッドで対話を行います。
このチュートリアルではPostmanを使用して対話を行う方法をご説明します。

事前準備

  1. Postmanをインストールしてください。

アプリID登録(ユーザ登録API)

SUNABAで対話を行う際に必要な、アプリIDを登録します。登録後、払い出されたアプリIDは継続して利用可能です。

  1. 新規リクエストを作成し、以下の通り設定してください。

    設定内容
    設定項目 設定値
    Method POST
    URL https://sunaba.xaiml.docomo-dialog.com/UserRegistrationServer/users/applications
  2. 「Headers」を押下し、以下の通り設定してください。

    設定内容
    設定値(Key) 設定項目(Value)
    HTTP-Version HTTP/1.1
    Content-Type application/json;charset=utf-8
  3. 「Body」を押下し●rawを選択して、以下の通り設定してください。
    ポイント
    “bot_id”は、「ボットを追加する」で登録したボットIDに置き換えてください。

    設定内容
    設定項目 設定値
    種別 raw
    コンテンツ
  4. 「Send」を押下してください。(押下するとAPIが実行されます)
  5. APIからのレスポンスに、以下のようにアプリID(app_id)が設定されていれば成功です。
    ポイント
    アプリIDはボット毎に払い出されます。

ボットと対話する(シナリオ対話API)

登録したアプリIDを使用して、ボットと対話します。

対話には、Postmanの他にSUNABAで提供しているWebシナリオテストツールがご利用になれます。

WebシナリオテストツールPostman
  1. 下記フォームに対話するテスト対象のボットIDを設定し、「」を押下してください。
    シナリオテストツール
    Webシナリオテストツールの使用方法はこちらを参照。
  2. voice textに、「こんにちは」を入力し、Sendを押下します。
  3. レスポンスに「こんにちは!ようこそ砂場へ!」が設定されていれば成功です。
  1. 新規リクエストを作成し、以下の通り設定してください。

    設定内容
    設定項目 設定値
    Method POST
    URL https://sunaba.xaiml.docomo-dialog.com/SpontaneousDialogueServer/dialogue
  2. 「Headers」を押下し、以下の通り設定してください。

    設定内容
    設定値(Key) 設定項目(Value)
    HTTP-Version HTTP/1.1
    Content-Type application/json;charset=utf-8
  3. 「Body」を押下し●rawを選択して、以下の通り設定してください。
    ポイント
    アプリID(appId)は、「アプリID登録」で払い出されたアプリID(app_id)を利用します。voiceTextに、ユーザ発話を記述します。

    設定内容
    設定項目 設定値
    種別 raw
    コンテンツ
  4. 「Send」を押下し、レスポンスが以下のように出力されれば成功です。

シナリオをカスタマイズする

シナリオのxAIMLをカスタマイズするには、ドキュメントの「xAIML Tips」や「xAIML Reference」をご参照ください。

以下はカスタマイズ例です。