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

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

ご注意

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

xAIMLファイル

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

ファイル仕様

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

サンプル

xAIML

MAPファイル

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

ファイル仕様

ファイル名 {カテゴリ名}.map
ファイル内容 フォーマット:テキスト形式 ファイルサイズ上限:200MB
置換する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。
置換前1tab置換後1   tabはタブ文字に置き換えてください。
置換前2tab置換後2
置換前・置換後の文字列は以下に準拠してください。

 置換前:1~200文字
 置換後:1文字以上

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

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

サンプル

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

fruit.map
xAIML

SETファイル

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

ファイル仕様

ファイル名 {カテゴリ名}.set
ファイル内容 フォーマット:テキスト形式 ファイルサイズ上限:5MB
定義する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。
文字列1
文字列2
文字列は1~200文字の間で記述してください。
   
ボットの言語がja-JPの場合、オプションで先頭行に正規化モードを指定できます。

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

サンプル

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

fruit.set

シナリオテストファイル

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

ファイル仕様

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

サンプル

scenario.tsv

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のように「優先して聞き返したいキー(全角スペース)質問文」の形式で「真理表生成用質問文」に記載してください。
例1:聞き返しキー順フラグを利用しない場合
真理表生成用質問文
携帯でメールを送りたい(聞き返しキー順フラグ: 未指定 or 0)
真理表のキー
携帯 メール 送る
例2:聞き返しキー順フラグを利用した場合
真理表生成用質問文
メール 携帯でメールを送りたい(聞き返しキー順フラグ: 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についての質問ですか?」と「携帯についての質問ですか?」と「画像についての質問ですか?」の全てが聞き返されます。

サンプル

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

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

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
ファイル内容 フォーマット:テキスト形式(CSV)
ボックスごとに定義する内容をカンマ区切りで記述します。複数記述する際は別の行に記述してください。
(1ファイルに記述できる行数は最大100行です。)
ID1,ボックスタイプ1,ラベル名1,入力条件1,発話内容1,覚える内容1,…
ID2,ボックスタイプ2,ラベル名2,入力条件2,発話内容2,覚える内容2,…
定義できる内容は、後述の設定内容一覧をご覧ください。

設定内容一覧

共通設定

項目
ID IDを任意の値で設定します。CSVアップロード時にシステムが自動で払い出すIDに置き換わります。
(IDが置き換わっても、リンクの設定で記載したボックスの接続線は保持されます。)
システム発話起点のIDはsystem.initと記述してください。
(システム発話起点の設定は1シナリオにつき1つだけできます。)
ボックスタイプ

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

control-system-init          (システム発話起点)
control-user-init               (ユーザー発話起点)
system                                          (システム発話)
user                                               (ユーザー発話)
link                                               (リンク)
standby-motion                       (待機モーション)
date                                               (現在日時取得)
全てのボックスタイプには、個別で設定が必要です。
個別で設定する内容は後述の設定内容をご覧ください。

ボックスタイプ:control-system-init(システム発話起点)/control-user-init(ユーザー発話起点)の設定

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

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

  • initialInput          (初期入力)
  • customize                 (カスタマイズ)
JSON例

ボックスタイプ:system(システム発話)

項目
ラベル名 ラベル名を任意の値で設定します。(設定なしも可)
入力条件 システム発話の入力条件を任意の値で設定します。(設定なしも可)
※現在、入力条件の値に|(パイプ)は使用できません。
 |(パイプ)を使用する場合は、アップロード後にAIアバターエディター上で入力条件の変更を行ってください。
発話内容 設定できません。
覚える内容 覚える内容を任意の値で設定します。(設定なしも可)
LINE 設定できません。
my daiz 設定できません。
選択ボタン自動挿入 設定する値は0 (選択ボタン自動挿入なし)固定です。
音声合成 AIアバター用音声合成の設定を" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。

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

  • name              (名前)
  • speakerId  (話者モデルID)
  • styleId       (口調モデルID)
  • voiceType  (音声の声質)
  • powerRate  (音量)
  • speechRate(話速)
  • intonation(抑揚)
  • pitch            (声の高さ)
JSON例
AIアバター AIアバター用システム発話の設定を" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。

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

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

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

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

ボックスタイプ:user(ユーザー発話)の設定

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

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

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

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

ボックスタイプ:standby-motion(待機モーション)の設定

項目
ラベル名 ラベル名を任意の値で設定します。(設定なしも可)
AIアバター AIアバター用待機モーションの設定を" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。

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

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

ボックスタイプ: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

サンプル

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

※各項目のサンプルは、GUIエディター用シナリオCSVファイルのサンプルをご確認ください。

CSV例

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

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

ファイル仕様

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

サンプル

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

fruit.csv

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

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

ファイル仕様

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

設定内容一覧

共通設定

項目
ID IDを任意の値で設定します。CSVアップロード時にシステムが自動で払い出すIDに置き換わります。
(IDが置き換わっても、リンクの設定で記載したボックスの接続線は保持されます。)
システム発話起点のIDはsystem.initと記述してください。
(システム発話起点の設定は1シナリオにつき1つだけできます。)
ボックスタイプ ボックスタイプを設定します。設定できるボックスタイプは以下です。
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例

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

  • text          (テキスト)
  • sticker   (スタンプ)
  • image        (画像)
  • video        (動画)
  • audio        (音声)
  • location (位置情報)
  • buttons   (ボタン)
  • confirm   (確認)
  • json          (JSON)
ドコモAIエージェントAPIで利用できるアクションオブジェクトには制限があります。
詳細については、ドコモAIエージェントAPIへお問い合わせください。
my daiz my daiz用システム発話の設定を"[ ]"内にJSON形式で設定します。(設定なしも可)
JSON内で使用している"はエスケープします。
JSON例
設定できるメッセージタイプは以下です。

  • text           (テキスト)
  • media        (メディア)
  • button      (ボタン)
  • conpaund (カルーセル)
  • json           (JSON)
選択ボタン自動挿入 選択ボタン自動挿入を設定します。設定できる値は以下です。
0 (選択ボタン自動挿入なし)
1 (選択ボタン自動挿入あり)
音声合成 システム発話の音声合成の設定を" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。

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

  • utterance  (読み上げテキスト)
  • speakerId  (話者モデルID)
  • styleId       (口調モデルID)
  • voiceType  (音声の声質)
  • powerRate  (音量)
  • speechRate(話速)
  • intonation(抑揚)
  • pitch            (声の高さ)
JSON例
ご注意

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

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

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

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

ボックスタイプ:control-change-scenario(シナリオ遷移)の設定

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

ボックスタイプ:external(外部API連携)の設定

項目
ラベル名 ラベル名を任意の値で設定します。(設定なしも可)
入力条件 入力条件を任意の値で設定します。(設定なしも可)
※現在、入力条件の値に|(パイプ)は使用できません。
 |(パイプ)を使用する場合は、アップロード後にGUIエディタ上で入力条件の変更を行ってください。
発話内容 APIリクエストでエラーが発生した場合、応答を発話するかを設定します。
設定できる発話内容は以下です。

  • text (応答を発話する)
  • none (発話しない)
エラー発生時の発話内容 エラー発生時の発話内容を任意の値で設定します。(設定なしも可)
発話内容にnone (発話しない)を設定した場合は、値を設定してもエラー発生時に発話されません。
リクエストメソッド リクエストメソッドを設定します。設定できるリクエストメソッドは以下です。

  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
リクエストURL 接続先APIのリクエストURLを任意の値で設定します。
リクエストヘッダー リクエストヘッダーを" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。
JSON例
リクエストボディ リクエストボディを" "内にJSON形式で設定します。
JSON内で使用している"はエスケープします。
JSON例
保存するレスポンス内容 保存するレスポンス内容を任意の値で設定します。(設定なしも可)
ご注意

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

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

ボックスタイプ:interpretation(意図解釈エンジン連携)の設定

項目
ラベル名 ラベル名を任意の値で設定します。(設定なしも可)
入力条件 入力条件を任意の値で設定します。(設定なしも可)
※現在、入力条件の値に|(パイプ)は使用できません。
 |(パイプ)を使用する場合は、アップロード後にGUIエディタ上で入力条件の変更を行ってください。
意図解釈URL

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

URL例

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

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

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

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

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

JSONキー指定例

ご注意

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

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

ボックスタイプ:date(現在日時取得)の設定

項目
ラベル名 ラベル名を任意の値で設定します。(設定なしも可)
入力条件 入力条件を任意の値で設定します。(設定なしも可)
※現在、入力条件の値に|(パイプ)は使用できません。
 |(パイプ)を使用する場合は、アップロード後にGUIエディタ上で入力条件の変更を行ってください。
保存する日時内容

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

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

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

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

項目
ラベル名 ラベル名を任意の値で設定します。(設定なしも可)
入力条件 入力条件を任意の値で設定します。(設定なしも可)
※現在、入力条件の値に|(パイプ)は使用できません。
 |(パイプ)を使用する場合は、アップロード後にGUIエディタ上で入力条件の変更を行ってください。
発話内容 ボット連携でエラーが発生した場合、応答を発話するかを設定します。
設定できる発話内容は以下です。

  • text (応答を発話する)
  • none (発話しない)
エラー発生時の発話内容 エラー発生時の発話内容を任意の値で設定します。(設定なしも可)
発話内容にnone (発話しない)を設定した場合は、値を設定してもエラー発生時に発話されません。
連携先ボットID 連携先ボットIDを設定します。
連携先トピックID 連携先ボットのトピックIDを設定します。(設定なしも可)
リクエスト発話 リクエストする発話内容を設定します。(変数も指定可能)
発話例
言語コード 言語コードを設定します。(設定なしも可)
言語コード例
clientdataの引き継ぎ clientdataの引き継ぎをするかを設定します。設定できる値は以下です。
0 (引き継がない)
1 (引き継ぐ)
デフォルト発話 連携ボットからのレスポンスが無い場合のデフォルト応答内容を任意の値で設定します。(設定なしも可)
保存するレスポンス内容

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

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

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

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

サンプル

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

CSV例
ID例
入力条件例
システム発話の発話内容例
ユーザー発話の発話内容例
覚える内容例