Language - Custom Text Authoring APIs (2022-03-01-preview)

Training_GetTrainingJobStatus

Get training job status and result details.

Select the testing console in the region where you created your resource:

Open API testing console

Request URL

Request parameters

string

The project name.

string

The job ID.

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

The training job result.

{
  "result": {
    "modelLabel": "string",
    "trainingConfigVersion": "string",
    "trainingStatus": {
      "percentComplete": 0,
      "startDateTime": "string",
      "endDateTime": "string",
      "status": "unknown"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "startDateTime": "string",
      "endDateTime": "string",
      "status": "unknown"
    },
    "estimatedEndDateTime": "string"
  },
  "jobId": "string",
  "createdDateTime": "string",
  "lastUpdatedDateTime": "string",
  "expirationDateTime": "string",
  "status": "unknown",
  "warnings": [
    {
      "code": "InvalidRequest",
      "message": "string"
    }
  ],
  "errors": [
    {
      "code": "InvalidRequest",
      "message": "string"
    }
  ]
}
{
  "required": [
    "result",
    "jobId",
    "createdDateTime",
    "lastUpdatedDateTime",
    "expirationDateTime",
    "status"
  ],
  "type": "object",
  "properties": {
    "result": {
      "description": "Represents training tasks detailed result.",
      "required": [
        "modelLabel",
        "trainingConfigVersion",
        "trainingStatus"
      ],
      "type": "object",
      "properties": {
        "modelLabel": {
          "description": "Represents trained model label.",
          "type": "string"
        },
        "trainingConfigVersion": {
          "description": "Represents training config version.",
          "type": "string"
        },
        "trainingStatus": {
          "description": "Represents model train status.",
          "required": [
            "percentComplete",
            "status"
          ],
          "type": "object",
          "properties": {
            "percentComplete": {
              "format": "int32",
              "description": "Represents progress percentage.",
              "type": "integer"
            },
            "startDateTime": {
              "format": "date-time",
              "description": "Represents the start date time.",
              "type": "string"
            },
            "endDateTime": {
              "format": "date-time",
              "description": "Represents the end date time.",
              "type": "string"
            },
            "status": {
              "description": "Represents the status of the job.",
              "enum": [
                "unknown",
                "notStarted",
                "running",
                "succeeded",
                "failed",
                "cancelled",
                "cancelling",
                "partiallyCompleted"
              ],
              "type": "string",
              "x-ms-enum": {
                "name": "JobStatus",
                "modelAsString": true
              }
            }
          }
        },
        "evaluationStatus": {
          "description": "Represents model evaluation status.",
          "required": [
            "percentComplete",
            "status"
          ],
          "type": "object",
          "properties": {
            "percentComplete": {
              "format": "int32",
              "description": "Represents progress percentage.",
              "type": "integer"
            },
            "startDateTime": {
              "format": "date-time",
              "description": "Represents the start date time.",
              "type": "string"
            },
            "endDateTime": {
              "format": "date-time",
              "description": "Represents the end date time.",
              "type": "string"
            },
            "status": {
              "description": "Represents the status of the job.",
              "enum": [
                "unknown",
                "notStarted",
                "running",
                "succeeded",
                "failed",
                "cancelled",
                "cancelling",
                "partiallyCompleted"
              ],
              "type": "string",
              "x-ms-enum": {
                "name": "JobStatus",
                "modelAsString": true
              }
            }
          }
        },
        "estimatedEndDateTime": {
          "format": "date-time",
          "description": "Represents the estimate end date time for training and evaluation.",
          "type": "string"
        }
      }
    },
    "jobId": {
      "description": "Gets or sets the job id.",
      "type": "string"
    },
    "createdDateTime": {
      "format": "date-time",
      "description": "Gets or sets the created time.",
      "type": "string"
    },
    "lastUpdatedDateTime": {
      "format": "date-time",
      "description": "Gets or sets the last updated time.",
      "type": "string"
    },
    "expirationDateTime": {
      "format": "date-time",
      "description": "Gets or sets the expiration time.",
      "type": "string"
    },
    "status": {
      "description": "Gets or sets the job status.",
      "enum": [
        "unknown",
        "notStarted",
        "running",
        "succeeded",
        "failed",
        "cancelled",
        "cancelling",
        "partiallyCompleted"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "JobStatus",
        "modelAsString": true
      }
    },
    "warnings": {
      "description": "Gets or sets the warnings.",
      "type": "array",
      "items": {
        "description": "Represents the definition of the error that occurred.",
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "description": "The error code.",
            "enum": [
              "InvalidRequest",
              "InvalidArgument",
              "Forbidden",
              "NotFound",
              "Unauthorized",
              "Timeout",
              "QuotaExceeded",
              "Conflict",
              "Warning",
              "InternalServerError"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "ErrorCode",
              "modelAsString": true
            }
          },
          "message": {
            "description": "The error message.",
            "type": "string"
          }
        }
      }
    },
    "errors": {
      "description": "Gets or sets the errors.",
      "type": "array",
      "items": {
        "description": "Represents the definition of the error that occurred.",
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "description": "The error code.",
            "enum": [
              "InvalidRequest",
              "InvalidArgument",
              "Forbidden",
              "NotFound",
              "Unauthorized",
              "Timeout",
              "QuotaExceeded",
              "Conflict",
              "Warning",
              "InternalServerError"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "ErrorCode",
              "modelAsString": true
            }
          },
          "message": {
            "description": "The error message.",
            "type": "string"
          }
        }
      }
    }
  }
}

Response 400

This error can be returned if the request's parameters are incorrect meaning the required parameters are missing, malformed, or too large.\r\n\r\nThis error can be returned if the request's body is incorrect meaning the JSON is missing, malformed, or too large.

Response 401

You do not have access. \r\n\r\nReasons can include:\r\n\r\n* used endpoint subscription key, instead of authoring key\r\n* invalid, malformed, or empty authoring key\r\n* authoring key doesn't match region\r\n* you are not the owner or collaborator\r\n* invalid order of API calls.

Response 403

Total monthly key quota limit exceeded.

Response 404

The project or the job does not exist.

Response 429

Rate limit is exceeded.

Code samples

@ECHO OFF

curl -v -X GET "https://*.cognitiveservices.azure.com/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2022-03-01-preview"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://*.cognitiveservices.azure.com/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2022-03-01-preview&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://*.cognitiveservices.azure.com/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2022-03-01-preview");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://*.cognitiveservices.azure.com/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2022-03-01-preview&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://*.cognitiveservices.azure.com/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2022-03-01-preview";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://*.cognitiveservices.azure.com/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2022-03-01-preview');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("GET", "/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2022-03-01-preview&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("GET", "/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2022-03-01-preview&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://*.cognitiveservices.azure.com/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2022-03-01-preview')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body