LargeFaceListClient.TrainAsync(WaitUntil, RequestContext) Method

Definition

[Protocol Method] Submit a Large Face List training task.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<Azure.Operation> TrainAsync (Azure.WaitUntil waitUntil, Azure.RequestContext context = default);
abstract member TrainAsync : Azure.WaitUntil * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.TrainAsync : Azure.WaitUntil * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
Public Overridable Function TrainAsync (waitUntil As WaitUntil, Optional context As RequestContext = Nothing) As Task(Of 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

The Operation representing an asynchronous operation on the service.

Exceptions

Service returned a non-success status code.

Examples

This sample shows how to call TrainAsync.

Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient("your_large_face_list_id");

Operation operation = await client.TrainAsync(WaitUntil.Completed);

Applies to