REST APIリファレンス > モデルサーバー REST API > クイックスタートモデル
  

クイックスタートモデル

APIリソースを使用して、クイックスタートモデルに関する説明とステータス情報を取得します。

クイックスタートモデルの説明の取得

Modelhubリソースを使用して、すべてのクイックスタートモデルの名前と説明のリストを取得します。

GET要求

クイックスタートモデルに関する情報を取得するには、次のURIを使用します。
/mlops/api/v1/modelhub/models

GET応答

各クイックスタートモデルの概要を返します。
次の表に、各クイックスタートモデルの概要のフィールドを示します。
フィールド
タイプ
説明
displayName
String
ユーザーインタフェースに表示されるクイックスタートモデルの外部名。
name
String
クイックスタートモデルの内部名。
description
String
クイックスタートモデルの説明。
フレームワーク
String
モデルの作成に使用するフレームワーク。クイックスタートモデルはフレームワークPYTHONを使用します。
frameworkType
String
フレームワークの内部タイプ。クイックスタートモデルはタイプCUSTOMを使用します。

クイックスタートモデルの監視

modelhubリソースを使用して、すべてのクイックスタートモデルのステータスを取得します。

GET要求

すべてのクイックスタートモデルを監視するには、次のURIを使用します。
/mlops/api/v1/modelhub/monitor

GET応答

各クイックスタートモデルのステータスの概要を返します。
次の表に、各ステータスの概要のフィールドを示します。
フィールド
タイプ
説明
displayName
String
ユーザーインタフェースに表示されるクイックスタートモデルの外部名。
name
String
クイックスタートモデルの内部名。
deploymentStatus
String
クイックスタートモデルの現在のステータス。
deploymentState
String
クイックスタートモデルの要求された状態。モデルを開始または再開すると、要求された状態はENABLEDになります。モデルを停止すると、要求される状態はDISABLEDになります。
deploymentId
String
クイックスタートモデルのID。
predictUrl
String
モデルエンドポイントURL。URLを使用してモデルから予測を生成します。
クイックスタートモデルがある場合に適用されます。

クイックスタートモデルに関する情報の取得

Modelhubリソースを使用して、単一のクイックスタートモデルに関する情報を取得します。

GET要求

クイックスタートモデルに関する情報を取得するには、次のURIを使用します。
/mlops/api/v1/modelhub/preBuiltModel?name=<model name>
画像分類モデルに関する情報を取得するには、モデル名としてIMAGE_CLASSIFICATIONを使用します。テキスト翻訳モデルに関する情報を取得するには、モデル名としてTEXT_TRANSLATIONを使用します。

GET応答

クイックスタートモデルの概要を返します。
次の表に、各クイックスタートモデルの概要のフィールドを示します。
フィールド
タイプ
説明
displayName
String
ユーザーインタフェースに表示されるクイックスタートモデルの外部名。
name
String
クイックスタートモデルの内部名。
description
String
クイックスタートモデルの説明。
id
String
クイックスタートモデルのID。
status
String
クイックスタートモデルの現在のステータス。
predictUrl
String
モデルエンドポイントURL。URLを使用してモデルから予測を生成します。
クイックスタートモデルがある場合に適用されます。