LargeFaceListClient.GetLargeFaceListsAsync Method
Definition
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.
Overloads
| GetLargeFaceListsAsync(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken) |
List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel. |
| GetLargeFaceListsAsync(String, Nullable<Int32>, Nullable<Boolean>, RequestContext) |
[Protocol Method] List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.
|
GetLargeFaceListsAsync(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken)
- Source:
- LargeFaceListClient.cs
List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.
public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>> GetLargeFaceListsAsync (string start = default, int? top = default, bool? returnRecognitionModel = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetLargeFaceListsAsync : string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>>
override this.GetLargeFaceListsAsync : string * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceList>>>Public Overridable Function GetLargeFaceListsAsync (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 Task(Of Response(Of IReadOnlyList(Of LargeFaceList)))Parameters
- start
- String
List resources greater than the "start". It contains no more than 64 characters. Default is empty.
Return 'recognitionModel' or not. The default value is false.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Examples
This sample shows how to call GetLargeFaceListsAsync.
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient(null);
Response<IReadOnlyList<LargeFaceList>> response = await client.GetLargeFaceListsAsync();
Remarks
Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/get-large-face-lists for more details.
Applies to
GetLargeFaceListsAsync(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 GetLargeFaceListsAsync(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> GetLargeFaceListsAsync (string start, int? top, bool? returnRecognitionModel, Azure.RequestContext context);abstract member GetLargeFaceListsAsync : string * Nullable<int> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetLargeFaceListsAsync : string * Nullable<int> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetLargeFaceListsAsync (start As String, top As Nullable(Of Integer), returnRecognitionModel As Nullable(Of Boolean), context As RequestContext) As Task(Of Response)Parameters
- start
- String
List resources greater than the "start". It contains no more than 64 characters. Default is empty.
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
The response returned from the service.
Exceptions
Service returned a non-success status code.
Examples
This sample shows how to call GetLargeFaceListsAsync and parse the result.
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
LargeFaceListClient client = new FaceAdministrationClient(endpoint, credential).GetLargeFaceListClient(null);
Response response = await client.GetLargeFaceListsAsync("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());
