REST APIリファレンス > モデルサーバー REST API > 機械学習モデル
  

機械学習モデル

APIリソースを使用して、テンプレートファイルのダウンロード、モデルファイルのアップロードとダウンロード、モデルの登録と編集などのユーザー定義の機械学習モデルに対する操作を実行します。

コードテンプレートファイルの取得

モデルリソースを使用して、機械学習モデルを定義するために必要なテンプレートファイルを取得します。

GET要求

コードテンプレートファイルを要求するには、次のURIを使用します。
/mlops/api/v1/model/template/custom

GET応答

コードテンプレートZIPファイルをoctet-streamファイルとして返します。

モデルファイルのアップロード

機械学習アルゴリズムを定義するファイルを含むモデルZIPファイルをアップロードします。
新しいモデルファイルをアップロードする前に、モデルファイルIDを生成する要求を送信します。次に、要求でモデルファイルIDを使用してファイルをアップロードするか、更新します。

モデルファイルIDの生成

モデルファイルをアップロードする前に、モデルリソースを使用してモデルファイルIDを生成します。

POST要求

モデルファイルIDを生成するには、次のURIを使用します。
/mlops/api/v1/model/upload/generateID
要求に次のフィールドを含めます。
フィールド
タイプ
説明
file_name
String
アップロードするモデルファイルの名前（ファイル拡張子を含む）。

POST応答

新しいモデルファイルIDを返します。

モデルファイルのアップロードまたは更新

モデルリソースとモデルファイルIDを使用して、モデルファイルをアップロードまたは更新します。

POST要求

モデルファイルをアップロードまたは更新するには、URIにモデルファイルIDを含めます。次のURIを使用します。
/mlops/api/v1/model/upload/<model file ID>
要求に次のフィールドを含めます。
フィールド
タイプ
説明
file
String
マルチパートファイルとしてアップロードするモデルファイル。
フレームワーク
String
値としてPYTHONまたはTENSORFLOWを使用します。

POST応答

モデルファイルIDを返します。

機械学習モデルの登録

モデルファイルをアップロードした後に、ドキュメントリソースを使用して機械学習モデルを登録します。

POST要求

機械学習モデルを登録するには、URIにプロジェクトまたはフォルダIDを含めます。次のURIを使用します。
/frs/v1/Projects('<project ID>')/Documents
要求に次のフィールドを含めます。
フィールド
タイプ
説明
name
String
機械学習モデルのアセット名。
description
String
オプション。機械学習モデルの説明。
documentType
String
MLOPS_MODELを使用します。
nativeData
オブジェクト
機械学習モデルを定義するBLOBオブジェクト。
次のフィールドをnativeDataオブジェクトに含めます。
フィールド
タイプ
説明
name
String
機械学習モデルのアセット名。
フレームワーク
String
機械学習モデルの作成に使用するフレームワーク。次のいずれかの値を使用します。
  • - Python
  • - PyTorch
  • - TensorFlow
framework_type
String
フレームワークの内部タイプ。
Pythonモデルの場合は、Customを使用します。
PyTorchまたはTensorFlowモデルの場合は、Standardを使用します。
file_id
String
モデルファイルをアップロードしたときに生成されるモデルファイルID。
file_name
String
モデルファイルの名前。この名前は、モデルファイルIDの生成に使用したファイル名と一致している必要があります。
サイズ
String
モデルファイルのサイズ（GB）。
file_type
String
zipを使用します。
inputField
機械学習モデルが要求する入力フィールド。1つ以上の入力フィールドを含めます。
name
String
フィールドの名前。
dataType
String
フィールドのデータ型。
shape
String
arrayデータ型に必須です。配列の形状。例: [2,3]。
outputField
機械学習モデルが返す出力フィールド。1つ以上の出力フィールドを含めます。
name
String
フィールドの名前。
dataType
String
フィールドのデータ型。
shape
String
arrayデータ型に必須です。配列の形状。例: [2,3]。

POST応答

機械学習モデルの概要を返します。

機械学習モデルの編集

ドキュメントリソースを使用して、機械学習モデルを編集します。

PATCH要求

機械学習モデルを編集するには、URIに機械学習モデルIDを含めます。次のURIを使用します。
/frs/v1/Documents('<model ID>')
応答からモデルIDを取得して機械学習モデルを登録します。
要求に次のフィールドを含めます。
フィールド
タイプ
説明
name
String
機械学習モデルのアセット名。
description
String
オプション。機械学習モデルの説明。
documentType
String
MLOPS_MODELを使用します。
nativeData
オブジェクト
機械学習モデルを定義するBLOBオブジェクト。
次のフィールドをnativeDataオブジェクトに含めます。
フィールド
タイプ
説明
name
String
機械学習モデルのアセット名。
フレームワーク
String
機械学習モデルの作成に使用するフレームワーク。次のいずれかの値を使用します。
  • - Python
  • - PyTorch
  • - TensorFlow
framework_type
String
フレームワークの内部タイプ。
Pythonモデルの場合は、Customを使用します。
PyTorchまたはTensorFlowモデルの場合は、Standardを使用します。
file_id
String
モデルファイルをアップロードしたときに生成されるモデルファイルID。
file_name
String
モデルファイルの名前。この名前は、モデルファイルIDの生成に使用したファイル名と一致している必要があります。
サイズ
String
モデルファイルのサイズ（GB）。
file_type
String
zipを使用します。
inputField
機械学習モデルが要求する入力フィールド。1つ以上の入力フィールドを含めます。
name
String
フィールドの名前。
dataType
String
フィールドのデータ型。
shape
String
arrayデータ型に必須です。配列の形状。例: [2,3]。
outputField
機械学習モデルが返す出力フィールド。1つ以上の出力フィールドを含めます。
name
String
フィールドの名前。
dataType
String
フィールドのデータ型。
shape
String
arrayデータ型に必須です。配列の形状。例: [2,3]。

PATCH応答

機械学習モデルの概要を返します。

機械学習モデルのモデルファイルの取得

モデルリソースを使用して、登録された機械学習モデルからモデルZIPファイルをダウンロードします。

GET要求

モデルファイルを取得するには、URIに機械学習モデルIDを含めます。次のURIを使用します。
/mlops/api/v1/model/download/<model ID>
応答からモデルIDを取得して機械学習モデルを登録します。

GET応答

モデルファイルのoctet-streamを返します。