Text Analysis Authoring - Get Training Status

Service:

Azure AI Services

API Version:

2022-05-01

Gets the status for a training job.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2022-05-01

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
jobId	path	True	string	The job ID.
projectName	path	True	string maxLength: 100	The name of the project to use.
api-version	query	True	string	Client API version.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	A subscription key for a Language service resource.

Responses

Name	Type	Description
200 OK	TextAnalysisAuthoringTrainingJobState	The training job result.
Other Status Codes	ErrorResponse	Error response.

Security

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful Get Train Status

Sample request

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2022-05-01

Sample response

Status code:

200

{
  "result": {
    "modelLabel": "model1",
    "trainingConfigVersion": "2022-05-01",
    "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
    "trainingStatus": {
      "percentComplete": 3,
      "startDateTime": "2022-04-18T15:45:06.8190649Z",
      "status": "running"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "status": "notStarted"
    }
  },
  "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}

Definitions

Name	Description
Error	The error object.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	The job status.
TextAnalysisAuthoringSubTrainingJobState	Represents the detailed state of a training sub-operation.
TextAnalysisAuthoringTrainingJobResult	Represents the output of a training job.
TextAnalysisAuthoringTrainingJobState	Represents the state of a training job.
TextAnalysisAuthoringWarning	Represents a warning that was encountered while executing the request.

Error

Object

The error object.

Name	Type	Description
code	ErrorCode	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCode

Enumeration

Human-readable error code.

Value	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Error response.

Name	Type	Description
error	Error	The error object.

InnerErrorCode

Enumeration

Human-readable error code.

Value	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	One of a server-defined set of error codes.
details	object	Error details.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	Error message.
target	string	Error target.

JobStatus

Enumeration

The job status.

Value	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringSubTrainingJobState

Object

Represents the detailed state of a training sub-operation.

Name	Type	Description
endDateTime	string (date-time)	Represents the end date time.
percentComplete	integer (int32)	Represents progress percentage.
startDateTime	string (date-time)	Represents the start date time.
status	JobStatus	Represents the status of the sub-operation.

TextAnalysisAuthoringTrainingJobResult

Object

Represents the output of a training job.

Name	Type	Description
estimatedEndDateTime	string (date-time)	Represents the estimate end date time for training and evaluation.
evaluationStatus	TextAnalysisAuthoringSubTrainingJobState	Represents model evaluation status.
modelLabel	string	Represents trained model label.
trainingConfigVersion	string	Represents training config version.
trainingStatus	TextAnalysisAuthoringSubTrainingJobState	Represents model train status.

TextAnalysisAuthoringTrainingJobState

Object

Represents the state of a training job.

Name	Type	Description
createdDateTime	string (date-time)	The creation date time of the job.
errors	Error[]	The errors encountered while executing the job.
expirationDateTime	string (date-time)	The expiration date time of the job.
jobId	string	The job ID.
lastUpdatedDateTime	string (date-time)	The last date time the job was updated.
result	TextAnalysisAuthoringTrainingJobResult	Represents training tasks detailed result.
status	JobStatus	The job status.
warnings	TextAnalysisAuthoringWarning[]	The warnings that were encountered while executing the job.

TextAnalysisAuthoringWarning

Object

Represents a warning that was encountered while executing the request.

Name	Type	Description
code	string	The warning code.
message	string	The warning message.