你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	要获取的模型的名称。 正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
api-version	query	True	string	请求的 API 版本。

响应

名称	类型	说明
200 OK	Model	Success
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"
  }
}

定义

名称	说明
ErrorResponse	发生错误时返回的响应。
ErrorResponseDetails	错误信息。
ErrorResponseInnerError	详细错误。
Model	描述用于训练自定义模型的训练运行。
ModelEvaluationParameters	用于指定如何计算模型的参数。
ModelKind	模型类型。
ModelPerformance	自定义训练模型的性能指标。
ModelState	只读。 训练运行的当前状态。
ModelTagPerformance	自定义训练模型识别的每个标记的性能指标。
TrainingParameters	用于指定训练运行方式的参数训练自定义模型。

ErrorResponse

发生错误时返回的响应。

名称	类型	说明
error	ErrorResponseDetails	错误信息。

ErrorResponseDetails

错误信息。

名称	类型	说明
code	string	错误代码。
details	ErrorResponseDetails[]	详细错误列表。
innererror	ErrorResponseInnerError	详细错误。
message	string	错误消息。
target	string	错误的目标。

ErrorResponseInnerError

详细错误。

名称	类型	说明
code	string	错误代码。
innererror	ErrorResponseInnerError	详细错误。
message	string	错误消息。

Model

描述用于训练自定义模型的训练运行。

名称	类型	说明
createdDateTime	string	只读。 首次创建训练运行的日期和时间（UTC）。
error	ErrorResponseDetails	错误信息。
evaluationParameters	ModelEvaluationParameters	用于指定如何计算模型的参数。
modelPerformance	ModelPerformance	自定义训练模型的性能指标。
name	string	只读。 用于唯一标识训练运行的名称。
status	ModelState	只读。 训练运行的当前状态。
trainingCostInMinutes	integer	只读。 消耗的实际训练成本（以分钟为单位）。 仅当训练运行完成时才会显示。
trainingParameters	TrainingParameters	用于指定训练运行方式的参数训练自定义模型。
updatedDateTime	string	只读。 上次更新训练运行的日期和时间（UTC）。

ModelEvaluationParameters

用于指定如何计算模型的参数。

名称	类型	说明
testDatasetName	string	用于测试的数据集名称。

ModelKind

模型类型。

名称	类型	说明
Generic-Classifier	string
Generic-Detector	string
Product-Recognizer	string

ModelPerformance

自定义训练模型的性能指标。

名称	类型	说明
accuracyTop1	number	只读。 对于多类分类模型。 基本真实类与预测类匹配的测试样本比例。
accuracyTop5	number	只读。 对于多类分类模型。 基本真实类在前五个预测类中的测试样本比例。
averagePrecision	number	只读。 它是模型性能的度量值，它汇总了不同置信度阈值的精度和召回率。
calibrationECE	number	只读。 对于多类分类模型。 预期的校准错误。
meanAveragePrecision30	number	只读。 对于对象检测模型。 阈值为 30% 的平均平均精度。
meanAveragePrecision50	number	只读。 对于对象检测模型。 阈值为 50% 的平均平均精度。
meanAveragePrecision75	number	只读。 对于对象检测模型。 阈值为 75% 的平均平均精度。
tagPerformance	<string,  ModelTagPerformance>	只读。 模型识别的每个标记的性能指标。

ModelState

只读。 训练运行的当前状态。

名称	类型	说明
cancelled	string
cancelling	string
failed	string
notStarted	string
succeeded	string
training	string

ModelTagPerformance

自定义训练模型识别的每个标记的性能指标。

名称	类型	说明
accuracy	number	只读。 对于多类模型。 标记准确性。
averagePrecision50	number	只读。 对于对象检测模型。 阈值为 50% 时的平均精度。

TrainingParameters

用于指定训练运行方式的参数训练自定义模型。

名称	类型	说明
modelKind	ModelKind	模型类型。
timeBudgetInHours	integer	培训时间预算（以小时为单位）。 允许的最小值为 1，对于 GenericClassifier，允许的最大值为 336 小时，对于 GenericDetector 为 1344 小时。 这是训练模型所花费的最大计算时间。
trainingDatasetName	string	用于训练的数据集名称。