Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetTrainingOperationResult

Retrieves the current status and result of a previously submitted training operation. Poll this operation until the status reaches a terminal state (Completed, Failed, or Skipped).

Request Syntax


GET /v1/training-sessions/trainingSessionName/operations/operationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

operationId

The unique identifier of the operation to retrieve, returned by ExecuteTrainingOperation.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

Required: Yes

trainingSessionName

The name of the training session that owns the operation.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "errorDetails": "string",
   "operationResult": { ... },
   "status": "string",
   "tokenUsage": { 
      "trainingTokens": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

errorDetails

A message describing why the operation failed. The service populates this field only when the status is Failed.

Type: String

operationResult

The result payload of the operation. The service populates this field only when the status is Completed. The populated member of the union corresponds to the operation type that was submitted.

Type: OperationResult object

Note: This object is a Union. Only one member of this object can be specified or returned.

status

The current status of the operation. Possible values are Pending, InProgress, Completed, Failed, or Skipped.

Type: String

Valid Values: Pending | InProgress | Completed | Failed | Skipped

tokenUsage

The token usage statistics for metering purposes. The service populates this field for forward and forwardBackward operations upon completion.

Type: TrainingTokenUsage object

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

An internal service error occurred. Retry the request using exponential backoff.

HTTP Status Code: 500

ResourceNotFoundException

The specified training session or operation does not exist, or the operation does not belong to the specified training session.

HTTP Status Code: 404

ThrottlingException

The request was throttled. Retry the request after a brief wait using exponential backoff.

HTTP Status Code: 429

ValidationException

The request is not valid. Check the request syntax and parameters. Examples include invalid sequence numbers, malformed client tokens, missing required fields, or invalid operation configuration.

HTTP Status Code: 400