シナリオ関連ファイル仕様

ボットのシナリオに関連するファイルの仕様です。

ご注意

ファイル内容のフォーマットに、「xAIML形式」または「テキスト形式」と記載されているものは、文字コードをUTF-8（BOM無し）としてください。

xAIMLファイル

ボットのシナリオを記述するファイルです。
１つのボットに対して、複数のxAIMLファイルを登録できます。

ファイル仕様

ファイル名	`{シナリオID}.aiml`
ファイル内容	フォーマット：xAIML形式ファイルサイズ上限：5MB 使用可能なxAIMLタグや、使用方法についてはこちらをご覧ください。

サンプル

xAIML

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

<pattern>こんにちは</pattern>

<template>こんにちは！ようこそ砂場へ！</template>

</category>

</aiml>

MAPファイル

xAIMLの<map>で置換する内容を記述するファイルです。
利用する際は、ファイル名に含まれるカテゴリ名を指定します。

ファイル仕様

ファイル名 {カテゴリ名}.map

ファイル内容

ファイル名	`{カテゴリ名}.map`
ファイル内容	フォーマット：テキスト形式ファイルサイズ上限：200MB 置換する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。置換前１`tab`置換後１　　　`tab`はタブ文字に置き換えてください。置換前２`tab`置換後２置換前・置換後の文字列は以下に準拠してください。　置換前：1～200文字　置換後：1文字以上ボットの言語が`ja-JP`の場合、オプションでファイルの先頭行に正規化モードを指定できます。　`#mode:exact` ヨミと品詞を付与しない　`#mode:surface` ヨミと品詞を付与する（未指定時のデフォルト値）

フォーマット：テキスト形式ファイルサイズ上限：200MB

置換する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。

置換前１tab置換後１　　　tabはタブ文字に置き換えてください。
置換前２tab置換後２

置換前・置換後の文字列は以下に準拠してください。

　置換前：1～200文字
　置換後：1文字以上

ボットの言語がja-JPの場合、オプションでファイルの先頭行に正規化モードを指定できます。

　#mode:exact ヨミと品詞を付与しない
　#mode:surface ヨミと品詞を付与する（未指定時のデフォルト値）

サンプル

「アップル」を「りんご」に、「ストロベリー」を「いちご」に置換するサンプルです。

fruit.map

1 2	アップルりんごストロベリーいちご

xAIML

</template>

</category>

<pattern><map>fruit</map></pattern>

</template>

</category>

SETファイル

xAIMLから利用できる辞書ファイルです。利用の際はカテゴリ名を指定します。

ファイル仕様

ファイル名 {カテゴリ名}.set

ファイル内容

ファイル名	`{カテゴリ名}.set`
ファイル内容	フォーマット：テキスト形式ファイルサイズ上限：5MB 定義する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。文字列１文字列２文字列は1～200文字の間で記述してください。ボットの言語が`ja-JP`の場合、オプションで先頭行に正規化モードを指定できます。　`#mode:exact` ヨミと品詞を付与しない　`#mode:surface` ヨミと品詞を付与する（未指定時のデフォルト値）

フォーマット：テキスト形式ファイルサイズ上限：5MB

定義する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。

文字列１
文字列２

文字列は1～200文字の間で記述してください。

ボットの言語がja-JPの場合、オプションで先頭行に正規化モードを指定できます。

　#mode:exact ヨミと品詞を付与しない
　#mode:surface ヨミと品詞を付与する（未指定時のデフォルト値）

サンプル

果物の辞書を定義するサンプルです。

fruit.set

いちご

りんご

アップル

ストロベリー

シナリオテストファイル

シナリオテスト内容を記述するtsvファイルです。
ボットエディタのシナリオテストツールでのみ利用できます。

ファイル仕様

ファイル名	`scenario.tsv`
ファイル内容	フォーマット：テキスト形式（TSV）定義する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。ユーザ発話１`tab`システム発話１　　　`tab`はタブ文字に置き換えてください。ユーザ発話２`tab`システム発話２

サンプル

scenario.tsv

1 2	こんにちはこんにちはテストおはよう

FAQチャットボット用Excelファイル

質問とそれに対する回答を記述するExcelファイルです。
ボットエディタのFAQデータ編集でのみ利用できます。

ファイル仕様

ファイル名	`{任意}.xlsx`
ファイル内容	フォーマット：Excel形式ファイルサイズ上限：10MB 質問とそれに対する回答を一覧形式でシートを分けて記述してください。設定できるシートは以下です。質問一覧回答一覧専門用語辞書動詞ゆらぎ辞書 SETSファイル各シートで定義できる内容は、後述をご覧ください。

質問一覧

このシートでは、質問内容を同じ行に以下の形式で記述します。
※質問一覧は登録が必須となります。質問を1件以上記述してください。

項目	値
回答ページID/AnswerID	回答ページID/AnswerIDを任意の値で設定します。回答ページIDは1～64文字の間で記述してください。複数記述する際は別の行に記述してください。回答ページID例メール-001 メール-002 回答ページIDに`-`（ハイフン）と`_`（アンダースコア）以外の記号は入力できません。
真理表生成用質問文	真理表生成用質問文を任意の値で設定します。真理表生成用質問文は1～200文字の間で記述してください。複数記述する際は別の行に記述してください。質問例 PCでメールを送りたい携帯でメールを送りたいボットエディタのFAQデータ編集画面で「FAQデータ生成」を行うと、設定した質問文からキーが抽出されます。 ※ キー抽出後の真理表は、エクスポートでダウンロードされる`Data`フォルダの`test_03_Shinrihyou.txt`で確認できます。上記の質問例から抽出されるキーは以下です。 PC　メール　送る携帯　メール　送る
表示用質問文/questionText	表示用質問文を任意の値で設定します。表示用質問文は1～200文字の間で記述してください。現在は表示用質問文を設定しても、対話で表示される質問文には反映されません。真理表生成用質問文の値が表示されます。表示用質問文が空白の場合、FAQデータ生成時にエラーになるので必ず値を入力してください。入力内容につきましては、真理表生成用質問文と同じ値を設定してください。
聞き返しキー順フラグ	聞き返しキー順フラグを設定します。（設定なしも可）設定できる値は以下です。 `0` 聞き返しキー順フラグ設定なし（未指定時のデフォルト値） `1` 聞き返しキー順フラグ設定ありユーザ発話から抽出したキーが真理表のキーと一部マッチする場合、「<残りのキー>についての質問ですか？」と聞き返されます。残りのキーの中で優先して聞き返したいキーを指定する場合に`1`を設定してください。聞き返すキーの優先順は、真理表に表示されているキーの左から順に優先されます。聞き返すキーの優先順を変更したい場合は、下記の例2のように「優先して聞き返したいキー（全角スペース）質問文」の形式で「真理表生成用質問文」に記載してください。例１：聞き返しキー順フラグを利用しない場合真理表生成用質問文携帯でメールを送りたい（聞き返しキー順フラグ: 未指定 or 0）真理表のキー携帯　メール　送る例２：聞き返しキー順フラグを利用した場合真理表生成用質問文メール　携帯でメールを送りたい（聞き返しキー順フラグ: 1）真理表のキーメール　携帯　送る

