Models - Get

服務:

Azure AI Services

API 版本:

2023-04-01-preview

取得特定模型的相關信息。

傳回的狀態代碼：

• 200：作業已順利完成。
• 400：要求格式不正確。
• 404：找不到具有指定名稱的模型。

GET /models/{name}?api-version=2023-04-01-preview

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	要取得的模型名稱。 Regex 模式: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
api-version	query	True	string	要求的 API 版本。

回應

名稱	類型	Description
200 OK	Model	成功
Other Status Codes	ErrorResponse	[錯誤] 標題 x-ms-error-code: string

範例

Models_Get

範例要求

HTTP

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"
  }
}

定義

名稱	Description
ErrorResponse	發生錯誤時傳回的回應。
ErrorResponseDetails	錯誤資訊。
ErrorResponseInnerError	詳細的錯誤。
Model	描述用於定型自定義模型的定型回合。
ModelEvaluationParameters	用於指定模型評估方式的參數。
ModelKind	模型種類。
ModelPerformance	自定義定型模型的效能計量。
ModelState	唯讀。 定型回合的目前狀態。
ModelTagPerformance	自定義定型模型所辨識之每個標記的效能計量。
TrainingParameters	用於指定定型回合如何定型自定義模型的參數。

ErrorResponse

發生錯誤時傳回的回應。

名稱	類型	Description
error	ErrorResponseDetails	錯誤資訊。

ErrorResponseDetails

錯誤資訊。

名稱	類型	Description
code	string	錯誤碼。
details	ErrorResponseDetails[]	詳細錯誤清單。
innererror	ErrorResponseInnerError	詳細的錯誤。
message	string	錯誤訊息。
target	string	錯誤的目標。

ErrorResponseInnerError

詳細的錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	ErrorResponseInnerError	詳細的錯誤。
message	string	錯誤訊息。

Model

描述用於定型自定義模型的定型回合。

名稱	類型	Description
createdDateTime	string	唯讀。 第一次以UTC建立定型執行的日期和時間。
error	ErrorResponseDetails	錯誤資訊。
evaluationParameters	ModelEvaluationParameters	用於指定模型評估方式的參數。
modelPerformance	ModelPerformance	自定義定型模型的效能計量。
name	string	唯讀。 用來唯一識別定型回合的名稱。
status	ModelState	唯讀。 定型回合的目前狀態。
trainingCostInMinutes	integer	唯讀。 實際耗用的訓練成本，以分鐘為單位。 只有在定型執行完成時，才會存在。
trainingParameters	TrainingParameters	用於指定定型回合如何定型自定義模型的參數。
updatedDateTime	string	唯讀。 上次更新定型執行的日期和時間，以UTC為單位。

ModelEvaluationParameters

用於指定模型評估方式的參數。

名稱	類型	Description
testDatasetName	string	用於測試的數據集名稱。

ModelKind

模型種類。

名稱	類型	Description
Generic-Classifier	string
Generic-Detector	string
Product-Recognizer	string

ModelPerformance

自定義定型模型的效能計量。

名稱	類型	Description
accuracyTop1	number	唯讀。 針對多類別分類模型。 符合預測類別的測試樣本比例。
accuracyTop5	number	唯讀。 針對多類別分類模型。 測試樣本的比例，其中地面真實類別位於前五個預測類別中。
averagePrecision	number	唯讀。 模型效能的量值，它會摘要說明不同信賴閾值的精確度和召回率。
calibrationECE	number	唯讀。 針對多類別分類模型。 預期的校正錯誤。
meanAveragePrecision30	number	唯讀。 針對物件偵測模型。 閾值為 30% 的平均有效位數。
meanAveragePrecision50	number	唯讀。 針對物件偵測模型。 閾值為 50% 的平均有效位數。
meanAveragePrecision75	number	唯讀。 針對物件偵測模型。 閾值為 75% 的平均有效位數。
tagPerformance	<string,  ModelTagPerformance>	唯讀。 模型所辨識之每個標記的效能計量。

ModelState

唯讀。 定型回合的目前狀態。

名稱	類型	Description
cancelled	string
cancelling	string
failed	string
notStarted	string
succeeded	string
training	string

ModelTagPerformance

自定義定型模型所辨識之每個標記的效能計量。

名稱	類型	Description
accuracy	number	唯讀。 針對多類別模型。 標籤精確度。
averagePrecision50	number	唯讀。 針對物件偵測模型。 閾值為 50% 的平均有效位數。

TrainingParameters

用於指定定型回合如何定型自定義模型的參數。

名稱	類型	Description
modelKind	ModelKind	模型種類。
timeBudgetInHours	integer	訓練的時間預算，以小時為單位。 允許的最小值為 1，而 GenericClassifier 的最大允許值為 336 小時，GenericDetector 則為 1344 小時。 這是將花費在定型模型的計算時間上限。
trainingDatasetName	string	用於定型的數據集名稱。