LargePersonGroupClient.GetLargePersonGroupAsync Method

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

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

Overloads

GetLargePersonGroupAsync(Nullable<Boolean>, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLargePersonGroupAsync(Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
GetLargePersonGroupAsync(Nullable<Boolean>, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group for more details.

GetLargePersonGroupAsync(Nullable<Boolean>, RequestContext)

Source:

LargePersonGroupClient.cs

[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group for more details.

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

public virtual System.Threading.Tasks.Task<Azure.Response> GetLargePersonGroupAsync (bool? returnRecognitionModel, Azure.RequestContext context);

abstract member GetLargePersonGroupAsync : Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetLargePersonGroupAsync : Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetLargePersonGroupAsync (returnRecognitionModel As Nullable(Of Boolean), context As RequestContext) As Task(Of Response)

Parameters

returnRecognitionModel

Nullable<Boolean>

Return 'recognitionModel' or not. The default value is false.

context

RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetLargePersonGroupAsync 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 = await client.GetLargePersonGroupAsync(true, null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("largePersonGroupId").ToString());

GetLargePersonGroupAsync(Nullable<Boolean>, CancellationToken)

Source:

LargePersonGroupClient.cs

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

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargePersonGroup>> GetLargePersonGroupAsync (bool? returnRecognitionModel = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetLargePersonGroupAsync : Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargePersonGroup>>
override this.GetLargePersonGroupAsync : Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Vision.Face.LargePersonGroup>>

Public Overridable Function GetLargePersonGroupAsync (Optional returnRecognitionModel As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of LargePersonGroup))

Parameters

returnRecognitionModel

Nullable<Boolean>

Return 'recognitionModel' or not. The default value is false.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<LargePersonGroup>>

Examples

This sample shows how to call GetLargePersonGroupAsync.

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

Response<LargePersonGroup> response = await client.GetLargePersonGroupAsync();