このセクションの他の記事
- サービスとは
- サービス管理画面
- 新規サービスを追加（学習）
- 新規サービスを追加（推論）
- 新規サービスを追加（プロジェクト管理）
- 新規サービスを追加（最適化）
- サービスの詳細と実行コードの作成（推論）
- サービスの詳細と実行コードの作成（学習）
- サービスの詳細と実行コードの作成（プロジェクト管理）
- サービスの詳細と実行コードの作成（最適化）
- サービスの編集
- サービス使用状況を表示
- APIの共通仕様
- APIの返り値（数値データ／文書データ（csv）の分類）
- APIの返り値（回帰）
- APIの返り値（画像の分類、ベクトル化、次元圧縮）
- APIの返り値（文書データ（zip/txt/pdf）の分類、ベク…
- APIの返り値（時系列解析）
- APIの返り値（学習）
- APIの返り値（最適化）
サービスの詳細と実行コードの作成（最適化）
作成したサービスの内容を確認し、APIを実行するコードを作成します。
■最適化サービスのAPI URLとシークレットキーの確認
サービス管理画面［最適化サービス］タブのサービス一覧から、詳細を確認したいサービスを選んで詳細画面に進みます。
＜最適化サービスの詳細画面＞
- API URL
APIごとに付与される一意のURLです。
APIを介してMatrixFlowに接続するためのURLで、外部システムに設定します。
右端のクリップアイコンをクリックすると、クリップボードにコピーします。
また、上図青枠の下向き矢印をクリックすると、実行する機能を［最適化を実行／最適化を再実行／最適化の進行状況を取得／最適化を中止］から選択でき、機能に応じてURLも変わります。 - シークレットキー
APIごとに付与される一意の暗号キーです。
APIを介してMatrixFlowに接続するための認証情報で、外部システムに設定します。
右端のクリップアイコンをクリックすると、クリップボードにコピーします。 - APIの各種情報
サンプルコード、リクエスト、レスポンス（返り値）の情報です。
実行する機能によって内容が異なります。詳細は後述をご覧ください。 - サービス情報
サービスに登録されているレシピ名と前処理が表示されます。
また、上図紫枠でデータセットを選択すると、Request Bodyの「最適化の条件」を設定する際、データセットを開かなくても列名を参照することができます。
■APIの各種情報について
＜サンプルコード＞
APIを実行する外部システムに組み込むサンプルコードをcurlとPythonで用意しています。
下図赤枠の下向き矢印をクリックすると、curlとPythonを切り替えることができます。
また、実行する機能によってサンプルコードも切り替わります。
サンプルコードをコピー＆ペーストして組み込む場合、実際の環境に合わせてRequestBodyのパラメータを変更する必要があります。詳細は後述の＜RequestBody＞をご覧ください。
※＜RequestHeader＞や＜RequestBody＞を参照して、ご利用環境のプログラミング言語でコーディングすることもできます。
＜RequestHeader＞
サービスを作成した時点で、サンプルコードには設定されています。
| ヘッダー | データ型 | 値と説明 |
|---|---|---|
| x-matrixflow-secretkey | 文字列 | API作成時に発行される個々のシークレットキーの値 |
| Content-Type | 文字列 | application/json |
＜RequestBody＞
［最適化を実行］および［最適化を再実行］時のみ指定が必要です。
次のパラメータを実際に合わせて変更します。
Windows環境のcurlで実行する場合、サンプルコード内の［post.json］のように、RequestBodyのパラメータのみを記述したjsonファイルを別に用意します。
jsonファイルは、サンプルコード内の post.json をコピー＆ペーストしてテキストエディタなどで作成し、設定値のみを変更されることをお勧めします。
| パラメータ | データ型 | 説明 | |
|---|---|---|---|
| data_name | 文字列 | 最適化を行うAIモデルの学習に使用する、MatrixFlowにアップロードされているデータセット名を指定 | |
| train_config | 詳細後述 | 文字列 | 最適化を行うAIモデルの学習時のテストデータ比率を設定 SaaS上で実行する場合の最後のステップ、「学習の詳細設定」画面の設定項目に該当 |
| optimization_conditions | 詳細後述 | 文字列 | 最適化の条件を指定 |
| trained_ai | name | 文字列 | 学習後に保存する、学習済みAIの名前を指定（最適化を実行時のみのOption） |
| description | 文字列 | 学習後に保存する、学習済みAIの説明を指定（最適化を実行時のみのOption） | |
| trained_ai_id | 文字列 | 既存の最適化用学習済みAIのIDを指定（最適化を再実行時のみ必須） |
■train_configに設定するパラメータ
train_config内のパラメータは、テストデータ比率です。SaaS上で最適化を行う場合、最後のステップ「学習の詳細設定」画面の設定項目に該当します。
サンプルコードにはデフォルト値が設定されますので、適宜変更します。
※設定するパラメータは、最適化を実行，最適化を再実行 共通です。
| パラメータ | 説明 | |
|---|---|---|
| data | ratio | テストデータ比率 デフォルト値 0.1 |
■optimization_conditionsに設定するパラメータ
optimization_conditions内のパラメータは、最適化を行う条件です。SaaS上で最適化を行う場合、最後のステップ「最適化条件の設定」画面の設定項目に該当します。
サンプルコードには、指定可能なすべてのパラメータが記載されていますので、不要な条件のパラメータは削除するかコメントアウトします。
※設定するパラメータは、最適化を実行，最適化を再実行 共通です。
| パラメータ | 説明 | ||
|---|---|---|---|
| column_conditions | 最小化／最大化／値に近づけたいときに設定 設定不要な場合、”column_conditions”: [] とする |
||
| column | 最小化／最大化／値に近づけたい列名 | ||
| condition | type | “minimize”：指定した列の値を最小化する “maximize”：指定した列の値を最大化する “closer”：”target” に指定した値に近づける |
|
| params | null：minimize, maximize時は固定値「null」 “target”：closer時のみ、近づける値を指定 デフォルト値 12 |
||
| integer | false：整数値のみの出力はしない true： 整数値のみ出力する |
||
| expressions | 最適化の条件を式で指定するときに設定 不要な場合、”expressions”: [] とする |
||
| condition | type | “minimize”：指定した式にマッチするよう最小化する “maximize”：指定した式にマッチするよう最大化する “closer”：指定した式の値を “target” に指定した値に近づける |
|
| params | null：minimize, maximize時は固定値「null」 “target”：closer時のみ、近づける値を指定 |
||
| expression | 条件式を入力 |
＜Responses＞
APIを実行し、成功した時に返される情報です。
最適化サービスのレスポンスは、実行する機能によって異なります。詳細は、APIの返り値（最適化）をご覧ください。