Поделиться через

LargeFaceListClient.GetFaces Method

  • Reference

Definition

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

Overloads

GetFaces(String, Nullable<Int32>, RequestContext)

[Protocol Method] List faces' persistedFaceId and userData in a specified Large Face List.
GetFaces(String, Nullable<Int32>, CancellationToken)

List faces' persistedFaceId and userData in a specified Large Face List.

GetFaces(String, Nullable<Int32>, RequestContext)

Source:
LargeFaceListClient.cs

[Protocol Method] List faces' persistedFaceId and userData in a specified Large Face List.

public virtual Azure.Response GetFaces (string start, int? top, Azure.RequestContext context);
abstract member GetFaces : string * Nullable<int> * Azure.RequestContext -> Azure.Response
override this.GetFaces : string * Nullable<int> * Azure.RequestContext -> Azure.Response
Public Overridable Function GetFaces (start As String, top As Nullable(Of Integer), 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.

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 GetFaces and parse the result.

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

Response response = client.GetFaces("00000000-0000-0000-0000-000000000000", 20, null);

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

Applies to

GetFaces(String, Nullable<Int32>, CancellationToken)

Source:
LargeFaceListClient.cs

List faces' persistedFaceId and userData in a specified Large Face List.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>> GetFaces (string start = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetFaces : string * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>>
override this.GetFaces : string * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Vision.Face.LargeFaceListFace>>
Public Overridable Function GetFaces (Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of LargeFaceListFace))

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.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response<IReadOnlyList<LargeFaceListFace>>

Examples

This sample shows how to call GetFaces.

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

Response<IReadOnlyList<LargeFaceListFace>> response = client.GetFaces();

Remarks

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

Applies to