プロジェクト構成ファイル

プロジェクト構成ファイルは、コマンドの実行に必要な以下の情報を設定します。

  • 自然対話サーバ情報（ドメイン、エンドポイントなど）
  • デプロイ内容（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配列 – テストファイルを配列で指定します。
ポイント
パスワードのような設定ファイル中に記述するべきではない値や、コマンド実行時に変更したい値は環境変数を使って設定ファイルに記述します。
環境変数を設定ファイルで参照するには${環境変数名}の形式で記述してください。

ファイル記述例