プロジェクト構成ファイルは、コマンドの実行に必要な以下の情報を設定します。
- 自然対話サーバ情報(ドメイン、エンドポイントなど)
- デプロイ内容(aimlファイル、ボットプロパティなど)
- テスト内容(テストファイル)
ファイル仕様
ファイル名
config.yml
ファイル構成
キー |
型 | 必須 | 説明 | |
---|---|---|---|---|
version |
string |
◯ | 設定ファイルのバージョンを指定します。"1" を指定してください。 |
|
servers |
hash 配列 |
◯ | 自然対話サーバの設定を配列で保持します。 詳細は「サーバ設定」を参照してください。 |
|
projects |
hash 配列 |
◯ | プロジェクトの設定を配列で保持します。 詳細は「プロジェクト設定」を参照してください。 |
サーバ設定
キー |
型 | 必須 | 説明 | ||
---|---|---|---|---|---|
name |
string |
◯ | コマンド実行時、サーバを指定する際に使用する名称を指定します。 | ||
config |
hash |
◯ | サーバの情報を保持します。 | ||
host |
string |
◯ | サーバのホスト名を指定します。 | ||
port |
integer |
◯ | サーバのポート番号を指定します。 | ||
protocol |
string |
◯ | サーバに接続するプロトコルをhttp かhttps のどちらかで指定します。 |
||
ssl_verify |
boolean |
– | プロトコルがhttps の場合、 SSL検証を行うかどうか指定します。指定しない場合は true となります。 |
||
user |
string |
– | 自然対話エンジンのユーザ名を指定します。 コマンド一覧を参照し、種別:Managementのコマンドを利用する場合は指定してください。 |
||
password |
string |
– | 自然対話エンジンのパスワードを指定します。 コマンド一覧を参照し、種別:Managementのコマンドを利用する場合は指定してください。 |
||
endpoint |
hash |
– | エンドポイントの情報を保持します。 | ||
management |
hash |
– | Management API のprefix およびheader 情報を保持します。 |
||
registration |
hash |
– | Registration API のprefix およびheader 情報を保持します。 |
||
dialogue |
hash |
– | Dialogue API のprefix およびheader 情報を保持します。 |
プロジェクト設定
キー |
型 | 必須 | 説明 | |
---|---|---|---|---|
name |
string |
◯ | コマンド実行時、プロジェクトを指定する際に使用する名称を指定します。 | |
config |
hash |
◯ | プロジェクトの情報を保持します。 | |
project_name |
string |
◯ | プロジェクト名を指定します。 この値は name と異なり、自然対話サーバに存在する実際のプロジェクト名でなければなりません。 |
|
bots |
hash 配列 |
◯ | このプロジェクトに属するボットの設定を配列で保持します。 | |
name |
string |
◯ | コマンド実行時、ボットを指定する際に使用する名称を指定します。 | |
config |
hash |
◯ | 必須パラメータであるbot_id で自然対話サーバにデプロイする際のボットIDを指定します。また、オプションの sraix で設定を行います。 |
|
aimls |
string 配列 |
– | アップロードするAIML ファイルのパスを配列で指定します。 |
|
sets |
string 配列 |
– | アップロードするSET ファイルのパスを配列で指定します。 |
|
maps |
string 配列 |
– | アップロードするMAP ファイルのパスを配列で指定します。 |
|
configs |
string 配列 |
– | アップロードするボットコンフィグファイルのパスを配列で指定します。 | |
properties |
string 配列 |
– | アップロードするボットプロパティファイルのパスを配列で指定します。 | |
tests |
string 配列 |
– | テストファイルを配列で指定します。 |
ポイント
パスワードのような設定ファイル中に記述するべきではない値や、コマンド実行時に変更したい値は環境変数を使って設定ファイルに記述します。環境変数を設定ファイルで参照するには
${環境変数名}
の形式で記述してください。
ファイル記述例
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
version: "1" servers: - name: TestServer config: host: ${HOST} port: 10443 protocol: https ssl_verify: true user: ${USER} password: ${PASSWORD} endpoint: management: prefix: /management/v2.7 header: content-type: application/json;charset=utf-8 registration: prefix: /UserRegistrationServer/users/applications header: content-type: application/json;charset=utf-8 dialogue: prefix: /SpontaneousDialogueServer/dialogue header: content-type: application/json;charset=utf-8 projects: - name: TestProject config: project_name: DA bots: - name: QBot config: bot_id: DA_QBot aimls: - qbot/qbot.aiml tests: - qbot/qbot_test.yml - name: HelloBot config: bot_id: DA_HelloBot sraix: global configs: - hellobot/hello.config properties: - hellobot/hello.property aimls: - hellobot/hello.aiml maps: - hellobot/hello.map sets: - hellobot/hello.set tests: - hellobot/hello_test.yml |