Share via

Models - Get

Service:
Azure AI Services
API Version:
2023-02-01-preview

Get information about a specific model.

Status codes returned:

  • 200: Operation completed successfully.
  • 400: The request was malformed.
  • 404: A model with the specified name was not found.
GET /models/{name}?api-version=2023-02-01-preview

URI Parameters

Name In Required Type Description
name
 path True

string

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

The name of the model to get.
api-version
 query True

string

Requested API version.

Responses

Name Type Description
200 OK

Model

Success
Other Status Codes

ErrorResponse

Error

Headers

x-ms-error-code: string

Examples

Models_Get

Sample request

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

Sample response

Status code:
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"
  }
}

Definitions

Name Description
ErrorResponse

Response returned when an error occurs.
ErrorResponseDetails

Error info.
ErrorResponseInnerError

Detailed error.
Model

Describes a training run for training a custom model.
ModelEvaluationParameters

Parameters for specifying how a model is evaluated.
ModelKindApiModel

Model kind.
ModelPerformance

Performance metrics for a custom trained model.
ModelStateApiModel

Read only. The current state of the training run.
ModelTagPerformance

Performance metrics for each tag recognized by a custom trained model.
TrainingParameters

Parameters for specifying how a training run trains a custom model.

ErrorResponse

Object

Response returned when an error occurs.

Name Type Description
error

ErrorResponseDetails

Error info.

ErrorResponseDetails

Object

Error info.

Name Type Description
code

string

Error code.
details

ErrorResponseDetails[]

List of detailed errors.
innererror

ErrorResponseInnerError

Detailed error.
message

string

Error message.
target

string

Target of the error.

ErrorResponseInnerError

Object

Detailed error.

Name Type Description
code

string

Error code.
innererror

ErrorResponseInnerError

Detailed error.
message

string

Error message.

Model

Object

Describes a training run for training a custom model.

Name Type Description
createdDateTime

string (date-time)

Read only. The date and time when the training run was first created, in UTC.
error

ErrorResponseDetails

Error info.
evaluationParameters

ModelEvaluationParameters

Parameters for specifying how a model is evaluated.
modelPerformance

ModelPerformance

Performance metrics for a custom trained model.
name

string

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

Read only. The name that is used to uniquely identify the training run.
status

ModelStateApiModel

Read only. The current state of the training run.
trainingCostInMinutes

integer (int32)

Read only. Actual training cost consumed, in minutes. Present only if the training run as completed.
trainingParameters

TrainingParameters

Parameters for specifying how a training run trains a custom model.
updatedDateTime

string (date-time)

Read only. The date and time when the training run was last updated, in UTC.

ModelEvaluationParameters

Object

Parameters for specifying how a model is evaluated.

Name Type Description
testDatasetName

string

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

The dataset name used for testing.

ModelKindApiModel

Enumeration

Model kind.

Value Description
Generic-Classifier
Generic-Detector

ModelPerformance

Object

Performance metrics for a custom trained model.

Name Type Description
accuracyTop1

number (double)

Read only. For multiclass classification models. The proportion of test samples where the ground truth class matches the predicted class.
accuracyTop5

number (double)

Read only. For multiclass classification models. The proportion of test samples where the ground truth class is in the top five predicted classes.
averagePrecision

number (double)

Read only. A measure of the model performance, it summarizes the precision and recall at different confidence thresholds.
calibrationECE

number (double)

Read only. For multiclass classification models. Expected calibration error.
meanAveragePrecision30

number (double)

Read only. For object detection models. Mean average precision at a threshold of 30%.
meanAveragePrecision50

number (double)

Read only. For object detection models. Mean average precision at a threshold of 50%.
meanAveragePrecision75

number (double)

Read only. For object detection models. Mean average precision at a threshold of 75%.
tagPerformance

<string,  ModelTagPerformance>

Read only. Performance metrics for each tag recognized by the model.

ModelStateApiModel

Enumeration

Read only. The current state of the training run.

Value Description
notStarted
training
succeeded
failed
cancelling
cancelled

ModelTagPerformance

Object

Performance metrics for each tag recognized by a custom trained model.

Name Type Description
accuracy

number (double)

Read only. For multiclass models. Tag accuracy.
averagePrecision50

number (double)

Read only. For object detection models. Average precision at a threshold of 50%.

TrainingParameters

Object

Parameters for specifying how a training run trains a custom model.

Name Type Description
modelKind

ModelKindApiModel

Model kind.
timeBudgetInHours

integer (int32)

minimum: 1
maximum: 288

Time budget for training, in hours. The minimum allowed value is 1, and the maximum allowed value is 288 hours. This is the maximum amount of compute time that will be spent to train the model.
trainingDatasetName

string

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

The dataset name used for training.