FaceSessionClient Class

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

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

Source:

FaceSessionClient.cs

The FaceSession service client.

public class FaceSessionClient

type FaceSessionClient = class

Public Class FaceSessionClient

Inheritance

Object

FaceSessionClient

Constructors

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

Properties

Pipeline

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

Methods

CreateLivenessSession(CreateLivenessSessionContent, CancellationToken)	Create a new detect liveness session.
CreateLivenessSession(RequestContent, RequestContext)	[Protocol Method] Create a new detect liveness session. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CreateLivenessSession(CreateLivenessSessionContent, CancellationToken) convenience overload with strongly typed models first.
CreateLivenessSessionAsync(CreateLivenessSessionContent, CancellationToken)	Create a new detect liveness session.
CreateLivenessSessionAsync(RequestContent, RequestContext)	[Protocol Method] Create a new detect liveness session. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CreateLivenessSessionAsync(CreateLivenessSessionContent, CancellationToken) convenience overload with strongly typed models first.
CreateLivenessWithVerifySession(CreateLivenessWithVerifySessionContent, Stream, CancellationToken)	Create a new liveness session with verify. Provide the verify image during session creation.
CreateLivenessWithVerifySessionAsync(CreateLivenessWithVerifySessionContent, Stream, CancellationToken)	Create a new liveness session with verify. Provide the verify image during session creation.
DeleteLivenessSession(String, RequestContext)	[Protocol Method] Delete all session related information for matching the specified session id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteLivenessSessionAsync(String, RequestContext)	[Protocol Method] Delete all session related information for matching the specified session id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteLivenessWithVerifySession(String, RequestContext)	[Protocol Method] Delete all session related information for matching the specified session id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteLivenessWithVerifySessionAsync(String, RequestContext)	[Protocol Method] Delete all session related information for matching the specified session id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DetectFromSessionImage(RequestContent, String, String, Nullable<Boolean>, IEnumerable<FaceAttributeType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, RequestContext)	[Protocol Method] Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler DetectFromSessionImage(String, Nullable<FaceDetectionModel>, Nullable<FaceRecognitionModel>, Nullable<Boolean>, IEnumerable<FaceAttributeType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
DetectFromSessionImage(String, Nullable<FaceDetectionModel>, Nullable<FaceRecognitionModel>, Nullable<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.
DetectFromSessionImageAsync(RequestContent, String, String, Nullable<Boolean>, IEnumerable<FaceAttributeType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, RequestContext)	[Protocol Method] Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler DetectFromSessionImageAsync(String, Nullable<FaceDetectionModel>, Nullable<FaceRecognitionModel>, Nullable<Boolean>, IEnumerable<FaceAttributeType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
DetectFromSessionImageAsync(String, Nullable<FaceDetectionModel>, Nullable<FaceRecognitionModel>, Nullable<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.
GetLivenessSessionAuditEntries(String, String, Nullable<Int32>, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-audit-entries for more details.
GetLivenessSessionAuditEntries(String, String, Nullable<Int32>, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-audit-entries for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessSessionAuditEntries(String, String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetLivenessSessionAuditEntriesAsync(String, String, Nullable<Int32>, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-audit-entries for more details.
GetLivenessSessionAuditEntriesAsync(String, String, Nullable<Int32>, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-audit-entries for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessSessionAuditEntriesAsync(String, String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetLivenessSessionResult(String, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-result for more details.
GetLivenessSessionResult(String, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-result for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessSessionResult(String, CancellationToken) convenience overload with strongly typed models first.
GetLivenessSessionResultAsync(String, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-result for more details.
GetLivenessSessionResultAsync(String, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-session-result for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessSessionResultAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetLivenessSessions(String, Nullable<Int32>, CancellationToken)	Lists sessions for /detectLiveness/SingleModal.
GetLivenessSessions(String, Nullable<Int32>, RequestContext)	[Protocol Method] Lists sessions for /detectLiveness/SingleModal. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessSessions(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetLivenessSessionsAsync(String, Nullable<Int32>, CancellationToken)	Lists sessions for /detectLiveness/SingleModal.
GetLivenessSessionsAsync(String, Nullable<Int32>, RequestContext)	[Protocol Method] Lists sessions for /detectLiveness/SingleModal. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessSessionsAsync(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetLivenessWithVerifySessionAuditEntries(String, String, Nullable<Int32>, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-with-verify-session-audit-entries for more details.
GetLivenessWithVerifySessionAuditEntries(String, String, Nullable<Int32>, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-with-verify-session-audit-entries for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessWithVerifySessionAuditEntries(String, String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetLivenessWithVerifySessionAuditEntriesAsync(String, String, Nullable<Int32>, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-with-verify-session-audit-entries for more details.
GetLivenessWithVerifySessionAuditEntriesAsync(String, String, Nullable<Int32>, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-with-verify-session-audit-entries for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessWithVerifySessionAuditEntriesAsync(String, String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetLivenessWithVerifySessionResult(String, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-with-verify-session-result for more details.
GetLivenessWithVerifySessionResult(String, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-with-verify-session-result for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessWithVerifySessionResult(String, CancellationToken) convenience overload with strongly typed models first.
GetLivenessWithVerifySessionResultAsync(String, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-with-verify-session-result for more details.
GetLivenessWithVerifySessionResultAsync(String, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-liveness-with-verify-session-result for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessWithVerifySessionResultAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetLivenessWithVerifySessions(String, Nullable<Int32>, CancellationToken)	Lists sessions for /detectLivenessWithVerify/SingleModal.
GetLivenessWithVerifySessions(String, Nullable<Int32>, RequestContext)	[Protocol Method] Lists sessions for /detectLivenessWithVerify/SingleModal. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessWithVerifySessions(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetLivenessWithVerifySessionsAsync(String, Nullable<Int32>, CancellationToken)	Lists sessions for /detectLivenessWithVerify/SingleModal.
GetLivenessWithVerifySessionsAsync(String, Nullable<Int32>, RequestContext)	[Protocol Method] Lists sessions for /detectLivenessWithVerify/SingleModal. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLivenessWithVerifySessionsAsync(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetSessionImage(String, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-session-image for more details.
GetSessionImage(String, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-session-image for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetSessionImage(String, CancellationToken) convenience overload with strongly typed models first.
GetSessionImageAsync(String, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-session-image for more details.
GetSessionImageAsync(String, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-session-image for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetSessionImageAsync(String, CancellationToken) convenience overload with strongly typed models first.