LargePersonGroupClient.Train(WaitUntil, RequestContext) Method

Reference

Definition

Namespace:: Azure.AI.Vision.Face

Assembly:: Azure.AI.Vision.Face.dll

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

Source:: LargePersonGroupClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[Protocol Method] Submit a Large Person Group training task. Training is a crucial step that only a trained Large Person Group can be used by "Identify From Large Person Group".

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Operation Train (Azure.WaitUntil waitUntil, Azure.RequestContext context = default);

abstract member Train : Azure.WaitUntil * Azure.RequestContext -> Azure.Operation
override this.Train : Azure.WaitUntil * Azure.RequestContext -> Azure.Operation

Public Overridable Function Train (waitUntil As WaitUntil, Optional context As RequestContext = Nothing) As Operation

Parameters

waitUntil: WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

context: RequestContext

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

Returns

Operation

The Operation representing an asynchronous operation on the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call Train.

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

Operation operation = client.Train(WaitUntil.Completed);

Applies to

Dela via