通过

你当前正在访问 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

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)

只读。 对于多类分类模型。 基本真理类位于前五个预测类的测试样本的比例。
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，泛型Classifier 的最大允许值为 336 小时，GenericDetector 为 1344 小时。 这是训练模型所用的最大计算时间。
trainingDatasetName

string

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

用于训练的数据集名称。