サンプル

質問一覧シートのサンプルです。

回答ページID/AnswerID	真理表生成用質問文	表示用質問文/questionText	聞き返しキー順フラグ
メール-001	メール　PCでメールを送りたい	PCでメールを送りたい	1
メール-002	携帯でメールを送りたい	携帯でメールを送りたい	0

回答一覧

このシートでは、質問に対する回答内容を同じ行に以下の形式で記述します。
※回答一覧は登録が必須となります。回答を1件以上記述してください。

項目	値
回答ページID/AnswerID	回答ページID/AnswerIDを任意の値で設定します。回答ページIDは1～64文字の間で記述してください。複数記述する際は別の行に記述してください。回答ページID例メール-001 メール-002 質問一覧に設定した「回答ページID/AnswerID」と紐付く値を設定してください。 IDが異なる場合、正しく回答が表示されません。回答ページIDに`-`（ハイフン）と`_`（アンダースコア）以外の記号は入力できません。
表示文	回答の表示文を任意の値で設定します。表示文は1～1000文字の間で記述してください。複数記述する際は別の行に記述してください。回答例 PCでのメールの送り方はこちらをご覧ください。携帯でのメールの送り方はこちらをご覧ください。
閲覧回数（回）	回答の優先度を任意の数値で設定します。（設定なしも可）閲覧回数は整数（マイナスも可）で記述してください。回答の優先度は、ユーザ発話から抽出したキーと真理表のキーがマッチする数で決定されます。マッチするキーの数が多い順に優先され、同数の場合は閲覧回数が多い方を優先します。マッチするキーの数が同数で閲覧回数が未指定の場合は、DBに登録される順に優先されるため、回答一覧の表示順には依存しません。

サンプル

回答一覧シートのサンプルです。

回答ページID/AnswerID	表示文	閲覧回数（回）
メール-001	PCでのメールの送り方はこちらをご覧ください。	50
メール-002	携帯でのメールの送り方はこちらをご覧ください。	100

専門用語辞書

このシートでは、GUIエディターで利用するユーザ辞書ファイルと同様に、定義する内容を同じ行に以下の形式で記述します。
ユーザ辞書ファイルの詳細は、こちらをご覧ください。

項目	値
揺らぎ	正式名称に紐付ける単語を任意の値で設定します。（設定なしも可）揺らぎは1～85文字の間で記述してください。複数記述する際は別の行に記述してください。
正式名称	正式名称を任意の値で設定します。（設定なしも可）正式名称は1～85文字の間で記述してください。正式名称はスペースのみで登録しないでください。正式名称に指定した単語自体がキーとして取得されないことがあるため、「揺らぎ」=「正式名称」を必ず設定してください。

サンプル

専門用語辞書シートのサンプルです。

揺らぎ	正式名称
PC	PC
パソコン	PC
パーソナルコンピュータ	PC
携帯	携帯
携帯電話	携帯
スマホ	携帯
スマートフォン	携帯

動詞ゆらぎ辞書

このシートでは、「統一させたい真理表のキー」と「統一後の真理表のキー」を同じ行に以下の形式で記述します。
動詞ゆらぎ辞書シートを活用すると、異なるキーを同じ統一キーとしてみなし、拾える回答候補を広く設定できます。

項目値

揺らぎ

項目	値
揺らぎ	統一キーに置き換えて認識させたい真理表のキーを設定します。（設定なしも可）揺らぎは1～85文字の間で記述してください。複数記述する際は別の行に記述してください。ボットエディタのFAQデータ編集画面で「FAQデータ生成」を行うと、設定した質問文からキーが抽出されます。 ※ キー抽出後の真理表は、エクスポートでダウンロードされる`Data`フォルダの`test_03_Shinrihyou.txt`で確認できます。揺らぎはスペースのみで登録せず、真理表に抽出されているキーを設定してください。真理表に抽出されていない単語を設定してもキーとして取得されません。
統一キー	揺らぎに指定したキーを置き換える単語を設定します。（設定なしも可）統一キーは1～85文字の間で記述してください。統一キーはスペースのみで登録しないでください。質問例 PCでメールを送りたい携帯でメールを送りたい画像を届けたい上記の質問例から抽出されるキーは以下です。 PC　メール　送る携帯　メール　送る画像　届ける後述のサンプルを動詞ゆらぎ辞書に設定すると、抽出されるキーは以下に変更されます。 PC　メール　送信携帯　メール　送信画像　送信「送る」、「届ける」が「送信」として認識されるようになるため、「タブレットに送りたい」というユーザ発話が合った場合は「PCについての質問ですか？」と「携帯についての質問ですか？」と「画像についての質問ですか？」の全てが聞き返されます。

統一キーに置き換えて認識させたい真理表のキーを設定します。（設定なしも可）
揺らぎは1～85文字の間で記述してください。
複数記述する際は別の行に記述してください。

