FaceClient Class

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

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

Source:

FaceClient.cs

The Face service client.

public class FaceClient

type FaceClient = class

Public Class FaceClient

Inheritance

Object

FaceClient

Constructors

FaceClient()	Initializes a new instance of FaceClient for mocking.
FaceClient(Uri, AzureKeyCredential, AzureAIVisionFaceClientOptions)	Initializes a new instance of FaceClient.
FaceClient(Uri, AzureKeyCredential)	Initializes a new instance of FaceClient.
FaceClient(Uri, TokenCredential, AzureAIVisionFaceClientOptions)	Initializes a new instance of FaceClient.
FaceClient(Uri, TokenCredential)	Initializes a new instance of FaceClient.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Detect(BinaryData, FaceDetectionModel, FaceRecognitionModel, Boolean, IEnumerable<FaceAttributeType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, CancellationToken)	Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
Detect(Uri, FaceDetectionModel, FaceRecognitionModel, Boolean, IEnumerable<FaceAttributeType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, CancellationToken)	Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
DetectAsync(BinaryData, FaceDetectionModel, FaceRecognitionModel, Boolean, IEnumerable<FaceAttributeType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, CancellationToken)	Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
DetectAsync(Uri, FaceDetectionModel, FaceRecognitionModel, Boolean, IEnumerable<FaceAttributeType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, CancellationToken)	Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
FindSimilar(Guid, IEnumerable<Guid>, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken)	Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect.
FindSimilar(RequestContent, RequestContext)	[Protocol Method] Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler FindSimilar(Guid, IEnumerable<Guid>, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken) convenience overload with strongly typed models first.
FindSimilarAsync(Guid, IEnumerable<Guid>, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken)	Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect.
FindSimilarAsync(RequestContent, RequestContext)	[Protocol Method] Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler FindSimilarAsync(Guid, IEnumerable<Guid>, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken) convenience overload with strongly typed models first.
FindSimilarFromLargeFaceList(Guid, String, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken)	Given query face's faceId, to search the similar-looking faces from a Large Face List. A 'largeFaceListId' is created by Create Large Face List.
FindSimilarFromLargeFaceList(RequestContent, RequestContext)	[Protocol Method] Given query face's faceId, to search the similar-looking faces from a Large Face List. A 'largeFaceListId' is created by Create Large Face List. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler FindSimilarFromLargeFaceList(Guid, String, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken) convenience overload with strongly typed models first.
FindSimilarFromLargeFaceListAsync(Guid, String, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken)	Given query face's faceId, to search the similar-looking faces from a Large Face List. A 'largeFaceListId' is created by Create Large Face List.
FindSimilarFromLargeFaceListAsync(RequestContent, RequestContext)	[Protocol Method] Given query face's faceId, to search the similar-looking faces from a Large Face List. A 'largeFaceListId' is created by Create Large Face List. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler FindSimilarFromLargeFaceListAsync(Guid, String, Nullable<Int32>, Nullable<FindSimilarMatchMode>, CancellationToken) convenience overload with strongly typed models first.
Group(IEnumerable<Guid>, CancellationToken)	Divide candidate faces into groups based on face similarity.
Group(RequestContent, RequestContext)	[Protocol Method] Divide candidate faces into groups based on face similarity. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler Group(IEnumerable<Guid>, CancellationToken) convenience overload with strongly typed models first.
GroupAsync(IEnumerable<Guid>, CancellationToken)	Divide candidate faces into groups based on face similarity.
GroupAsync(RequestContent, RequestContext)	[Protocol Method] Divide candidate faces into groups based on face similarity. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GroupAsync(IEnumerable<Guid>, CancellationToken) convenience overload with strongly typed models first.
IdentifyFromLargePersonGroup(IEnumerable<Guid>, String, Nullable<Int32>, Nullable<Single>, CancellationToken)	1-to-many identification to find the closest matches of the specific query person face from a Large Person Group.
IdentifyFromLargePersonGroup(RequestContent, RequestContext)	[Protocol Method] 1-to-many identification to find the closest matches of the specific query person face from a Large Person Group. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler IdentifyFromLargePersonGroup(IEnumerable<Guid>, String, Nullable<Int32>, Nullable<Single>, CancellationToken) convenience overload with strongly typed models first.
IdentifyFromLargePersonGroupAsync(IEnumerable<Guid>, String, Nullable<Int32>, Nullable<Single>, CancellationToken)	1-to-many identification to find the closest matches of the specific query person face from a Large Person Group.
IdentifyFromLargePersonGroupAsync(RequestContent, RequestContext)	[Protocol Method] 1-to-many identification to find the closest matches of the specific query person face from a Large Person Group. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler IdentifyFromLargePersonGroupAsync(IEnumerable<Guid>, String, Nullable<Int32>, Nullable<Single>, CancellationToken) convenience overload with strongly typed models first.
VerifyFaceToFace(Guid, Guid, CancellationToken)	Verify whether two faces belong to a same person.
VerifyFaceToFace(RequestContent, RequestContext)	[Protocol Method] Verify whether two faces belong to a same person. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler VerifyFaceToFace(Guid, Guid, CancellationToken) convenience overload with strongly typed models first.
VerifyFaceToFaceAsync(Guid, Guid, CancellationToken)	Verify whether two faces belong to a same person.
VerifyFaceToFaceAsync(RequestContent, RequestContext)	[Protocol Method] Verify whether two faces belong to a same person. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler VerifyFaceToFaceAsync(Guid, Guid, CancellationToken) convenience overload with strongly typed models first.
VerifyFromLargePersonGroup(Guid, String, Guid, CancellationToken)	Verify whether a face belongs to a person in a Large Person Group.
VerifyFromLargePersonGroup(RequestContent, RequestContext)	[Protocol Method] Verify whether a face belongs to a person in a Large Person Group. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler VerifyFromLargePersonGroup(Guid, String, Guid, CancellationToken) convenience overload with strongly typed models first.
VerifyFromLargePersonGroupAsync(Guid, String, Guid, CancellationToken)	Verify whether a face belongs to a person in a Large Person Group.
VerifyFromLargePersonGroupAsync(RequestContent, RequestContext)	[Protocol Method] Verify whether a face belongs to a person in a Large Person Group. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler VerifyFromLargePersonGroupAsync(Guid, String, Guid, CancellationToken) convenience overload with strongly typed models first.