次の方法で共有

Models - Get

サービス:
Azure AI Services
API バージョン:
2023-04-01-preview

特定のモデルに関する情報を取得します。

返される状態コード:

  • 200: 操作が正常に完了しました。
  • 400: 要求の形式が正しくありません。
  • 404: 指定した名前のモデルが見つかりませんでした。
GET /models/{name}?api-version=2023-04-01-preview

URI パラメーター

名前 / 必須 型 説明
name
 path True

string

maxLength: 255
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$

取得するモデルの名前。
api-version
 query True

string

要求された API バージョン。

応答

名前 型 説明
200 OK

Model

成功
Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

例

Models_Get

要求のサンプル

GET /models/my_model_name?api-version=2023-04-01-preview

応答のサンプル

状態コード:
200 
{
  "name": "my_model_name",
  "createdDateTime": "2023-01-13T20:46:21.210Z",
  "updatedDateTime": "2023-01-13T20:46:21.210Z",
  "status": "notStarted",
  "trainingParameters": {
    "timeBudgetInHours": 1,
    "trainingDatasetName": "my_dataset_name"
  }
}

定義

名前 説明
ErrorResponse

エラーが発生したときに返される応答。
ErrorResponseDetails

エラー情報。
ErrorResponseInnerError

詳細なエラー。
Model

カスタム モデルをトレーニングするためのトレーニング実行について説明します。
ModelEvaluationParameters

モデルの評価方法を指定するためのパラメーター。
ModelKind

モデルの種類。
ModelPerformance

カスタムトレーニング済みモデルのパフォーマンス メトリック。
ModelState

読み取り専用です。 トレーニング実行の現在の状態。
ModelTagPerformance

カスタムトレーニング済みモデルによって認識される各タグのパフォーマンス メトリック。
TrainingParameters

トレーニング実行でカスタム モデルをトレーニングする方法を指定するためのパラメーター。

ErrorResponse

Object

エラーが発生したときに返される応答。

名前 型 説明
error

ErrorResponseDetails

エラー情報。

ErrorResponseDetails

Object

エラー情報。

名前 型 説明
code

string

エラー コード。
details

ErrorResponseDetails[]

詳細なエラーの一覧。
innererror

ErrorResponseInnerError

詳細なエラー。
message

string

エラーメッセージ。
target

string

エラーのターゲット。

ErrorResponseInnerError

Object

詳細なエラー。

名前 型 説明
code

string

エラー コード。
innererror

ErrorResponseInnerError

詳細なエラー。
message

string

エラーメッセージ。

Model

Object

カスタム モデルをトレーニングするためのトレーニング実行について説明します。

名前 型 説明
createdDateTime

string (date-time)

読み取り専用です。 トレーニングの実行が最初に作成された日時 (UTC)。
error

ErrorResponseDetails

エラー情報。
evaluationParameters

ModelEvaluationParameters

モデルの評価方法を指定するためのパラメーター。
modelPerformance

ModelPerformance

カスタムトレーニング済みモデルのパフォーマンス メトリック。
name

string

maxLength: 255
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$

読み取り専用です。 トレーニングの実行を一意に識別するために使用される名前。
status

ModelState

読み取り専用です。 トレーニング実行の現在の状態。
trainingCostInMinutes

integer (int32)

読み取り専用です。 実際のトレーニングコスト (分単位)。 トレーニングが完了した場合にのみ表示されます。
trainingParameters

TrainingParameters

トレーニング実行でカスタム モデルをトレーニングする方法を指定するためのパラメーター。
updatedDateTime

string (date-time)

読み取り専用です。 トレーニングの実行が最後に更新された日時 (UTC)。

ModelEvaluationParameters

Object

モデルの評価方法を指定するためのパラメーター。

名前 型 説明
testDatasetName

string

maxLength: 255
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$

テストに使用されるデータセット名。

ModelKind

列挙

モデルの種類。

値 説明
Product-Recognizer
Generic-Classifier
Generic-Detector

ModelPerformance

Object

カスタムトレーニング済みモデルのパフォーマンス メトリック。

名前 型 説明
accuracyTop1

number (double)

読み取り専用です。 多クラス分類モデルの場合。 地上真理値クラスが予測クラスと一致するテスト サンプルの割合。
accuracyTop5

number (double)

読み取り専用です。 多クラス分類モデルの場合。 地上の真理値クラスが上位 5 つの予測クラスにあるテスト サンプルの割合。
averagePrecision

number (double)

読み取り専用です。 モデルのパフォーマンスの尺度で、さまざまな信頼度しきい値での精度と再現率を要約します。
calibrationECE

number (double)

読み取り専用です。 多クラス分類モデルの場合。 調整エラーが予想されます。
meanAveragePrecision30

number (double)

読み取り専用です。 物体検出モデルの場合。 30%のしきい値での平均平均精度。
meanAveragePrecision50

number (double)

読み取り専用です。 物体検出モデルの場合。 50%のしきい値での平均平均精度。
meanAveragePrecision75

number (double)

読み取り専用です。 物体検出モデルの場合。 75%のしきい値での平均平均精度。
tagPerformance

<string,  ModelTagPerformance>

読み取り専用です。 モデルによって認識される各タグのパフォーマンス メトリック。

ModelState

列挙

読み取り専用です。 トレーニング実行の現在の状態。

値 説明
notStarted
training
succeeded
failed
cancelling
cancelled

ModelTagPerformance

Object

カスタムトレーニング済みモデルによって認識される各タグのパフォーマンス メトリック。

名前 型 説明
accuracy

number (double)

読み取り専用です。 多クラス モデルの場合。 タグの精度。
averagePrecision50

number (double)

読み取り専用です。 物体検出モデルの場合。 しきい値 50%での平均精度。

TrainingParameters

Object

トレーニング実行でカスタム モデルをトレーニングする方法を指定するためのパラメーター。

名前 型 説明
modelKind

ModelKind

モデルの種類。
timeBudgetInHours

integer (int32)

minimum: 1
maximum: 1344

トレーニングの時間予算 (時間単位)。 許容される最小値は 1 で、許容される最大値は GenericClassifier の場合は 336 時間、GenericDetector の場合は 1344 時間です。 これは、モデルのトレーニングに費やされるコンピューティング時間の最大量です。
trainingDatasetName

string

maxLength: 255
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$

トレーニングに使用されるデータセット名。