ボットエディタのFAQデータ編集画面で「FAQデータ生成」を行うと、設定した質問文からキーが抽出されます。
※ キー抽出後の真理表は、エクスポートでダウンロードされるDataフォルダのtest_03_Shinrihyou.txtで確認できます。

揺らぎはスペースのみで登録せず、真理表に抽出されているキーを設定してください。
真理表に抽出されていない単語を設定してもキーとして取得されません。

統一キー

揺らぎに指定したキーを置き換える単語を設定します。（設定なしも可）
統一キーは1～85文字の間で記述してください。

統一キーはスペースのみで登録しないでください。

質問例

PCでメールを送りたい
携帯でメールを送りたい
画像を届けたい

上記の質問例から抽出されるキーは以下です。

PC　メール　送る
携帯　メール　送る
画像　届ける

後述のサンプルを動詞ゆらぎ辞書に設定すると、抽出されるキーは以下に変更されます。

PC　メール　送信
携帯　メール　送信
画像　送信

「送る」、「届ける」が「送信」として認識されるようになるため、「タブレットに送りたい」というユーザ発話が合った場合は「PCについての質問ですか？」と「携帯についての質問ですか？」と「画像についての質問ですか？」の全てが聞き返されます。

サンプル

動詞ゆらぎ辞書シートのサンプルです。

揺らぎ	統一キー
送る	送信
届ける	送信

SETSファイル

このシートでは、xAIMLで利用するSETファイルと同様に、定義する内容を同じ列に以下の形式で記述します。
SETファイルの詳細は、こちらをご覧ください。

項目	値
カテゴリ名	カテゴリ名を任意の値で設定します。（設定なしも可）
正規化モード	正規化モードを設定します。（設定なしも可）設定できるモードは以下です。 `#mode:exact` ヨミと品詞を付与しない `#mode:surface` ヨミと品詞を付与する（未指定時のデフォルト値）
単語名	カテゴリに紐付ける単語名を任意の値で設定します。（設定なしも可）複数記述する際は別の行に記述してください。

サンプル

SETSファイルシートのサンプルです。

YES	NO
#mode:surface	#mode:surface
YES	NO
yes	no
Yes	No
いえす	のー
イエス	ノー
はい	いいえ
そう	ちがう

サンプル

サンプルファイルは、こちらからダウンロードしてご利用ください。

ご注意

サンプルファイルはダウンロード後、必ず質問と回答のデータを入力してからアップロードを行ってください。

AIアバターエディター用シナリオCSVファイル

AIアバターチャットボットのシナリオを記述するCSVファイルです。
ボットエディタのAIアバターエディターでのみ利用できます。

ファイル仕様

ファイル名 {ボットID}_scenario.csv

ファイル内容

ファイル名	`{ボットID}_scenario.csv`
ファイル内容	フォーマット：テキスト形式（CSV）ボックスごとに定義する内容をカンマ区切りで記述します。複数記述する際は別の行に記述してください。（１ファイルに記述できる行数は最大100行です。） ID１,ボックスタイプ１,ラベル名１,入力条件１,発話内容１,覚える内容１,… ID２,ボックスタイプ２,ラベル名２,入力条件２,発話内容２,覚える内容２,… 定義できる内容は、後述の設定内容一覧をご覧ください。

フォーマット：テキスト形式（CSV）

ボックスごとに定義する内容をカンマ区切りで記述します。複数記述する際は別の行に記述してください。
（１ファイルに記述できる行数は最大100行です。）

ID１,ボックスタイプ１,ラベル名１,入力条件１,発話内容１,覚える内容１,…
ID２,ボックスタイプ２,ラベル名２,入力条件２,発話内容２,覚える内容２,…

定義できる内容は、後述の設定内容一覧をご覧ください。

設定内容一覧

共通設定

項目値

項目	値
ID	IDを任意の値で設定します。CSVアップロード時にシステムが自動で払い出すIDに置き換わります。（IDが置き換わっても、リンクの設定で記載したボックスの接続線は保持されます。）システム発話起点のIDは`system.init`と記述してください。（システム発話起点の設定は１シナリオにつき１つだけできます。）
ボックスタイプ	ボックスタイプを設定します。設定できるボックスタイプは以下です。 `control-system-init` （システム発話起点） `control-user-init` （ユーザー発話起点） `system` （システム発話） `user` （ユーザー発話） `link` （リンク） `standby-motion` （待機モーション） `date` （現在日時取得）全てのボックスタイプには、個別で設定が必要です。個別で設定する内容は後述の設定内容をご覧ください。

IDを任意の値で設定します。CSVアップロード時にシステムが自動で払い出すIDに置き換わります。
（IDが置き換わっても、リンクの設定で記載したボックスの接続線は保持されます。）

システム発話起点のIDはsystem.initと記述してください。
（システム発話起点の設定は１シナリオにつき１つだけできます。）

ボックスタイプ

ボックスタイプを設定します。設定できるボックスタイプは以下です。

control-system-init （システム発話起点）
control-user-init （ユーザー発話起点）
system （システム発話）
user （ユーザー発話）
link （リンク）
standby-motion （待機モーション）
date （現在日時取得）

全てのボックスタイプには、個別で設定が必要です。
個別で設定する内容は後述の設定内容をご覧ください。

ボックスタイプ：control-system-init（システム発話起点）／control-user-init（ユーザー発話起点）の設定

項目値

AIアバター

AIアバター用発話起点の設定を" "内にJSON形式で設定します。（設定なしも可）
JSON内で使用している"はエスケープします。

設定内容については、AIアバタータブの設定項目に従って記述してください。
設定する項目は以下です。

initialInput （初期入力）
displayText （表示用テキスト）
speechText （読み上げテキスト）
motion （モーション）※設定できる値はこちら
expression （表情）※設定できる値はこちら
expressionDegree（表情の度合い）
gaze （視線）※設定できる値はこちら
motionLoop （モーションのループ）
waitTime （待ち時間）
customize （カスタマイズ）
ssmlFlag （SSMLで指定の有無）

JSON例

