LargePersonGroupClient Class

Definition

Namespace:

Azure.AI.Vision.Face

Assembly:

Azure.AI.Vision.Face.dll

Package:

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

Source:

LargePersonGroupClient.cs

The LargePersonGroup sub-client.

public class LargePersonGroupClient

type LargePersonGroupClient = class

Public Class LargePersonGroupClient

Inheritance

Object

LargePersonGroupClient

Constructors

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

Properties

Pipeline

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

Methods

AddFace(Guid, BinaryData, IEnumerable<Int32>, Nullable<FaceDetectionModel>, String, CancellationToken)	Add a face to a person into a Large Person Group for face identification or verification.
AddFace(Guid, RequestContent, IEnumerable<Int32>, String, String, RequestContext)	[Protocol Method] Add a face to a person into a Large Person Group for face identification or verification. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the ser AddFace(Guid, BinaryData, IEnumerable<Int32>, Nullable<FaceDetectionModel>, String, CancellationToken) convenience overload with strongly typed models first.
AddFace(Guid, Uri, IEnumerable<Int32>, Nullable<FaceDetectionModel>, String, CancellationToken)	Add a face to a person into a Large Person Group for face identification or verification.
AddFaceAsync(Guid, BinaryData, IEnumerable<Int32>, Nullable<FaceDetectionModel>, String, CancellationToken)	Add a face to a person into a Large Person Group for face identification or verification.
AddFaceAsync(Guid, RequestContent, IEnumerable<Int32>, String, String, RequestContext)	[Protocol Method] Add a face to a person into a Large Person Group for face identification or verification. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the ser AddFaceAsync(Guid, BinaryData, IEnumerable<Int32>, Nullable<FaceDetectionModel>, String, CancellationToken) convenience overload with strongly typed models first.
AddFaceAsync(Guid, Uri, IEnumerable<Int32>, Nullable<FaceDetectionModel>, String, CancellationToken)	Add a face to a person into a Large Person Group for face identification or verification.
Create(RequestContent, RequestContext)	[Protocol Method] Create a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and recognitionModel. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler Create(String, String, Nullable<FaceRecognitionModel>, CancellationToken) convenience overload with strongly typed models first.
Create(String, String, Nullable<FaceRecognitionModel>, CancellationToken)	Create a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.
CreateAsync(RequestContent, RequestContext)	[Protocol Method] Create a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and recognitionModel. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CreateAsync(String, String, Nullable<FaceRecognitionModel>, CancellationToken) convenience overload with strongly typed models first.
CreateAsync(String, String, Nullable<FaceRecognitionModel>, CancellationToken)	Create a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.
CreatePerson(RequestContent, RequestContext)	[Protocol Method] Create a new person in a specified Large Person Group. To add face to this person, please call "Add Large Person Group Person Face". This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CreatePerson(String, String, CancellationToken) convenience overload with strongly typed models first.
CreatePerson(String, String, CancellationToken)	Create a new person in a specified Large Person Group. To add face to this person, please call "Add Large Person Group Person Face".
CreatePersonAsync(RequestContent, RequestContext)	[Protocol Method] Create a new person in a specified Large Person Group. To add face to this person, please call "Add Large Person Group Person Face". This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CreatePersonAsync(String, String, CancellationToken) convenience overload with strongly typed models first.
CreatePersonAsync(String, String, CancellationToken)	Create a new person in a specified Large Person Group. To add face to this person, please call "Add Large Person Group Person Face".
Delete(RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/delete-large-person-group for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteAsync(RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/delete-large-person-group for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteFace(Guid, Guid, RequestContext)	[Protocol Method] Delete a face from a person in a Large Person Group by specified largePersonGroupId, personId and persistedFaceId. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteFaceAsync(Guid, Guid, RequestContext)	[Protocol Method] Delete a face from a person in a Large Person Group by specified largePersonGroupId, personId and persistedFaceId. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeletePerson(Guid, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/delete-large-person-group-person for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeletePersonAsync(Guid, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/delete-large-person-group-person for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetFace(Guid, Guid, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group-person-face for more details.
GetFace(Guid, Guid, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group-person-face for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetFace(Guid, Guid, CancellationToken) convenience overload with strongly typed models first.
GetFaceAsync(Guid, Guid, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group-person-face for more details.
GetFaceAsync(Guid, Guid, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group-person-face for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetFaceAsync(Guid, Guid, CancellationToken) convenience overload with strongly typed models first.
GetLargePersonGroup(Nullable<Boolean>, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group for more details.
GetLargePersonGroup(Nullable<Boolean>, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLargePersonGroup(Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
GetLargePersonGroupAsync(Nullable<Boolean>, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group for more details.
GetLargePersonGroupAsync(Nullable<Boolean>, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetLargePersonGroupAsync(Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
GetLargePersonGroups(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken)	List all existing Large Person Groups' largePersonGroupId, name, userData and recognitionModel.
GetLargePersonGroups(String, Nullable<Int32>, Nullable<Boolean>, RequestContext)	[Protocol Method] List all existing Large Person Groups' largePersonGroupId, 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 GetLargePersonGroups(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
GetLargePersonGroupsAsync(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken)	List all existing Large Person Groups' largePersonGroupId, name, userData and recognitionModel.
GetLargePersonGroupsAsync(String, Nullable<Int32>, Nullable<Boolean>, RequestContext)	[Protocol Method] List all existing Large Person Groups' largePersonGroupId, 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 GetLargePersonGroupsAsync(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
GetPerson(Guid, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group-person for more details.
GetPerson(Guid, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group-person for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetPerson(Guid, CancellationToken) convenience overload with strongly typed models first.
GetPersonAsync(Guid, CancellationToken)	Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group-person for more details.
GetPersonAsync(Guid, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/get-large-person-group-person for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetPersonAsync(Guid, CancellationToken) convenience overload with strongly typed models first.
GetPersons(String, Nullable<Int32>, CancellationToken)	List all persons' information in the specified Large Person Group, including personId, name, userData and persistedFaceIds of registered person faces.
GetPersons(String, Nullable<Int32>, RequestContext)	[Protocol Method] List all persons' information in the specified Large Person Group, including personId, name, userData and persistedFaceIds of registered person faces. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetPersons(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetPersonsAsync(String, Nullable<Int32>, CancellationToken)	List all persons' information in the specified Large Person Group, including personId, name, userData and persistedFaceIds of registered person faces.
GetPersonsAsync(String, Nullable<Int32>, RequestContext)	[Protocol Method] List all persons' information in the specified Large Person Group, including personId, name, userData and persistedFaceIds of registered person faces. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetPersonsAsync(String, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
GetTrainingStatus(CancellationToken)	To check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Person Group" API.
GetTrainingStatus(RequestContext)	[Protocol Method] To check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Person Group" API. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTrainingStatus(CancellationToken) convenience overload with strongly typed models first.
GetTrainingStatusAsync(CancellationToken)	To check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Person Group" API.
GetTrainingStatusAsync(RequestContext)	[Protocol Method] To check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Person Group" API. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTrainingStatusAsync(CancellationToken) convenience overload with strongly typed models first.
Train(WaitUntil, RequestContext)	[Protocol Method] Submit a Large Person Group training task. Training is a crucial step that only a trained Large Person Group can be used by "Identify From Large Person Group". This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
TrainAsync(WaitUntil, RequestContext)	[Protocol Method] Submit a Large Person Group training task. Training is a crucial step that only a trained Large Person Group can be used by "Identify From Large Person Group". This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Update(RequestContent, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/update-large-person-group for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateAsync(RequestContent, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/update-large-person-group for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateFace(Guid, Guid, RequestContent, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/update-large-person-group-person-face for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateFaceAsync(Guid, Guid, RequestContent, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/update-large-person-group-person-face for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdatePerson(Guid, RequestContent, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/update-large-person-group-person for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdatePersonAsync(Guid, RequestContent, RequestContext)	[Protocol Method] Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/update-large-person-group-person for more details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.