LargeFaceListClient.GetLargeFaceLists Method

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

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

Overloads

GetLargeFaceLists(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken)	List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.
GetLargeFaceLists(String, Nullable<Int32>, Nullable<Boolean>, RequestContext)	[Protocol Method] List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLargeFaceLists(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.

GetLargeFaceLists(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken)

Source:

LargeFaceListClient.cs

List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>> GetLargeFaceLists (string start = default, int? top = default, bool? returnRecognitionModel = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetLargeFaceLists : string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>
override this.GetLargeFaceLists : string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>

Public Overridable Function GetLargeFaceLists (Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional returnRecognitionModel As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of LargeFaceList))

Parameters

start

String

List resources greater than the "start". It contains no more than 64 characters. Default is empty.

top

Nullable<Int32>

The number of items to list, ranging in [1, 1000]. Default is 1000.

returnRecognitionModel

Nullable<Boolean>

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

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<IReadOnlyList<LargeFaceList>>

Examples

This sample shows how to call GetLargeFaceLists.

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

Response<IReadOnlyList<LargeFaceList>> response = client.GetLargeFaceLists();

Remarks

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

GetLargeFaceLists(String, Nullable<Int32>, Nullable<Boolean>, RequestContext)

Source:

LargeFaceListClient.cs

[Protocol Method] List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.

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

public virtual Azure.Response GetLargeFaceLists (string start, int? top, bool? returnRecognitionModel, Azure.RequestContext context);

abstract member GetLargeFaceLists : string * Nullable<int> * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.GetLargeFaceLists : string * Nullable<int> * Nullable<bool> * Azure.RequestContext -> Azure.Response

Public Overridable Function GetLargeFaceLists (start As String, top As Nullable(Of Integer), returnRecognitionModel As Nullable(Of Boolean), context As RequestContext) As Response

Parameters

start

String

List resources greater than the "start". It contains no more than 64 characters. Default is empty.

top

Nullable<Int32>

The number of items to list, ranging in [1, 1000]. Default is 1000.

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

Response

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

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

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

Response response = client.GetLargeFaceLists("my_list_id", 20, true, null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result[0].GetProperty("name").ToString());
Console.WriteLine(result[0].GetProperty("largeFaceListId").ToString());