{

"initialInput":"#start",

"displayText":"ごめんね。よく聞き取れなかったから、もう一度話してもらえるかな",

"speechText":"ごめんね。よく聞き取れなかったから、もう一度話してもらえるかな",

"motion":"idle",

"expression":"joy",

"expressionDegree":1,

"gaze":"on",

"motionLoop":false,

"waitTime":0,

"customize":"<set name="test">aaa</set>",

"ssmlFlag":false

}

ボックスタイプ：system（システム発話）

項目値

ラベル名ラベル名を任意の値で設定します。（設定なしも可）

入力条件

システム発話の入力条件を任意の値で設定します。（設定なしも可）

※現在、入力条件の値に|（パイプ）は使用できません。
　|（パイプ）を使用する場合は、アップロード後にAIアバターエディター上で入力条件の変更を行ってください。

発話内容設定できません。

覚える内容覚える内容を任意の値で設定します。（設定なしも可）

LINE 設定できません。

my daiz 設定できません。

選択ボタン自動挿入設定する値は0 （選択ボタン自動挿入なし）固定です。

音声合成

AIアバター用音声合成の設定を" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。

設定内容については、こちらに従って記述してください。
設定する項目は以下です。

name （名前）
speakerId （話者モデルID）
styleId （口調モデルID）
voiceType （音声の声質）
powerRate （音量）
speechRate（話速）
intonation（抑揚）
pitch （声の高さ）

JSON例

{

"name":"akari",

"speakerId":"jpn_JP-F-S0103-T001-E01-SR0",

"styleId":"jpn_JP-F-S0103-T001-E01",

"voiceType":0.5,

"powerRate":1,

"speechRate":1.2,

"intonation":5,

"pitch":10

}

AIアバター

AIアバター用システム発話の設定を" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。

設定内容については、AIアバタータブの設定項目に従って記述してください。
設定する項目は以下です。

displayText （表示用テキスト）
speechText （読み上げテキスト）
motion （モーション）※設定できる値はこちら
expression （表情）※設定できる値はこちら
expressionDegree（表情の度合い）
gaze （視線）※設定できる値はこちら
motionLoop （モーションのループ）
waitTime （待ち時間）
customize （カスタマイズ）
ssmlFlag （SSMLで指定の有無）

JSON例

{

"displayText":"こんにちは",

"speechText":"こんにちは",

"motion":"quick_formal_bow",

"expression":"joy",

"expressionDegree":1,

"gaze":"on",

"motionLoop":false,

"waitTime":0,

"customize":"<set name="test">テスト</set>",

"ssmlFlag":true

}

ご注意

複数の入力条件、覚える内容を設定したい場合は、|（パイプ）で区切ることで設定可能です。

辞書や変数、発話内容を引数として指定する場合は[ ]で囲う必要があります。
また、変数の記述は全て@（アットマーク）を先頭につける必要があります。

ボックスタイプ：user（ユーザー発話）の設定

項目	値
ラベル名	ラベル名を任意の値で設定します。（設定なしも可）
入力条件	設定できません。
テキスト	テキストを任意の値で設定します。 `\|`（パイプ）、`,`（カンマ）、`=`（イコール）はテキスト内容として使用できません。（テキストに設定されたJSON内で`,`（カンマ）は使用可能です。）
覚える内容	覚える内容を任意の値で設定します。（設定なしも可）
選択ボタン自動挿入	設定する値は`0` （選択ボタン自動挿入なし）固定です。
意図解釈ラベル指定	意図解釈ラベル指定を設定します。設定できる値は以下です。 0 （意図解釈ラベル指定なし） 1 （意図解釈ラベル指定あり）

ご注意

複数のテキスト、覚える内容を設定したい場合は、|（パイプ）で区切ることで設定可能です。

辞書や変数、テキストを引数として指定する場合は[ ]で囲う必要があります。
また、変数の記述は全て@（アットマーク）を先頭につける必要があります。

ボックスタイプ：link（リンク）の設定

GUIエディター用シナリオCSVファイルのボックスタイプ：line（リンク）と同様です。

ボックスタイプ：standby-motion（待機モーション）の設定

項目値

ラベル名ラベル名を任意の値で設定します。（設定なしも可）

AIアバター

AIアバター用待機モーションの設定を" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。

設定内容については、AIアバタータブの設定項目に従って記述してください。
設定する項目は以下です。

motion （モーション）※設定できる値はこちら
expression （表情）※設定できる値はこちら
expressionDegree（表情の度合い）
gaze （視線）※設定できる値はこちら
customize （カスタマイズ）

JSON例

{

　　"motion":"idle",

　　"expression":"default",

　　"expressionDegree":1,

　　"gaze":"on",

　　"customize":"<predstore>test=aaa</predstore>"

}

ボックスタイプ：date（現在日時取得）の設定

GUIエディター用シナリオCSVファイルのボックスタイプ：date（現在日時取得）と同様です。

モーション一覧

モーションに設定できる値は以下です。

モーション一覧

項目	値
待機する	`Idle`
笑う	`Laughing`
喜ぶ	`Joyful Jump`
すごく喜ぶ	`Happy`
怒る	`Angry`
照れる	`Dismissing Gesture`
泣く	`Crying`
がっかりする	`Disappointed`
肯定する	`Head Nod Yes`
否定する	`Shaking Head No`
拍手する	`Clapping`
お辞儀する	`Quick Formal Bow`
応援する	`Cheering`
踊る	`Dancing`
驚く	`Surprised`
怖がる	`Terrified`
アピールする	`Victory`
悔しがる	`Defeated`
感謝	`Thankful`
祈る	`Praying`
考える	`Thinking`
あくび	`Yawn`
挨拶	`Greeting`
会話	`Talking`
指差し	`Pointing`
呼びかけ	`Yelling Out`
相槌	`Acknowledging`
躊躇	`Look Around`
よそ見	`Cocky Head Turn`
顔を上げる	`Lengthy Head Nod`
首を傾げる	`Thoughtful Head Nod`

表情一覧

表情に設定できる値は以下です。

表情一覧

