オプション設定関連ファイル仕様

ボットのオプション設定に関連するファイルの仕様です。

ご注意

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

NGワードファイル

システム発話におけるNGワードを定義するファイルです。
システム発話にNGワードが含まれる場合に、システム発話全体を代替回答で置き換えます。

また、NGワードファイル内に代替回答を定義するかによって使用する代替回答が異なります。

  • 定義する場合 … NGワードと同じ行に記述した代替回答を使用します。(代替回答ファイルは使用しません)
  • 定義しない場合 … 代替回答ファイルに定義されている中からランダムに使用します。
ご注意

NGワードファイル内で代替回答の定義有無を混在させることはできません。

ファイル仕様

ファイル名 {任意}.ng
ファイル内容 フォーマット:テキスト形式 ファイルサイズ上限:5MB
定義する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。
NGワード1tab代替回答1   tabはタブ文字に置き換えてください。
NGワード2tab代替回答2
※代替回答ファイルを利用する場合は以下のようにNGワードのみ記述してください。
NGワード1
NGワード2

サンプル

NGワードファイル内に代替回答を記述するサンプルです。
※代替回答ファイルを使用するサンプルは、代替回答ファイルのサンプルをご覧ください。

test.ng
システム発話例

代替回答ファイル

システム発話にNGワードが含まれる場合の代替回答を定義するファイルです。
代替回答を複数定義した場合は、ランダムに代替回答を選択します。

ファイル仕様

ファイル名 {任意}.ans
ファイル内容 フォーマット:テキスト形式 ファイルサイズ上限:5MB
定義する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。
代替回答1
代替回答2

サンプル

代替回答ファイルを使用してNGワードを置き換えるサンプルです。

test.ng
test.ans
システム発話例

DATファイル

xAIMLファイルのコンパイル結果が格納されるファイルです。

ファイル仕様

ファイル名 {任意}.dat
ファイル内容 フォーマット:バイナリ形式 ファイルサイズ上限:500MB
自然対話プラットフォームにより作成されるファイルです。

ボット属性ファイル 

ボット属性を定義するファイルです。
ファイル一括アップロードまたはファイル一括ダウンロードでのみ利用できます。

ファイル仕様

ファイル名 botattr.properties
ファイル内容 フォーマット:テキスト形式 ファイルサイズ上限:5MB
定義する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。
キー1=値1
キー2=値2
定義できるボット属性は、後述のボット属性一覧をご覧ください。

ボット属性一覧(現時点で利用できる属性は1種類のみ)

キー
scope <sraix>による呼び出し設定を以下の4種類で指定します。
globalpublicprojectnull(無効)
publicprojectを指定したボットは、Frontボットとして使用できません。
指定内容に応じたプロジェクト内、プロジェクト外からの呼び出し可否およびFrontボットとしての使用可否については下表をご覧ください。

利用方法 \ スコープ global public project null
プロジェクト内からのsraix呼び出し ×
プロジェクト外からのsraix呼び出し × ×
Frontボット × ×

サンプル

ボット属性を定義するサンプルです。

botattr.properties

ボット設定ファイル

ボット設定を定義するファイルです。
ファイル一括アップロードまたはファイル一括ダウンロードでのみ利用できます。

ファイル仕様

ファイル名 botconf.properties
ファイル内容 フォーマット:テキスト形式 ファイルサイズ上限:5MB
定義する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。
キー1=値1
キー2=値2

ボット設定一覧

キー
DialogueTimeout 対話タイムアウトを設定します。
ReplyAgainTimeoutSec 聞き直しタイムアウトを設定します。
SensitiveInfoKey 秘匿情報キーを設定します。
xxx_Url サービスのURLを設定します。xxxには任意のサービス名を指定します。
(サービス名をweatherとする場合はweather_Urlとなります)
xxx_ConnectionRetry サービスの接続総試行回数を任意で設定します。
xxxには設定先のサービス(xxx_Url)で指定したサービス名を指定します。
xxx_ConnectionTimeoutSec サービスの接続タイムアウトを任意で設定します。
xxxには設定先のサービス(xxx_Url)で指定したサービス名を指定します。
xxx_ResponseTimeoutSec サービスの応答タイムアウトを任意で設定します。
xxxには設定先のサービス(xxx_Url)で指定したサービス名を指定します。

サンプル

ボット設定を定義するサンプルです。

botconf.properties

ボットプロパティファイル

ボットプロパティを定義するファイルです。
ファイル一括アップロードまたはファイル一括ダウンロードでのみ利用できます。

ファイル仕様

ファイル名 bot.properties
ファイル内容 フォーマット:テキスト形式 ファイルサイズ上限:5MB
定義する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。
キー1=値1
キー2=値2

サンプル

ボットプロパティを定義するサンプルです。

bot.properties

デフォルトPredicateファイル

デフォルトPredicateを定義するファイルです。
ファイル一括アップロードまたはファイル一括ダウンロードでのみ利用できます。

ファイル仕様

ファイル名 preddef.properties
ファイル内容 フォーマット:テキスト形式 ファイルサイズ上限:5MB
定義する内容を以下の形式で記述します。複数記述する際は別の行に記述してください。
キー1=値1
キー2=値2

サンプル

デフォルトPredicateを定義するサンプルです。

bot.properties