Share via

Custom Models - Get Summary

Service:
Azure AI Services
API Version:
2.1

Get information about all custom models

GET {endpoint}/formrecognizer/v2.1/custom/models?op=summary

URI Parameters

Name In Required Type Description
endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).
op
 query True

string

Specify whether to return summary or full list of models.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Responses

Name Type Description
200 OK

Models

Success
Other Status Codes

ErrorResponse

Response entity accompanying non-successful responses containing additional details about the error.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Get models summary

Sample request

GET {endpoint}/formrecognizer/v2.1/custom/models?op=summary

Sample response

Status code:
200 
{
  "summary": {
    "count": 5,
    "limit": 5000,
    "lastUpdatedDateTime": "2019-05-01T10:53:21Z"
  }
}

Definitions

Name Description
Attributes

Optional model attributes.
ErrorInformation
ErrorResponse
ModelInfo

Basic custom model information.
Models

Response to the list custom models operation.
ModelStatus

Status of the model.
Summary

Summary of all trained custom models.

Attributes

Object

Optional model attributes.

Name Type Default value Description
isComposed

boolean

False

Is this model composed? (default: false).

ErrorInformation

Object
Name Type Description
code

string

message

string

ErrorResponse

Object
Name Type Description
error

ErrorInformation

ModelInfo

Object

Basic custom model information.

Name Type Description
attributes

Attributes

Optional model attributes.
createdDateTime

string (date-time)

Date and time (UTC) when the model was created.
lastUpdatedDateTime

string (date-time)

Date and time (UTC) when the status was last updated.
modelId

string (uuid)

Model identifier.
modelName

string

Optional user defined model name (max length: 1024).
status

ModelStatus

Status of the model.

Models

Object

Response to the list custom models operation.

Name Type Description
modelList

ModelInfo[]

Collection of trained custom models.
nextLink

string

Link to the next page of custom models.
summary

Summary

Summary of all trained custom models.

ModelStatus

Enumeration

Status of the model.

Value Description
creating
ready
invalid

Summary

Object

Summary of all trained custom models.

Name Type Description
count

integer

Current count of trained custom models.
lastUpdatedDateTime

string (date-time)

Date and time (UTC) when the summary was last updated.
limit

integer

Max number of models that can be trained for this account.