項目	値
デフォルト	`default`
笑顔	`joy`
泣き顔	`sorrow`
怒り顔	`angry`
楽しんでいる顔	`fun`
驚いている顔	`surprised`
びっくりしている顔	`extra`

視線一覧

視線に設定できる値は以下です。

視線一覧

項目	値
カメラ目線	`on`
目線を外す	`off`
デフォルト	`default`

サンプル

システム発話起点／システム発話／ユーザー発話／リンク／待機モーションを定義するサンプルです。

CSV例

#システム発話起点の設定

system.init,control-system-init,"{""initialInput"":""#start"",""displayText"":""ごめんね。よく聞き取れなかったから、もう一度話してもらえるかな"",""speechText"":""ごめんね。よく聞き取れなかったから、もう一度話してもらえるかな"",""motion"":""idle"",""expression"":""joy"",""expressionDegree"":1,""gaze"":""on"",""motionLoop"":false,""waitTime"":0,""customize"":""<set name=""test"">aaa</set>"",""ssmlFlag"":false}"

#システム発話の設定

_ssb-1,system,システム発話ボックス,@season=text=summer,,@weather=text=晴れ,,,0,"{""name"":""akari"",""speakerId"":""jpn_JP-F-S0103-T001-E01-SR0"",""styleId"":""jpn_JP-F-S0103-T001-E01"",""voiceType"":0.5,""powerRate"":1,""speechRate"":1.2,""intonation"":5,""pitch"":10}","{""displayText"":""こんにちは"",""speechText"":""こんにちは"",""motion"":""quick_formal_bow"",""expression"":""joy"",""expressionDegree"":1,""gaze"":""on"",""motionLoop"":false,""waitTime"":0,""customize"":""<set name=""test"">テスト</set>"",""ssmlFlag"":true}"

#ユーザー発話の設定

_usb-1,user,ユーザ発話ボックス,,ST001001002=surface_partial,,0,1

#リンクの設定

_link-1,link,system.init,_ssb-1

#待機モーションの設定

_cb-1,standby-motion,待機モーションボックス,"{""motion"":""idle"",""expression"":""default"",""expressionDegree"":1,""gaze"":""on"",""customize"":""<predstore>test=aaa</predstore>""}"

ID例

system.init （システム発話起点ID）

user.init-1 （ユーザー発話起点ID）

_cb-1 （待機モーション、現在日時取得ID）

_ssb-1 （システム発話ID）

_usb-1 （ユーザー発話ID）

_link-1 （リンクID）

入力条件例

@name=set （nameが設定されているとき）

@name=not_set （nameが設定されていないとき）

@name=text=高橋（nameが高橋のとき）

@name=math=>0 （nameが0より大きいとき）

@name=regex=[xyz] （nameが正規表現でxyzとマッチングするとき）

ユーザー発話のテキスト例

OK=exact （「OK」と完全一致で一致）

OK=surface_partial （「OK」と読み一致で一致）

OK=exact_partial （「OK」と完全（部分一致）で一致）

OK=surface_partial （「OK」と読み（部分一致）で一致）

OK=normalization_partial （「OK」と正規化（部分一致）で一致）

OK=synonym_partial （「OK」と類義語（部分一致）で一致）

OK=regex （「OK」と正規表現で一致）

覚える内容例

@name=text=XXXX （nameにテキストでXXXXを覚えさせるとき）

