LargePersonGroupClient.GetTrainingStatus Method

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

Azure.AI.Vision.Face v1.0.0-beta.2

Overloads

GetTrainingStatus(RequestContext)

[Protocol Method] To check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Person Group" API. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTrainingStatus(CancellationToken) convenience overload with strongly typed models first.

GetTrainingStatus(CancellationToken)

To check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Person Group" API.

GetTrainingStatus(RequestContext)

Source:

LargePersonGroupClient.cs

[Protocol Method] To check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Person Group" API.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetTrainingStatus(CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetTrainingStatus (Azure.RequestContext context);

abstract member GetTrainingStatus : Azure.RequestContext -> Azure.Response
override this.GetTrainingStatus : Azure.RequestContext -> Azure.Response

Public Overridable Function GetTrainingStatus (context As RequestContext) As Response

Parameters

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetTrainingStatus and parse the result.

Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
LargePersonGroupClient client = new FaceAdministrationClient(endpoint, credential).GetLargePersonGroupClient("your_large_person_group_id");

Response response = client.GetTrainingStatus(null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("lastActionDateTime").ToString());
Console.WriteLine(result.GetProperty("lastSuccessfulTrainingDateTime").ToString());

GetTrainingStatus(CancellationToken)

Source:

LargePersonGroupClient.cs

To check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Person Group" API.

public virtual Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult> GetTrainingStatus (System.Threading.CancellationToken cancellationToken = default);

abstract member GetTrainingStatus : System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult>
override this.GetTrainingStatus : System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.FaceTrainingResult>

Public Overridable Function GetTrainingStatus (Optional cancellationToken As CancellationToken = Nothing) As Response(Of FaceTrainingResult)

Parameters

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<FaceTrainingResult>

Examples

This sample shows how to call GetTrainingStatus.

Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
LargePersonGroupClient client = new FaceAdministrationClient(endpoint, credential).GetLargePersonGroupClient("your_large_person_group_id");

Response<FaceTrainingResult> response = client.GetTrainingStatus();

Remarks

Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group-training-status for more details.