@name=text=[#any] （nameにテキストでアスタリスク全体を覚えさせるとき）

@name=text=[#all] （nameにテキストでユーザー発話全体を覚えさせるとき）

@name=text=[#org] （nameにテキストで組織を覚えさせるとき）

@name=text=[#spn] （nameにテキストで人名を覚えさせるとき）

@name=text=[#loc] （nameにテキストで場所を覚えさせるとき）

@name=text=[#art] （nameにテキストで固有物名を覚えさせるとき）

@name=text=[#dat] （nameにテキストで日付表現を覚えさせるとき）

@name=text=[#tim] （nameにテキストで時刻表示を覚えさせるとき）

@name=text=[#mny] （nameにテキストで金額表を覚えさせるとき）

@name=text=[#pct] （nameにテキストで割合表現を覚えさせるとき）

@name=before_speech=any （nameに直前のユーザー発話から抽出でアスタリスク全体を覚えさせるとき）

@name=before_speech=all （nameに直前のユーザー発話から抽出でユーザー発話全体を覚えさせるとき）

@name=before_speech=org （nameに直前のユーザー発話から抽出で組織を覚えさせるとき）

@name=before_speech=spn （nameに直前のユーザー発話から抽出で人名を覚えさせるとき）

@name=before_speech=loc （nameに直前のユーザー発話から抽出で場所を覚えさせるとき）

@name=before_speech=art （nameに直前のユーザー発話から抽出で固有物名を覚えさせるとき）

@name=before_speech=dat （nameに直前のユーザー発話から抽出で日付表現を覚えさせるとき）

@name=before_speech=tim （nameに直前のユーザー発話から抽出で時刻表示を覚えさせるとき）

@name=before_speech=mny （nameに直前のユーザー発話から抽出で金額表を覚えさせるとき）

@name=before_speech=pct （nameに直前のユーザー発話から抽出で割合表現を覚えさせるとき）

@name=aiml=XXXX （nameにAIMLを記述し覚えさせるとき）

@name=forget= （nameの内容を忘れさせるとき）

GUIエディター用ユーザー辞書ファイル

ユーザー辞書を定義するファイルです。ボットエディタのGUIエディターでのみ利用できます。

ファイル仕様

ファイル名 {任意}.csv

ファイル内容

ファイル名	`{任意}.csv`
ファイル内容	フォーマット：テキスト形式（CSV）グループ名、単語名ごとに別の言い方をカンマ区切りで記述してください。複数記述する際は別の行に記述してください。グループ名,単語名１,単語名１の別の言い方１,単語名１の別の言い方２,… グループ名,単語名２,単語名２の別の言い方１,単語名２の別の言い方２,…

フォーマット：テキスト形式（CSV）

グループ名、単語名ごとに別の言い方をカンマ区切りで記述してください。
複数記述する際は別の行に記述してください。

グループ名,単語名１,単語名１の別の言い方１,単語名１の別の言い方２,…
グループ名,単語名２,単語名２の別の言い方１,単語名２の別の言い方２,…

サンプル

グループ名「フルーツ」に、「いちご」と「りんご」の辞書を登録するサンプルです。

fruit.csv

1 2	フルーツ,いちご,いちご,ストロベリーフルーツ,りんご,りんご,アップル

GUIエディター用シナリオCSVファイル

ボットのシナリオを記述するCSVファイルです。ボットエディタのGUIエディターでのみ利用できます。

ファイル仕様

ファイル名 {ボットID}_scenario.csv

ファイル内容

ファイル名	`{ボットID}_scenario.csv`
ファイル内容	フォーマット：テキスト形式（CSV）ボックスごとに定義する内容をカンマ区切りで記述します。複数記述する際は別の行に記述してください。（１ファイルに記述できる行数は最大100行です。） ID１,ボックスタイプ１,ラベル名１,入力条件１,発話内容１,覚える内容１,… ID２,ボックスタイプ２,ラベル名２,入力条件２,発話内容２,覚える内容２,… 定義できる内容は、後述の設定内容一覧をご覧ください。

フォーマット：テキスト形式（CSV）

定義できる内容は、後述の設定内容一覧をご覧ください。

設定内容一覧

共通設定

項目値

項目	値
ID	IDを任意の値で設定します。CSVアップロード時にシステムが自動で払い出すIDに置き換わります。（IDが置き換わっても、リンクの設定で記載したボックスの接続線は保持されます。）システム発話起点のIDは`system.init`と記述してください。（システム発話起点の設定は１シナリオにつき１つだけできます。）
ボックスタイプ	ボックスタイプを設定します。設定できるボックスタイプは以下です。 `control-system-init` （システム発話起点） `control-user-init` （ユーザー発話起点） `system` （システム発話） `user` （ユーザー発話） `link` （リンク） `control-change-scenario` （シナリオ遷移） `external` （外部API連携） `interpretation` （意図解釈エンジン連携） `date` （現在日時取得） `botlink` （ボット連携） `control-system-init`（システム発話起点）、`control-user-init`（ユーザ発話起点）以外のボックスタイプには、個別で設定が必要です。個別で設定する内容は後述の設定内容をご覧ください。

システム発話起点のIDはsystem.initと記述してください。
（システム発話起点の設定は１シナリオにつき１つだけできます。）

ボックスタイプ

ボックスタイプを設定します。設定できるボックスタイプは以下です。

control-system-init （システム発話起点）
control-user-init （ユーザー発話起点）
system （システム発話）
user （ユーザー発話）
link （リンク）
control-change-scenario （シナリオ遷移）
external （外部API連携）
interpretation （意図解釈エンジン連携）
date （現在日時取得）
botlink （ボット連携）

control-system-init（システム発話起点）、control-user-init（ユーザ発話起点）以外のボックスタイプには、個別で設定が必要です。
個別で設定する内容は後述の設定内容をご覧ください。

ボックスタイプ：system（システム発話）／user（ユーザー発話）の設定

項目値

ラベル名ラベル名を任意の値で設定します。（設定なしも可）

入力条件

システム発話の入力条件を任意の値で設定します。（設定なしも可）

※現在、入力条件の値に|（パイプ）は使用できません。
　|（パイプ）を使用する場合は、アップロード後にGUIエディタ上で入力条件の変更を行ってください。

発話内容発話内容を任意の値で設定します。（設定なしも可）
|（パイプ）、,（カンマ）、=（イコール）は発話内容として使用できません。
（発話内容に設定されたJSON内で,（カンマ）は使用可能です。）

覚える内容覚える内容を任意の値で設定します。（設定なしも可）

LINE

LINE用システム発話の設定を"[ ]"内にJSON形式で設定します。（設定なしも可）
JSON内で使用している"はエスケープします。

JSON例

{

"type": "text",

"text": "サンプル",

"emojis": []

}

設定内容については、LINEのMessaging APIリファレンスに従って記述してください。
設定できるメッセージタイプは以下です。

text （テキスト）
sticker （スタンプ）
image （画像）
video （動画）
audio （音声）
location （位置情報）
buttons （ボタン）
confirm （確認）
json （JSON）

ドコモAIエージェントAPIで利用できるアクションオブジェクトには制限があります。
詳細については、ドコモAIエージェントAPIへお問い合わせください。

my daiz

my daiz用システム発話の設定を"[ ]"内にJSON形式で設定します。（設定なしも可）
JSON内で使用している"はエスケープします。

JSON例

{

"type": "text",

"text": "サンプル",

"emojis": []

}

設定できるメッセージタイプは以下です。

text （テキスト）
media （メディア）
button （ボタン）
conpaund （カルーセル）
json （JSON）

選択ボタン自動挿入

選択ボタン自動挿入を設定します。設定できる値は以下です。

0 （選択ボタン自動挿入なし）
1 （選択ボタン自動挿入あり）

音声合成

システム発話の音声合成の設定を" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。

設定内容については、こちらに従って記述してください。
設定する項目は以下です。

utterance （読み上げテキスト）
speakerId （話者モデルID）
styleId （口調モデルID）
voiceType （音声の声質）
powerRate （音量）
speechRate（話速）
intonation（抑揚）
pitch （声の高さ）

JSON例

{

"utterance":"こんにちは",

"speakerId":"jpn_JP-F-S0103-T001-E01-SR0",

"styleId":"jpn_JP-F-S0103-T001-E01",

"voiceType":0.5,

"powerRate":1,

"speechRate":1.2,

"intonation":5,

"pitch":10

}

ご注意

複数の入力条件、発話内容、覚える内容、LINEを設定したい場合は、|（パイプ）で区切ることで設定可能です。

ボックスタイプ：link（リンク）の設定

項目	値
接続元ID	接続元IDを任意の値で設定します。
接続先ID	接続先IDを任意の値で設定します。

ご注意

ユーザー発話ボックス同士は接続できません。

ボックスタイプ：control-change-scenario（シナリオ遷移）の設定

項目	値
遷移先ID	遷移先シナリオIDを設定します。

ボックスタイプ：external（外部API連携）の設定

項目値

ラベル名ラベル名を任意の値で設定します。（設定なしも可）

入力条件

入力条件を任意の値で設定します。（設定なしも可）

発話内容

APIリクエストでエラーが発生した場合、応答を発話するかを設定します。
設定できる発話内容は以下です。

text （応答を発話する）
none （発話しない）

エラー発生時の発話内容エラー発生時の発話内容を任意の値で設定します。（設定なしも可）
発話内容にnone （発話しない）を設定した場合は、値を設定してもエラー発生時に発話されません。

リクエストメソッド

リクエストメソッドを設定します。設定できるリクエストメソッドは以下です。

GET
POST
PUT
DELETE
PATCH

リクエストURL 接続先APIのリクエストURLを任意の値で設定します。

リクエストヘッダー

リクエストヘッダーを" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。

JSON例

{

　　"key1":　"val1",

　　"key2":　"val2"

}

リクエストボディ

リクエストボディを" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。

JSON例

{

　　"botId":　"XXXX",

　　"appId":　"[@appID]",

　　"voiceText":　"[@input]"

}

保存するレスポンス内容保存するレスポンス内容を任意の値で設定します。（設定なしも可）

ご注意

複数の入力条件、保存するレスポンス内容を設定したい場合は、|（パイプ）で区切ることで設定可能です。

ボックスタイプ：interpretation（意図解釈エンジン連携）の設定

項目値

ラベル名ラベル名を任意の値で設定します。（設定なしも可）

入力条件

入力条件を任意の値で設定します。（設定なしも可）

意図解釈URL

リクエストする意図解釈エンジンのURLを設定します。

URL例

1	https://api-sunaba.xaiml.docomo-dialog.com/taskRecognition （SUNABAの意図解釈エンジンURL）

リクエスト発話

リクエストする発話内容を設定します。（変数も指定可能）

発話例

1 2	[#all] （#ユーザ発話全体） [#loc] までの乗換案内（#場所）

タスクID リクエストするタスクIDを設定します。
設定できるタスクIDについては、こちらをご覧ください。

コマンドID リクエストするコマンドIDを設定します。
設定できるコマンドIDについては、こちらのタスク詳細をご覧ください。

保存するレスポンス情報

意図解釈エンジンからのレスポンスを保存する変数を設定します。
設定できるレスポンス内容は以下です。

「タスクIDを設定」の場合 : @<変数名>=taskId=undefined
「コマンドIDを設定」の場合 : @<変数名>=commandId=undefined
「レスポンスのキーを設定」の場合 : @<変数名>=text=<JSONキーを指定する記述>

JSONキーの指定は、CGSの実行結果取得方法であるJSONキーを指定する記述方法のbodyキー以降を記述します。
詳しくは、CGSとは？のCGS実行結果取得方法をご覧ください。

JSONキー指定例

1	@taskId=text=dialogStatus.slotStatus.slotValue

ご注意

複数の入力条件、保存するレスポンス情報を設定したい場合は、|（パイプ）で区切ることで設定可能です。

ボックスタイプ：date（現在日時取得）の設定

項目値

ラベル名ラベル名を任意の値で設定します。（設定なしも可）

入力条件

入力条件を任意の値で設定します。（設定なしも可）

保存する日時内容

取得した日時内容を保存する変数を設定します。
設定できる日時フォーマットは以下です。

「取得日時を選択」の場合 : @<変数名>=date=<選択日時>
「フォーマットで指定する」の場合 : @<変数名>=format=<フォーマット表記>

フォーマット設定例

1 2	@date=date=year　（取得日時を選択） @date=format=yyyy/MM/dd　HH:mm:ss　（フォーマットを指定する）

ご注意

複数の入力条件、保存する日時内容を設定したい場合は、|（パイプ）で区切ることで設定可能です。

ボックスタイプ：botlink（ボット連携）の設定

項目値

ラベル名ラベル名を任意の値で設定します。（設定なしも可）

入力条件

入力条件を任意の値で設定します。（設定なしも可）

発話内容

ボット連携でエラーが発生した場合、応答を発話するかを設定します。
設定できる発話内容は以下です。

text （応答を発話する）
none （発話しない）

連携先ボットID 連携先ボットIDを設定します。

連携先トピックID 連携先ボットのトピックIDを設定します。（設定なしも可）

リクエスト発話

リクエストする発話内容を設定します。（変数も指定可能）

発話例

1 2	[#all] （#ユーザ発話全体） [#loc] までの乗換案内（#場所）

言語コード

言語コードを設定します。（設定なしも可）

言語コード例

ja-JP

clientdataの引き継ぎ

clientdataの引き継ぎをするかを設定します。設定できる値は以下です。

0 （引き継がない）
1 （引き継ぐ）

保存するレスポンス内容

連携ボットからのレスポンスを保存する変数を設定します。
設定できるレスポンス内容は以下です。

「連携ボットの回答を設定」の場合 : @<変数名>=bot=undefined
「テキストで設定」の場合 : @<変数名>=text=<テキスト内容>

レスポンス設定例

1 2	@sraix_result=bot=undefined （連携ボットの回答を設定） @sraix_result=text=ありがとうございました。（テキストで設定）

ご注意

複数の入力条件、保存するレスポンス内容を設定したい場合は、|（パイプ）で区切ることで設定可能です。

サンプル

システム発話起点／システム発話（LINE設定なし、my daiz設定あり）／システム発話（LINE設定あり、my daiz設定なし）／リンク／シナリオ遷移／外部API連携を定義するサンプルです。

CSV例

#システム発話起点の設定

system.init,control-system-init

#システム発話の設定（LINE設定なし、my daiz設定あり）

_ssb-1,system,はじめまして,@name=not_set,はじめまして。あなたのお名前は？|あなたのお名前は？,@name=text=[#any],,"[{""type"":""text"",""payload"":{""expression"":""こんにちは""}}]",0,

#システム発話の設定（LINE設定あり、my daiz設定なし）

_ssb-2,system,LINEテキスト,,,,"[{""type"":""text"",""text"":""$ テキスト"",""emojis"":[{""index"":0,""emojiId"":""001"",""productId"":""5ac1bfd5040ab15980c9b435""}]}]",,0,

#システム発話の設定（音声合成あり）

_ssb-3,system,音声合成,,こんにちは,,,,0,"{""utterance"":""こんにちは"",""speakerId"":""jpn_JP-F-S0103-T001-E01-SR0"",""styleId"":""jpn_JP-F-S0103-T001-E01"",""voiceType"":0.5,""powerRate"":1,""speechRate"":1.2,""intonation"":5,""pitch"":10}"

#リンクの設定

_link-1,link,system.init,_ssb-1

#シナリオ遷移の設定

_cb-1,control-change-scenario,s4lsaeu6gdmskfc

#外部API連携の設定

_cb-2,external,サンプルAPI,@name=set,text,エラーが発生致しました。,GET,http://sample.jp,"{""key1"":""val1""}","{""key"":""[@input]""}",@message=sample.message

#意図解釈エンジン連携の設定

_cb-3,interpretation,意図解釈エンジン,@taskId=set,https://api-sunaba.xaiml.docomo-dialog.com/taskRecognition,[#all],00000000,00000000000,@taskId=text=dialogStatus.slotStatus.slotValue

#現在日時取得の設定

_cb-4,date,現在日時取得,@date=set,@date=format=yyyy/MM/dd　HH:mm:ss

#ボット連携の設定

_cb-5,botlink,サンプルボット,@input=set,text,こんにちは,3984_sampleBot,サンプル,[#all],ja-JP,0,こんにちは,@sraix_result=bot=undefined

ID例

system.init （システム発話起点ID）

user.init-1 （ユーザー発話起点ID）

_cb-1 （シナリオ遷移ID、外部API連携ID、意図解釈エンジン連携ID、現在日時取得ID、ボット連携ID）

_ssb-1 （システム発話ID）

_usb-1 （ユーザー発話ID）

_link-1 （リンクID）

入力条件例

@name=set （nameが設定されているとき）

@name=not_set （nameが設定されていないとき）

@name=text=高橋（nameが高橋のとき）

@name=math=>0 （nameが0より大きいとき）

@name=regex=[xyz] （nameが正規表現でxyzとマッチングするとき）

システム発話の発話内容例

こんにちは。（「こんにちは。」と発話）

[@name]です。（nameの値を引用し、「XXXXです。」と発話）

[#any]です。（アスタリスク全体を引用し、「XXXXです。」と発話）

[#all]です。（ユーザー発話全体を引用し、「XXXXです。」と発話）

[#org]です。（組織を引用し、「XXXXです。」と発話）

[#spn]です。（人名を引用し、「XXXXです。」と発話）

[#loc]です。（場所を引用し、「XXXXです。」と発話）

[#art]です。（固有物名を引用し、「XXXXです。」と発話）

[#dat]です。（日付表現を引用し、「XXXXです。」と発話）

[#tim]です。（時刻表示を引用し、「XXXXです。」と発話）

[#mny]です。（金額表を引用し、「XXXXです。」と発話）

[#pct]です。（割合表現を引用し、「XXXXです。」と発話）

ユーザー発話の発話内容例

OK=exact （「OK」と完全一致で一致）

OK=surface_partial （「OK」と読み一致で一致）

OK=exact_partial （「OK」と完全（部分一致）で一致）

OK=surface_partial （「OK」と読み（部分一致）で一致）

OK=normalization_partial （「OK」と正規化（部分一致）で一致）

OK=synonym_partial （「OK」と類義語（部分一致）で一致）

OK=regex （「OK」と正規表現で一致）

覚える内容例

@name=text=XXXX （nameにテキストでXXXXを覚えさせるとき）

@name=text=[#any] （nameにテキストでアスタリスク全体を覚えさせるとき）

@name=text=[#all] （nameにテキストでユーザー発話全体を覚えさせるとき）

@name=text=[#org] （nameにテキストで組織を覚えさせるとき）

@name=text=[#spn] （nameにテキストで人名を覚えさせるとき）

@name=text=[#loc] （nameにテキストで場所を覚えさせるとき）

@name=text=[#art] （nameにテキストで固有物名を覚えさせるとき）

@name=text=[#dat] （nameにテキストで日付表現を覚えさせるとき）

@name=text=[#tim] （nameにテキストで時刻表示を覚えさせるとき）

@name=text=[#mny] （nameにテキストで金額表を覚えさせるとき）

@name=text=[#pct] （nameにテキストで割合表現を覚えさせるとき）

@name=before_speech=any （nameに直前のユーザー発話から抽出でアスタリスク全体を覚えさせるとき）

@name=before_speech=all （nameに直前のユーザー発話から抽出でユーザー発話全体を覚えさせるとき）

@name=before_speech=org （nameに直前のユーザー発話から抽出で組織を覚えさせるとき）

@name=before_speech=spn （nameに直前のユーザー発話から抽出で人名を覚えさせるとき）

@name=before_speech=loc （nameに直前のユーザー発話から抽出で場所を覚えさせるとき）

@name=before_speech=art （nameに直前のユーザー発話から抽出で固有物名を覚えさせるとき）

@name=before_speech=dat （nameに直前のユーザー発話から抽出で日付表現を覚えさせるとき）

@name=before_speech=tim （nameに直前のユーザー発話から抽出で時刻表示を覚えさせるとき）

@name=before_speech=mny （nameに直前のユーザー発話から抽出で金額表を覚えさせるとき）

@name=before_speech=pct （nameに直前のユーザー発話から抽出で割合表現を覚えさせるとき）

@name=aiml=XXXX （nameにAIMLを記述し覚えさせるとき）

@name=forget= （nameの内容を忘れさせるとき）