@azure-rest/ai-vision-face package

Interfaces

AccessoryItemOutput	Accessory item and corresponding confidence level.
AddFaceFromUrlRequest	Add face from url request.
AddFaceListFace200Response	A successful call returns a new persistedFaceId.
AddFaceListFaceBodyParam
AddFaceListFaceDefaultHeaders
AddFaceListFaceDefaultResponse
AddFaceListFaceFromUrl
AddFaceListFaceFromUrl200Response	A successful call returns a new persistedFaceId.
AddFaceListFaceFromUrlBodyParam
AddFaceListFaceFromUrlDefaultHeaders
AddFaceListFaceFromUrlDefaultResponse
AddFaceListFaceFromUrlQueryParam
AddFaceListFaceFromUrlQueryParamProperties
AddFaceListFaceFromUrlTargetFaceQueryParam	This is the wrapper object for the parameter targetFace with explode set to false and style set to form.
AddFaceListFaceMediaTypesParam
AddFaceListFaceQueryParam
AddFaceListFaceQueryParamProperties
AddFaceListFaceTargetFaceQueryParam	This is the wrapper object for the parameter targetFace with explode set to false and style set to form.
AddFaceResultOutput	Response body for adding face.
AddLargeFaceListFace200Response	A successful call returns a new persistedFaceId.
AddLargeFaceListFaceBodyParam
AddLargeFaceListFaceDefaultHeaders
AddLargeFaceListFaceDefaultResponse
AddLargeFaceListFaceFromUrl
AddLargeFaceListFaceFromUrl200Response	A successful call returns a new persistedFaceId.
AddLargeFaceListFaceFromUrlBodyParam
AddLargeFaceListFaceFromUrlDefaultHeaders
AddLargeFaceListFaceFromUrlDefaultResponse
AddLargeFaceListFaceFromUrlQueryParam
AddLargeFaceListFaceFromUrlQueryParamProperties
AddLargeFaceListFaceFromUrlTargetFaceQueryParam	This is the wrapper object for the parameter targetFace with explode set to false and style set to form.
AddLargeFaceListFaceMediaTypesParam
AddLargeFaceListFaceQueryParam
AddLargeFaceListFaceQueryParamProperties
AddLargeFaceListFaceTargetFaceQueryParam	This is the wrapper object for the parameter targetFace with explode set to false and style set to form.
AddLargePersonGroupPersonFace200Response	A successful call returns a new persistedFaceId.
AddLargePersonGroupPersonFaceBodyParam
AddLargePersonGroupPersonFaceDefaultHeaders
AddLargePersonGroupPersonFaceDefaultResponse
AddLargePersonGroupPersonFaceFromUrl
AddLargePersonGroupPersonFaceFromUrl200Response	A successful call returns a new persistedFaceId.
AddLargePersonGroupPersonFaceFromUrlBodyParam
AddLargePersonGroupPersonFaceFromUrlDefaultHeaders
AddLargePersonGroupPersonFaceFromUrlDefaultResponse
AddLargePersonGroupPersonFaceFromUrlQueryParam
AddLargePersonGroupPersonFaceFromUrlQueryParamProperties
AddLargePersonGroupPersonFaceFromUrlTargetFaceQueryParam	This is the wrapper object for the parameter targetFace with explode set to false and style set to form.
AddLargePersonGroupPersonFaceMediaTypesParam
AddLargePersonGroupPersonFaceQueryParam
AddLargePersonGroupPersonFaceQueryParamProperties
AddLargePersonGroupPersonFaceTargetFaceQueryParam	This is the wrapper object for the parameter targetFace with explode set to false and style set to form.
AddPersonGroupPersonFace200Response	A successful call returns a new persistedFaceId.
AddPersonGroupPersonFaceBodyParam
AddPersonGroupPersonFaceDefaultHeaders
AddPersonGroupPersonFaceDefaultResponse
AddPersonGroupPersonFaceFromUrl
AddPersonGroupPersonFaceFromUrl200Response	A successful call returns a new persistedFaceId.
AddPersonGroupPersonFaceFromUrlBodyParam
AddPersonGroupPersonFaceFromUrlDefaultHeaders
AddPersonGroupPersonFaceFromUrlDefaultResponse
AddPersonGroupPersonFaceFromUrlQueryParam
AddPersonGroupPersonFaceFromUrlQueryParamProperties
AddPersonGroupPersonFaceFromUrlTargetFaceQueryParam	This is the wrapper object for the parameter targetFace with explode set to false and style set to form.
AddPersonGroupPersonFaceMediaTypesParam
AddPersonGroupPersonFaceQueryParam
AddPersonGroupPersonFaceQueryParamProperties
AddPersonGroupPersonFaceTargetFaceQueryParam	This is the wrapper object for the parameter targetFace with explode set to false and style set to form.
BlurPropertiesOutput	Properties describing any presence of blur within the image.
CreateCollectionRequest	Model for creating face collection.
CreateFaceList
CreateFaceList200Response	The request has succeeded.
CreateFaceListBodyParam
CreateFaceListDefaultHeaders
CreateFaceListDefaultResponse
CreateLargeFaceList
CreateLargeFaceList200Response	The request has succeeded.
CreateLargeFaceListBodyParam
CreateLargeFaceListDefaultHeaders
CreateLargeFaceListDefaultResponse
CreateLargePersonGroup
CreateLargePersonGroup200Response	The request has succeeded.
CreateLargePersonGroupBodyParam
CreateLargePersonGroupDefaultHeaders
CreateLargePersonGroupDefaultResponse
CreateLargePersonGroupPerson
CreateLargePersonGroupPerson200Response	A successful call returns a new personId created.
CreateLargePersonGroupPersonBodyParam
CreateLargePersonGroupPersonDefaultHeaders
CreateLargePersonGroupPersonDefaultResponse
CreateLivenessSession
CreateLivenessSession200Response	A successful call create a session for a client device and provide an authorization token for use by the client application for a limited purpose and time.
CreateLivenessSessionBodyParam
CreateLivenessSessionContent	Request model for creating liveness session.
CreateLivenessSessionDefaultHeaders
CreateLivenessSessionDefaultResponse
CreateLivenessWithVerifySession
CreateLivenessWithVerifySession200Response	A successful call create a session for a client device and provide an authorization token for use by the client application for a limited purpose and time.
CreateLivenessWithVerifySessionBodyParam
CreateLivenessWithVerifySessionContentAuthTokenTimeToLiveInSecondsPartDescriptor
CreateLivenessWithVerifySessionContentDeviceCorrelationIdPartDescriptor
CreateLivenessWithVerifySessionContentDeviceCorrelationIdSetInClientPartDescriptor
CreateLivenessWithVerifySessionContentEnableSessionImagePartDescriptor
CreateLivenessWithVerifySessionContentLivenessModelVersionPartDescriptor
CreateLivenessWithVerifySessionContentLivenessOperationModePartDescriptor
CreateLivenessWithVerifySessionContentReturnVerifyImageHashPartDescriptor
CreateLivenessWithVerifySessionContentVerifyConfidenceThresholdPartDescriptor
CreateLivenessWithVerifySessionContentVerifyImagePartDescriptor
CreateLivenessWithVerifySessionDefaultHeaders
CreateLivenessWithVerifySessionDefaultResponse
CreateLivenessWithVerifySessionMediaTypesParam
CreatePersonGroup
CreatePersonGroup200Response	The request has succeeded.
CreatePersonGroupBodyParam
CreatePersonGroupDefaultHeaders
CreatePersonGroupDefaultResponse
CreatePersonGroupPerson
CreatePersonGroupPerson200Response	A successful call returns a new personId created.
CreatePersonGroupPersonBodyParam
CreatePersonGroupPersonDefaultHeaders
CreatePersonGroupPersonDefaultResponse
CreatePersonResultOutput	Response of create person.
DeleteFaceList200Response	The request has succeeded.
DeleteFaceListDefaultHeaders
DeleteFaceListDefaultResponse
DeleteFaceListFace
DeleteFaceListFace200Response	The request has succeeded.
DeleteFaceListFaceDefaultHeaders
DeleteFaceListFaceDefaultResponse
DeleteLargeFaceList200Response	The request has succeeded.
DeleteLargeFaceListDefaultHeaders
DeleteLargeFaceListDefaultResponse
DeleteLargeFaceListFace
DeleteLargeFaceListFace200Response	The request has succeeded.
DeleteLargeFaceListFaceDefaultHeaders
DeleteLargeFaceListFaceDefaultResponse
DeleteLargePersonGroup200Response	The request has succeeded.
DeleteLargePersonGroupDefaultHeaders
DeleteLargePersonGroupDefaultResponse
DeleteLargePersonGroupPerson
DeleteLargePersonGroupPerson200Response	The request has succeeded.
DeleteLargePersonGroupPersonDefaultHeaders
DeleteLargePersonGroupPersonDefaultResponse
DeleteLargePersonGroupPersonFace
DeleteLargePersonGroupPersonFace200Response	The request has succeeded.
DeleteLargePersonGroupPersonFaceDefaultHeaders
DeleteLargePersonGroupPersonFaceDefaultResponse
DeleteLivenessSession
DeleteLivenessSession204Response	Successfully deleted session and all correlated data.
DeleteLivenessSessionDefaultHeaders
DeleteLivenessSessionDefaultResponse
DeleteLivenessWithVerifySession
DeleteLivenessWithVerifySession204Response	Successfully deleted session and all correlated data.
DeleteLivenessWithVerifySessionDefaultHeaders
DeleteLivenessWithVerifySessionDefaultResponse
DeletePersonGroup200Response	The request has succeeded.
DeletePersonGroupDefaultHeaders
DeletePersonGroupDefaultResponse
DeletePersonGroupPerson
DeletePersonGroupPerson200Response	The request has succeeded.
DeletePersonGroupPersonDefaultHeaders
DeletePersonGroupPersonDefaultResponse
DeletePersonGroupPersonFace
DeletePersonGroupPersonFace200Response	The request has succeeded.
DeletePersonGroupPersonFaceDefaultHeaders
DeletePersonGroupPersonFaceDefaultResponse
Detect200Response	A successful call returns an array of face entries ranked by face rectangle size in descending order. An empty response indicates no faces detected.
DetectBodyParam
DetectDefaultHeaders
DetectDefaultResponse
DetectFromSessionImageId200Response	A successful call returns an array of face entries ranked by face rectangle size in descending order. An empty response indicates no faces detected.
DetectFromSessionImageIdBodyParam
DetectFromSessionImageIdDefaultHeaders
DetectFromSessionImageIdDefaultResponse
DetectFromSessionImageIdMediaTypesParam
DetectFromSessionImageIdQueryParam
DetectFromSessionImageIdQueryParamProperties
DetectFromSessionImageIdReturnFaceAttributesQueryParam	This is the wrapper object for the parameter returnFaceAttributes with explode set to false and style set to form.
DetectFromUrl
DetectFromUrl200Response	A successful call returns an array of face entries ranked by face rectangle size in descending order. An empty response indicates no faces detected.
DetectFromUrlBodyParam
DetectFromUrlDefaultHeaders
DetectFromUrlDefaultResponse
DetectFromUrlMediaTypesParam
DetectFromUrlQueryParam
DetectFromUrlQueryParamProperties
DetectFromUrlReturnFaceAttributesQueryParam	This is the wrapper object for the parameter returnFaceAttributes with explode set to false and style set to form.
DetectMediaTypesParam
DetectQueryParam
DetectQueryParamProperties
DetectReturnFaceAttributesQueryParam	This is the wrapper object for the parameter returnFaceAttributes with explode set to false and style set to form.
ExposurePropertiesOutput	Properties describing exposure level of the image.
FaceAttributesOutput	Face attributes for the detected face.
FaceClientOptions	The optional parameters for the client
FaceDetectionResultOutput	Response for detect API.
FaceErrorOutput	The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponseOutput	A response containing error details.
FaceLandmarksOutput	A collection of 27-point face landmarks pointing to the important positions of face components.
FaceListFaceOutput	Face resource for face list.
FaceListItemOutput	Face list item for list face list.
FaceListOutput	Face list is a list of faces, up to 1,000 faces.
FaceRectangleOutput	A rectangle within which a face can be found.
FaceUserData	User defined data for persisted face.
FacialHairOutput	Properties describing facial hair attributes.
FindSimilar
FindSimilar200Response	A successful call returns an array of the most similar faces represented in faceId if the input parameter is faceIds or persistedFaceId if the input parameter is faceListId or largeFaceListId.
FindSimilarBodyParam
FindSimilarDefaultHeaders
FindSimilarDefaultResponse
FindSimilarFromFaceList200Response	A successful call returns an array of the most similar faces represented in faceId if the input parameter is faceIds or persistedFaceId if the input parameter is faceListId or largeFaceListId.
FindSimilarFromFaceListBodyParam
FindSimilarFromFaceListDefaultHeaders
FindSimilarFromFaceListDefaultResponse
FindSimilarFromLargeFaceList200Response	A successful call returns an array of the most similar faces represented in faceId if the input parameter is faceIds or persistedFaceId if the input parameter is faceListId or largeFaceListId.
FindSimilarFromLargeFaceListBodyParam
FindSimilarFromLargeFaceListDefaultHeaders
FindSimilarFromLargeFaceListDefaultResponse
FindSimilarResultOutput	Response body for find similar face operation.
GetFaceList200Response	A successful call returns the Face List's information.
GetFaceListDefaultHeaders
GetFaceListDefaultResponse
GetFaceListQueryParam
GetFaceListQueryParamProperties
GetFaceLists
GetFaceLists200Response	A successful call returns an array of Face Lists.
GetFaceListsDefaultHeaders
GetFaceListsDefaultResponse
GetFaceListsQueryParam
GetFaceListsQueryParamProperties
GetLargeFaceList200Response	A successful call returns the Large Face List's information.
GetLargeFaceListDefaultHeaders
GetLargeFaceListDefaultResponse
GetLargeFaceListFace200Response	A successful call returns target persisted face's information (persistedFaceId and userData).
GetLargeFaceListFaceDefaultHeaders
GetLargeFaceListFaceDefaultResponse
GetLargeFaceListFaces200Response	A successful call returns an array of persisted faces and their information (persistedFaceId and userData).
GetLargeFaceListFacesDefaultHeaders
GetLargeFaceListFacesDefaultResponse
GetLargeFaceListFacesQueryParam
GetLargeFaceListFacesQueryParamProperties
GetLargeFaceListQueryParam
GetLargeFaceListQueryParamProperties
GetLargeFaceListTrainingStatus
GetLargeFaceListTrainingStatus200Response	A successful call returns the Large Face List's training status.
GetLargeFaceListTrainingStatusDefaultHeaders
GetLargeFaceListTrainingStatusDefaultResponse
GetLargeFaceLists
GetLargeFaceLists200Response	A successful call returns an array of Large Face Lists and their information (largeFaceListId, name and userData).
GetLargeFaceListsDefaultHeaders
GetLargeFaceListsDefaultResponse
GetLargeFaceListsQueryParam
GetLargeFaceListsQueryParamProperties
GetLargePersonGroup200Response	A successful call returns the Large Person Group's information.
GetLargePersonGroupDefaultHeaders
GetLargePersonGroupDefaultResponse
GetLargePersonGroupPerson200Response	A successful call returns the person's information.
GetLargePersonGroupPersonDefaultHeaders
GetLargePersonGroupPersonDefaultResponse
GetLargePersonGroupPersonFace200Response	A successful call returns target persisted face's information (persistedFaceId and userData).
GetLargePersonGroupPersonFaceDefaultHeaders
GetLargePersonGroupPersonFaceDefaultResponse
GetLargePersonGroupPersons200Response	A successful call returns an array of person information that belong to the Large Person Group.
GetLargePersonGroupPersonsDefaultHeaders
GetLargePersonGroupPersonsDefaultResponse
GetLargePersonGroupPersonsQueryParam
GetLargePersonGroupPersonsQueryParamProperties
GetLargePersonGroupQueryParam
GetLargePersonGroupQueryParamProperties
GetLargePersonGroupTrainingStatus
GetLargePersonGroupTrainingStatus200Response	A successful call returns the Large Person Group's training status.
GetLargePersonGroupTrainingStatusDefaultHeaders
GetLargePersonGroupTrainingStatusDefaultResponse
GetLargePersonGroups
GetLargePersonGroups200Response	A successful call returns an array of Large Person Groups and their information (largePersonGroupId, name and userData).
GetLargePersonGroupsDefaultHeaders
GetLargePersonGroupsDefaultResponse
GetLargePersonGroupsQueryParam
GetLargePersonGroupsQueryParamProperties
GetLivenessSessionResult200Response	The request has succeeded.
GetLivenessSessionResultDefaultHeaders
GetLivenessSessionResultDefaultResponse
GetLivenessWithVerifySessionResult200Response	The request has succeeded.
GetLivenessWithVerifySessionResultDefaultHeaders
GetLivenessWithVerifySessionResultDefaultResponse
GetPersonGroup200Response	A successful call returns the Person Group's information.
GetPersonGroupDefaultHeaders
GetPersonGroupDefaultResponse
GetPersonGroupPerson200Response	A successful call returns the person's information.
GetPersonGroupPersonDefaultHeaders
GetPersonGroupPersonDefaultResponse
GetPersonGroupPersonFace200Response	A successful call returns target persisted face's information (persistedFaceId and userData).
GetPersonGroupPersonFaceDefaultHeaders
GetPersonGroupPersonFaceDefaultResponse
GetPersonGroupPersons200Response	A successful call returns an array of person information that belong to the Person Group.
GetPersonGroupPersonsDefaultHeaders
GetPersonGroupPersonsDefaultResponse
GetPersonGroupPersonsQueryParam
GetPersonGroupPersonsQueryParamProperties
GetPersonGroupQueryParam
GetPersonGroupQueryParamProperties
GetPersonGroupTrainingStatus
GetPersonGroupTrainingStatus200Response	A successful call returns the Person Group's training status.
GetPersonGroupTrainingStatusDefaultHeaders
GetPersonGroupTrainingStatusDefaultResponse
GetPersonGroups
GetPersonGroups200Response	A successful call returns an array of Person Groups and their information (personGroupId, name and userData).
GetPersonGroupsDefaultHeaders
GetPersonGroupsDefaultResponse
GetPersonGroupsQueryParam
GetPersonGroupsQueryParamProperties
GetSessionImage
GetSessionImage200Headers
GetSessionImage200Response	The request has succeeded.
GetSessionImageDefaultHeaders
GetSessionImageDefaultResponse
Group
Group200Response	A successful call returns one or more groups of similar faces (rank by group size) and a messyGroup.
GroupBodyParam
GroupDefaultHeaders
GroupDefaultResponse
GroupingResultOutput	Response body for group face operation.
HairColorOutput	An array of candidate colors and confidence level in the presence of each.
HairPropertiesOutput	Properties describing hair attributes.
HeadPoseOutput	3-D roll/yaw/pitch angles for face direction.
IdentificationCandidateOutput	Candidate for identify call.
IdentificationResultOutput	Identify result.
IdentifyFromDynamicPersonGroup200Response	A successful call returns the identified candidate person(s) for each query face.
IdentifyFromDynamicPersonGroupBodyParam
IdentifyFromDynamicPersonGroupDefaultHeaders
IdentifyFromDynamicPersonGroupDefaultResponse
IdentifyFromLargePersonGroup200Response	A successful call returns the identified candidate person(s) for each query face.
IdentifyFromLargePersonGroupBodyParam
IdentifyFromLargePersonGroupDefaultHeaders
IdentifyFromLargePersonGroupDefaultResponse
IdentifyFromPersonDirectory200Response	A successful call returns the identified candidate person(s) for each query face.
IdentifyFromPersonDirectoryBodyParam
IdentifyFromPersonDirectoryDefaultHeaders
IdentifyFromPersonDirectoryDefaultResponse
IdentifyFromPersonGroup
IdentifyFromPersonGroup200Response	A successful call returns the identified candidate person(s) for each query face.
IdentifyFromPersonGroupBodyParam
IdentifyFromPersonGroupDefaultHeaders
IdentifyFromPersonGroupDefaultResponse
LandmarkCoordinateOutput	Landmark coordinates within an image.
LargeFaceListFaceOutput	Face resource for large face list.
LargeFaceListOutput	Large face list is a list of faces, up to 1,000,000 faces.
LargePersonGroupOutput	The container of the uploaded person data, including face recognition feature, and up to 1,000,000 people.
LargePersonGroupPersonFaceOutput	Face resource for large person group person.
LargePersonGroupPersonOutput	The person in a specified large person group. To add face to this person, please call "Add Large Person Group Person Face".
LivenessColorDecisionTargetOutput	The target from color image used for liveness classification.
LivenessDecisionTargetsOutput	The targets used for liveness classification.
LivenessErrorOutput	The error of the liveness classification.
LivenessResultOutput	The results of the liveness classification.
LivenessSessionAttemptOutput	The liveness session attempt.
LivenessSessionOutput	Session result of detect liveness.
LivenessSessionResultsOutput	The results of the liveness session.
LivenessWithVerifyOutputsOutput	The face verification output.
LivenessWithVerifyReferenceOutput	The detail of face for verification.
LivenessWithVerifyResultOutput	The results of the liveness with verify call.
LivenessWithVerifySessionAttemptOutput	The liveness with verify session attempt.
LivenessWithVerifySessionOutput	Session result of detect liveness with verify.
LivenessWithVerifySessionResultsOutput	The results of the liveness with verify session.
MaskPropertiesOutput	Properties describing the presence of a mask on a given face.
NoisePropertiesOutput	Properties describing noise level of the image.
OcclusionPropertiesOutput	Properties describing occlusions on a given face.
PersonGroupOutput	The container of the uploaded person data, including face recognition feature, and up to 10,000 persons. To handle larger scale face identification problem, please consider using Large Person Group.
PersonGroupPersonFaceOutput	Face resource for person group person.
PersonGroupPersonOutput	The person in a specified person group. To add face to this person, please call "Add Large Person Group Person Face".
Routes
SimplePollerLike	A simple poller that can be used to poll a long running operation.
TrainLargeFaceList
TrainLargeFaceList202Headers
TrainLargeFaceList202Response	A successful call returns an empty response body.
TrainLargeFaceListDefaultHeaders
TrainLargeFaceListDefaultResponse
TrainLargeFaceListLogicalResponse	The final response for long-running trainLargeFaceList operation
TrainLargePersonGroup
TrainLargePersonGroup202Headers
TrainLargePersonGroup202Response	A successful call returns an empty response body.
TrainLargePersonGroupDefaultHeaders
TrainLargePersonGroupDefaultResponse
TrainLargePersonGroupLogicalResponse	The final response for long-running trainLargePersonGroup operation
TrainPersonGroup
TrainPersonGroup202Headers
TrainPersonGroup202Response	A successful call returns an empty response body.
TrainPersonGroupDefaultHeaders
TrainPersonGroupDefaultResponse
TrainPersonGroupLogicalResponse	The final response for long-running trainPersonGroup operation
TrainingResultOutput	Training result of a container
UpdateFaceList200Response	The request has succeeded.
UpdateFaceListBodyParam
UpdateFaceListDefaultHeaders
UpdateFaceListDefaultResponse
UpdateLargeFaceList200Response	The request has succeeded.
UpdateLargeFaceListBodyParam
UpdateLargeFaceListDefaultHeaders
UpdateLargeFaceListDefaultResponse
UpdateLargeFaceListFace200Response	The request has succeeded.
UpdateLargeFaceListFaceBodyParam
UpdateLargeFaceListFaceDefaultHeaders
UpdateLargeFaceListFaceDefaultResponse
UpdateLargePersonGroup200Response	The request has succeeded.
UpdateLargePersonGroupBodyParam
UpdateLargePersonGroupDefaultHeaders
UpdateLargePersonGroupDefaultResponse
UpdateLargePersonGroupPerson200Response	The request has succeeded.
UpdateLargePersonGroupPersonBodyParam
UpdateLargePersonGroupPersonDefaultHeaders
UpdateLargePersonGroupPersonDefaultResponse
UpdateLargePersonGroupPersonFace200Response	The request has succeeded.
UpdateLargePersonGroupPersonFaceBodyParam
UpdateLargePersonGroupPersonFaceDefaultHeaders
UpdateLargePersonGroupPersonFaceDefaultResponse
UpdatePersonGroup200Response	The request has succeeded.
UpdatePersonGroupBodyParam
UpdatePersonGroupDefaultHeaders
UpdatePersonGroupDefaultResponse
UpdatePersonGroupPerson200Response	The request has succeeded.
UpdatePersonGroupPersonBodyParam
UpdatePersonGroupPersonDefaultHeaders
UpdatePersonGroupPersonDefaultResponse
UpdatePersonGroupPersonFace200Response	The request has succeeded.
UpdatePersonGroupPersonFaceBodyParam
UpdatePersonGroupPersonFaceDefaultHeaders
UpdatePersonGroupPersonFaceDefaultResponse
UserDefinedFields	User defined fields for object creation.
UserDefinedFieldsForUpdate	User defined fields for object update.
VerificationResultOutput	Verify result.
VerifyFaceToFace
VerifyFaceToFace200Response	A successful call returns the verification result.
VerifyFaceToFaceBodyParam
VerifyFaceToFaceDefaultHeaders
VerifyFaceToFaceDefaultResponse
VerifyFromLargePersonGroup200Response	A successful call returns the verification result.
VerifyFromLargePersonGroupBodyParam
VerifyFromLargePersonGroupDefaultHeaders
VerifyFromLargePersonGroupDefaultResponse
VerifyFromPersonDirectory200Response	A successful call returns the verification result.
VerifyFromPersonDirectoryBodyParam
VerifyFromPersonDirectoryDefaultHeaders
VerifyFromPersonDirectoryDefaultResponse
VerifyFromPersonGroup200Response	A successful call returns the verification result.
VerifyFromPersonGroupBodyParam
VerifyFromPersonGroupDefaultHeaders
VerifyFromPersonGroupDefaultResponse

Type Aliases

AccessoryTypeOutput	Alias for AccessoryTypeOutput
AddFaceListFaceFromUrlParameters
AddFaceListFaceParameters
AddLargeFaceListFaceFromUrlParameters
AddLargeFaceListFaceParameters
AddLargePersonGroupPersonFaceFromUrlParameters
AddLargePersonGroupPersonFaceParameters
AddPersonGroupPersonFaceFromUrlParameters
AddPersonGroupPersonFaceParameters
BlurLevelOutput	Alias for BlurLevelOutput
CreateFaceListParameters
CreateLargeFaceListParameters
CreateLargePersonGroupParameters
CreateLargePersonGroupPersonParameters
CreateLivenessSessionParameters
CreateLivenessWithVerifySessionContent	Request of liveness with verify session creation.
CreateLivenessWithVerifySessionParameters
CreatePersonGroupParameters
CreatePersonGroupPersonParameters
DeleteFaceListFaceParameters
DeleteFaceListParameters
DeleteLargeFaceListFaceParameters
DeleteLargeFaceListParameters
DeleteLargePersonGroupParameters
DeleteLargePersonGroupPersonFaceParameters
DeleteLargePersonGroupPersonParameters
DeleteLivenessSessionParameters
DeleteLivenessWithVerifySessionParameters
DeletePersonGroupParameters
DeletePersonGroupPersonFaceParameters
DeletePersonGroupPersonParameters
DetectFromSessionImageIdParameters
DetectFromUrlParameters
DetectParameters
DetectionModel	Alias for DetectionModel
ExposureLevelOutput	Alias for ExposureLevelOutput
FaceAttributeType	Alias for FaceAttributeType
FaceClient
FindSimilarFromFaceListParameters
FindSimilarFromLargeFaceListParameters
FindSimilarMatchMode	Alias for FindSimilarMatchMode
FindSimilarParameters
GetFaceListParameters
GetFaceListsParameters
GetLargeFaceListFaceParameters
GetLargeFaceListFacesParameters
GetLargeFaceListParameters
GetLargeFaceListTrainingStatusParameters
GetLargeFaceListsParameters
GetLargePersonGroupParameters
GetLargePersonGroupPersonFaceParameters
GetLargePersonGroupPersonParameters
GetLargePersonGroupPersonsParameters
GetLargePersonGroupTrainingStatusParameters
GetLargePersonGroupsParameters
GetLivenessSessionResultParameters
GetLivenessWithVerifySessionResultParameters
GetPersonGroupParameters
GetPersonGroupPersonFaceParameters
GetPersonGroupPersonParameters
GetPersonGroupPersonsParameters
GetPersonGroupTrainingStatusParameters
GetPersonGroupsParameters
GetSessionImageParameters
GlassesTypeOutput	Alias for GlassesTypeOutput
GroupParameters
HairColorTypeOutput	Alias for HairColorTypeOutput
IdentifyFromDynamicPersonGroupParameters
IdentifyFromLargePersonGroupParameters
IdentifyFromPersonDirectoryParameters
IdentifyFromPersonGroupParameters
ImageTypeOutput	Alias for ImageTypeOutput
LivenessDecisionOutput	Alias for LivenessDecisionOutput
LivenessModel	Alias for LivenessModel
LivenessModelOutput	Alias for LivenessModelOutput
LivenessOperationMode	Alias for LivenessOperationMode
MaskTypeOutput	Alias for MaskTypeOutput
NoiseLevelOutput	Alias for NoiseLevelOutput
OperationStateOutput	Alias for OperationStateOutput
OperationStatusOutput	Alias for OperationStatusOutput
QualityForRecognitionOutput	Alias for QualityForRecognitionOutput
RecognitionModel	Alias for RecognitionModel
RecognitionModelOutput	Alias for RecognitionModelOutput
TrainLargeFaceListParameters
TrainLargePersonGroupParameters
TrainPersonGroupParameters
UpdateFaceListParameters
UpdateLargeFaceListFaceParameters
UpdateLargeFaceListParameters
UpdateLargePersonGroupParameters
UpdateLargePersonGroupPersonFaceParameters
UpdateLargePersonGroupPersonParameters
UpdatePersonGroupParameters
UpdatePersonGroupPersonFaceParameters
UpdatePersonGroupPersonParameters
VerifyFaceToFaceParameters
VerifyFromLargePersonGroupParameters
VerifyFromPersonDirectoryParameters
VerifyFromPersonGroupParameters
Versions	API versions for Azure AI Face API.

Functions

default(string, TokenCredential | KeyCredential, FaceClientOptions)	Initialize a new instance of FaceClient
getLongRunningPoller<TResult>(Client, TrainLargeFaceList202Response | TrainLargeFaceListDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)	Helper function that builds a Poller object to help polling a long running operation.
getLongRunningPoller<TResult>(Client, TrainPersonGroup202Response | TrainPersonGroupDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, TrainLargePersonGroup202Response | TrainLargePersonGroupDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
isUnexpected(DetectFromUrl200Response | DetectFromUrlDefaultResponse)
isUnexpected(Detect200Response | DetectDefaultResponse)
isUnexpected(DetectFromSessionImageId200Response | DetectFromSessionImageIdDefaultResponse)
isUnexpected(FindSimilar200Response | FindSimilarDefaultResponse)
isUnexpected(FindSimilarFromFaceList200Response | FindSimilarFromFaceListDefaultResponse)
isUnexpected(FindSimilarFromLargeFaceList200Response | FindSimilarFromLargeFaceListDefaultResponse)
isUnexpected(IdentifyFromPersonGroup200Response | IdentifyFromPersonGroupDefaultResponse)
isUnexpected(IdentifyFromLargePersonGroup200Response | IdentifyFromLargePersonGroupDefaultResponse)
isUnexpected(IdentifyFromPersonDirectory200Response | IdentifyFromPersonDirectoryDefaultResponse)
isUnexpected(IdentifyFromDynamicPersonGroup200Response | IdentifyFromDynamicPersonGroupDefaultResponse)
isUnexpected(VerifyFaceToFace200Response | VerifyFaceToFaceDefaultResponse)
isUnexpected(VerifyFromPersonGroup200Response | VerifyFromPersonGroupDefaultResponse)
isUnexpected(VerifyFromLargePersonGroup200Response | VerifyFromLargePersonGroupDefaultResponse)
isUnexpected(VerifyFromPersonDirectory200Response | VerifyFromPersonDirectoryDefaultResponse)
isUnexpected(Group200Response | GroupDefaultResponse)
isUnexpected(CreateFaceList200Response | CreateFaceListDefaultResponse)
isUnexpected(DeleteFaceList200Response | DeleteFaceListDefaultResponse)
isUnexpected(GetFaceList200Response | GetFaceListDefaultResponse)
isUnexpected(UpdateFaceList200Response | UpdateFaceListDefaultResponse)
isUnexpected(GetFaceLists200Response | GetFaceListsDefaultResponse)
isUnexpected(AddFaceListFaceFromUrl200Response | AddFaceListFaceFromUrlDefaultResponse)
isUnexpected(AddFaceListFace200Response | AddFaceListFaceDefaultResponse)
isUnexpected(DeleteFaceListFace200Response | DeleteFaceListFaceDefaultResponse)
isUnexpected(CreateLargeFaceList200Response | CreateLargeFaceListDefaultResponse)
isUnexpected(DeleteLargeFaceList200Response | DeleteLargeFaceListDefaultResponse)
isUnexpected(GetLargeFaceList200Response | GetLargeFaceListDefaultResponse)
isUnexpected(UpdateLargeFaceList200Response | UpdateLargeFaceListDefaultResponse)
isUnexpected(GetLargeFaceLists200Response | GetLargeFaceListsDefaultResponse)
isUnexpected(GetLargeFaceListTrainingStatus200Response | GetLargeFaceListTrainingStatusDefaultResponse)
isUnexpected(TrainLargeFaceList202Response | TrainLargeFaceListDefaultResponse | TrainLargeFaceListLogicalResponse)
isUnexpected(AddLargeFaceListFaceFromUrl200Response | AddLargeFaceListFaceFromUrlDefaultResponse)
isUnexpected(AddLargeFaceListFace200Response | AddLargeFaceListFaceDefaultResponse)
isUnexpected(GetLargeFaceListFaces200Response | GetLargeFaceListFacesDefaultResponse)
isUnexpected(DeleteLargeFaceListFace200Response | DeleteLargeFaceListFaceDefaultResponse)
isUnexpected(GetLargeFaceListFace200Response | GetLargeFaceListFaceDefaultResponse)
isUnexpected(UpdateLargeFaceListFace200Response | UpdateLargeFaceListFaceDefaultResponse)
isUnexpected(CreatePersonGroup200Response | CreatePersonGroupDefaultResponse)
isUnexpected(DeletePersonGroup200Response | DeletePersonGroupDefaultResponse)
isUnexpected(GetPersonGroup200Response | GetPersonGroupDefaultResponse)
isUnexpected(UpdatePersonGroup200Response | UpdatePersonGroupDefaultResponse)
isUnexpected(GetPersonGroups200Response | GetPersonGroupsDefaultResponse)
isUnexpected(GetPersonGroupTrainingStatus200Response | GetPersonGroupTrainingStatusDefaultResponse)
isUnexpected(TrainPersonGroup202Response | TrainPersonGroupDefaultResponse | TrainPersonGroupLogicalResponse)
isUnexpected(CreatePersonGroupPerson200Response | CreatePersonGroupPersonDefaultResponse)
isUnexpected(GetPersonGroupPersons200Response | GetPersonGroupPersonsDefaultResponse)
isUnexpected(DeletePersonGroupPerson200Response | DeletePersonGroupPersonDefaultResponse)
isUnexpected(GetPersonGroupPerson200Response | GetPersonGroupPersonDefaultResponse)
isUnexpected(UpdatePersonGroupPerson200Response | UpdatePersonGroupPersonDefaultResponse)
isUnexpected(AddPersonGroupPersonFaceFromUrl200Response | AddPersonGroupPersonFaceFromUrlDefaultResponse)
isUnexpected(AddPersonGroupPersonFace200Response | AddPersonGroupPersonFaceDefaultResponse)
isUnexpected(DeletePersonGroupPersonFace200Response | DeletePersonGroupPersonFaceDefaultResponse)
isUnexpected(GetPersonGroupPersonFace200Response | GetPersonGroupPersonFaceDefaultResponse)
isUnexpected(UpdatePersonGroupPersonFace200Response | UpdatePersonGroupPersonFaceDefaultResponse)
isUnexpected(CreateLargePersonGroup200Response | CreateLargePersonGroupDefaultResponse)
isUnexpected(DeleteLargePersonGroup200Response | DeleteLargePersonGroupDefaultResponse)
isUnexpected(GetLargePersonGroup200Response | GetLargePersonGroupDefaultResponse)
isUnexpected(UpdateLargePersonGroup200Response | UpdateLargePersonGroupDefaultResponse)
isUnexpected(GetLargePersonGroups200Response | GetLargePersonGroupsDefaultResponse)
isUnexpected(GetLargePersonGroupTrainingStatus200Response | GetLargePersonGroupTrainingStatusDefaultResponse)
isUnexpected(TrainLargePersonGroup202Response | TrainLargePersonGroupDefaultResponse | TrainLargePersonGroupLogicalResponse)
isUnexpected(CreateLargePersonGroupPerson200Response | CreateLargePersonGroupPersonDefaultResponse)
isUnexpected(GetLargePersonGroupPersons200Response | GetLargePersonGroupPersonsDefaultResponse)
isUnexpected(DeleteLargePersonGroupPerson200Response | DeleteLargePersonGroupPersonDefaultResponse)
isUnexpected(GetLargePersonGroupPerson200Response | GetLargePersonGroupPersonDefaultResponse)
isUnexpected(UpdateLargePersonGroupPerson200Response | UpdateLargePersonGroupPersonDefaultResponse)
isUnexpected(AddLargePersonGroupPersonFaceFromUrl200Response | AddLargePersonGroupPersonFaceFromUrlDefaultResponse)
isUnexpected(AddLargePersonGroupPersonFace200Response | AddLargePersonGroupPersonFaceDefaultResponse)
isUnexpected(DeleteLargePersonGroupPersonFace200Response | DeleteLargePersonGroupPersonFaceDefaultResponse)
isUnexpected(GetLargePersonGroupPersonFace200Response | GetLargePersonGroupPersonFaceDefaultResponse)
isUnexpected(UpdateLargePersonGroupPersonFace200Response | UpdateLargePersonGroupPersonFaceDefaultResponse)
isUnexpected(CreateLivenessSession200Response | CreateLivenessSessionDefaultResponse)
isUnexpected(DeleteLivenessSession204Response | DeleteLivenessSessionDefaultResponse)
isUnexpected(GetLivenessSessionResult200Response | GetLivenessSessionResultDefaultResponse)
isUnexpected(CreateLivenessWithVerifySession200Response | CreateLivenessWithVerifySessionDefaultResponse)
isUnexpected(DeleteLivenessWithVerifySession204Response | DeleteLivenessWithVerifySessionDefaultResponse)
isUnexpected(GetLivenessWithVerifySessionResult200Response | GetLivenessWithVerifySessionResultDefaultResponse)
isUnexpected(GetSessionImage200Response | GetSessionImageDefaultResponse)

Function Details

default(string, TokenCredential | KeyCredential, FaceClientOptions)

Initialize a new instance of FaceClient

function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: FaceClientOptions): FaceClient

Parameters

endpointParam

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).

credentials

TokenCredential | KeyCredential

uniquely identify client credential

options

FaceClientOptions

the parameter for all optional parameters

Returns

FaceClient

getLongRunningPoller<TResult>(Client, TrainLargeFaceList202Response | TrainLargeFaceListDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Helper function that builds a Poller object to help polling a long running operation.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TrainLargeFaceList202Response | TrainLargeFaceListDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client

Client

Client to use for sending the request to get additional pages.

initialResponse

TrainLargeFaceList202Response | TrainLargeFaceListDefaultResponse

The initial response.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Options to set a resume state or custom polling interval.

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

• A poller object to poll for operation state updates and eventually get the final response.

getLongRunningPoller<TResult>(Client, TrainPersonGroup202Response | TrainPersonGroupDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

function getLongRunningPoller<TResult>(client: Client, initialResponse: TrainPersonGroup202Response | TrainPersonGroupDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client

Client

initialResponse

TrainPersonGroup202Response | TrainPersonGroupDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

getLongRunningPoller<TResult>(Client, TrainLargePersonGroup202Response | TrainLargePersonGroupDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

function getLongRunningPoller<TResult>(client: Client, initialResponse: TrainLargePersonGroup202Response | TrainLargePersonGroupDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client

Client

initialResponse

TrainLargePersonGroup202Response | TrainLargePersonGroupDefaultResponse

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

isUnexpected(DetectFromUrl200Response | DetectFromUrlDefaultResponse)

function isUnexpected(response: DetectFromUrl200Response | DetectFromUrlDefaultResponse): response

Parameters

response

DetectFromUrl200Response | DetectFromUrlDefaultResponse

Returns

response

isUnexpected(Detect200Response | DetectDefaultResponse)

function isUnexpected(response: Detect200Response | DetectDefaultResponse): response

Parameters

response

Detect200Response | DetectDefaultResponse

Returns

response

isUnexpected(DetectFromSessionImageId200Response | DetectFromSessionImageIdDefaultResponse)

function isUnexpected(response: DetectFromSessionImageId200Response | DetectFromSessionImageIdDefaultResponse): response

Parameters

response

DetectFromSessionImageId200Response | DetectFromSessionImageIdDefaultResponse

Returns

response

isUnexpected(FindSimilar200Response | FindSimilarDefaultResponse)

function isUnexpected(response: FindSimilar200Response | FindSimilarDefaultResponse): response

Parameters

response

FindSimilar200Response | FindSimilarDefaultResponse

Returns

response

isUnexpected(FindSimilarFromFaceList200Response | FindSimilarFromFaceListDefaultResponse)

function isUnexpected(response: FindSimilarFromFaceList200Response | FindSimilarFromFaceListDefaultResponse): response

Parameters

response

FindSimilarFromFaceList200Response | FindSimilarFromFaceListDefaultResponse

Returns

response

isUnexpected(FindSimilarFromLargeFaceList200Response | FindSimilarFromLargeFaceListDefaultResponse)

function isUnexpected(response: FindSimilarFromLargeFaceList200Response | FindSimilarFromLargeFaceListDefaultResponse): response

Parameters

response

FindSimilarFromLargeFaceList200Response | FindSimilarFromLargeFaceListDefaultResponse

Returns

response

isUnexpected(IdentifyFromPersonGroup200Response | IdentifyFromPersonGroupDefaultResponse)

function isUnexpected(response: IdentifyFromPersonGroup200Response | IdentifyFromPersonGroupDefaultResponse): response

Parameters

response

IdentifyFromPersonGroup200Response | IdentifyFromPersonGroupDefaultResponse

Returns

response

isUnexpected(IdentifyFromLargePersonGroup200Response | IdentifyFromLargePersonGroupDefaultResponse)

function isUnexpected(response: IdentifyFromLargePersonGroup200Response | IdentifyFromLargePersonGroupDefaultResponse): response

Parameters

response

IdentifyFromLargePersonGroup200Response | IdentifyFromLargePersonGroupDefaultResponse

Returns

response

isUnexpected(IdentifyFromPersonDirectory200Response | IdentifyFromPersonDirectoryDefaultResponse)

function isUnexpected(response: IdentifyFromPersonDirectory200Response | IdentifyFromPersonDirectoryDefaultResponse): response

Parameters

response

IdentifyFromPersonDirectory200Response | IdentifyFromPersonDirectoryDefaultResponse

Returns

response

isUnexpected(IdentifyFromDynamicPersonGroup200Response | IdentifyFromDynamicPersonGroupDefaultResponse)

function isUnexpected(response: IdentifyFromDynamicPersonGroup200Response | IdentifyFromDynamicPersonGroupDefaultResponse): response

Parameters

response

IdentifyFromDynamicPersonGroup200Response | IdentifyFromDynamicPersonGroupDefaultResponse

Returns

response

isUnexpected(VerifyFaceToFace200Response | VerifyFaceToFaceDefaultResponse)

function isUnexpected(response: VerifyFaceToFace200Response | VerifyFaceToFaceDefaultResponse): response

Parameters

response

VerifyFaceToFace200Response | VerifyFaceToFaceDefaultResponse

Returns

response

isUnexpected(VerifyFromPersonGroup200Response | VerifyFromPersonGroupDefaultResponse)

function isUnexpected(response: VerifyFromPersonGroup200Response | VerifyFromPersonGroupDefaultResponse): response

Parameters

response

VerifyFromPersonGroup200Response | VerifyFromPersonGroupDefaultResponse

Returns

response

isUnexpected(VerifyFromLargePersonGroup200Response | VerifyFromLargePersonGroupDefaultResponse)

function isUnexpected(response: VerifyFromLargePersonGroup200Response | VerifyFromLargePersonGroupDefaultResponse): response

Parameters

response

VerifyFromLargePersonGroup200Response | VerifyFromLargePersonGroupDefaultResponse

Returns

response

isUnexpected(VerifyFromPersonDirectory200Response | VerifyFromPersonDirectoryDefaultResponse)

function isUnexpected(response: VerifyFromPersonDirectory200Response | VerifyFromPersonDirectoryDefaultResponse): response

Parameters

response

VerifyFromPersonDirectory200Response | VerifyFromPersonDirectoryDefaultResponse

Returns

response

isUnexpected(Group200Response | GroupDefaultResponse)

function isUnexpected(response: Group200Response | GroupDefaultResponse): response

Parameters

response

Group200Response | GroupDefaultResponse

Returns

response

isUnexpected(CreateFaceList200Response | CreateFaceListDefaultResponse)

function isUnexpected(response: CreateFaceList200Response | CreateFaceListDefaultResponse): response

Parameters

response

CreateFaceList200Response | CreateFaceListDefaultResponse

Returns

response

isUnexpected(DeleteFaceList200Response | DeleteFaceListDefaultResponse)

function isUnexpected(response: DeleteFaceList200Response | DeleteFaceListDefaultResponse): response

Parameters

response

DeleteFaceList200Response | DeleteFaceListDefaultResponse

Returns

response

isUnexpected(GetFaceList200Response | GetFaceListDefaultResponse)

function isUnexpected(response: GetFaceList200Response | GetFaceListDefaultResponse): response

Parameters

response

GetFaceList200Response | GetFaceListDefaultResponse

Returns

response

isUnexpected(UpdateFaceList200Response | UpdateFaceListDefaultResponse)

function isUnexpected(response: UpdateFaceList200Response | UpdateFaceListDefaultResponse): response

Parameters

response

UpdateFaceList200Response | UpdateFaceListDefaultResponse

Returns

response

isUnexpected(GetFaceLists200Response | GetFaceListsDefaultResponse)

function isUnexpected(response: GetFaceLists200Response | GetFaceListsDefaultResponse): response

Parameters

response

GetFaceLists200Response | GetFaceListsDefaultResponse

Returns

response

isUnexpected(AddFaceListFaceFromUrl200Response | AddFaceListFaceFromUrlDefaultResponse)

function isUnexpected(response: AddFaceListFaceFromUrl200Response | AddFaceListFaceFromUrlDefaultResponse): response

Parameters

response

AddFaceListFaceFromUrl200Response | AddFaceListFaceFromUrlDefaultResponse

Returns

response

isUnexpected(AddFaceListFace200Response | AddFaceListFaceDefaultResponse)

function isUnexpected(response: AddFaceListFace200Response | AddFaceListFaceDefaultResponse): response

Parameters

response

AddFaceListFace200Response | AddFaceListFaceDefaultResponse

Returns

response

isUnexpected(DeleteFaceListFace200Response | DeleteFaceListFaceDefaultResponse)

function isUnexpected(response: DeleteFaceListFace200Response | DeleteFaceListFaceDefaultResponse): response

Parameters

response

DeleteFaceListFace200Response | DeleteFaceListFaceDefaultResponse

Returns

response

isUnexpected(CreateLargeFaceList200Response | CreateLargeFaceListDefaultResponse)

function isUnexpected(response: CreateLargeFaceList200Response | CreateLargeFaceListDefaultResponse): response

Parameters

response

CreateLargeFaceList200Response | CreateLargeFaceListDefaultResponse

Returns

response

isUnexpected(DeleteLargeFaceList200Response | DeleteLargeFaceListDefaultResponse)

function isUnexpected(response: DeleteLargeFaceList200Response | DeleteLargeFaceListDefaultResponse): response

Parameters

response

DeleteLargeFaceList200Response | DeleteLargeFaceListDefaultResponse

Returns

response

isUnexpected(GetLargeFaceList200Response | GetLargeFaceListDefaultResponse)

function isUnexpected(response: GetLargeFaceList200Response | GetLargeFaceListDefaultResponse): response

Parameters

response

GetLargeFaceList200Response | GetLargeFaceListDefaultResponse

Returns

response

isUnexpected(UpdateLargeFaceList200Response | UpdateLargeFaceListDefaultResponse)

function isUnexpected(response: UpdateLargeFaceList200Response | UpdateLargeFaceListDefaultResponse): response

Parameters

response

UpdateLargeFaceList200Response | UpdateLargeFaceListDefaultResponse

Returns

response

isUnexpected(GetLargeFaceLists200Response | GetLargeFaceListsDefaultResponse)

function isUnexpected(response: GetLargeFaceLists200Response | GetLargeFaceListsDefaultResponse): response

Parameters

response

GetLargeFaceLists200Response | GetLargeFaceListsDefaultResponse

Returns

response

isUnexpected(GetLargeFaceListTrainingStatus200Response | GetLargeFaceListTrainingStatusDefaultResponse)

function isUnexpected(response: GetLargeFaceListTrainingStatus200Response | GetLargeFaceListTrainingStatusDefaultResponse): response

Parameters

response

GetLargeFaceListTrainingStatus200Response | GetLargeFaceListTrainingStatusDefaultResponse

Returns

response

isUnexpected(TrainLargeFaceList202Response | TrainLargeFaceListDefaultResponse | TrainLargeFaceListLogicalResponse)

function isUnexpected(response: TrainLargeFaceList202Response | TrainLargeFaceListDefaultResponse | TrainLargeFaceListLogicalResponse): response

Parameters

response

TrainLargeFaceList202Response | TrainLargeFaceListDefaultResponse | TrainLargeFaceListLogicalResponse

Returns

response

isUnexpected(AddLargeFaceListFaceFromUrl200Response | AddLargeFaceListFaceFromUrlDefaultResponse)

function isUnexpected(response: AddLargeFaceListFaceFromUrl200Response | AddLargeFaceListFaceFromUrlDefaultResponse): response

Parameters

response

AddLargeFaceListFaceFromUrl200Response | AddLargeFaceListFaceFromUrlDefaultResponse

Returns

response

isUnexpected(AddLargeFaceListFace200Response | AddLargeFaceListFaceDefaultResponse)

function isUnexpected(response: AddLargeFaceListFace200Response | AddLargeFaceListFaceDefaultResponse): response

Parameters

response

AddLargeFaceListFace200Response | AddLargeFaceListFaceDefaultResponse

Returns

response

isUnexpected(GetLargeFaceListFaces200Response | GetLargeFaceListFacesDefaultResponse)

function isUnexpected(response: GetLargeFaceListFaces200Response | GetLargeFaceListFacesDefaultResponse): response

Parameters

response

GetLargeFaceListFaces200Response | GetLargeFaceListFacesDefaultResponse

Returns

response

isUnexpected(DeleteLargeFaceListFace200Response | DeleteLargeFaceListFaceDefaultResponse)

function isUnexpected(response: DeleteLargeFaceListFace200Response | DeleteLargeFaceListFaceDefaultResponse): response

Parameters

response

DeleteLargeFaceListFace200Response | DeleteLargeFaceListFaceDefaultResponse

Returns

response

isUnexpected(GetLargeFaceListFace200Response | GetLargeFaceListFaceDefaultResponse)

function isUnexpected(response: GetLargeFaceListFace200Response | GetLargeFaceListFaceDefaultResponse): response

Parameters

response

GetLargeFaceListFace200Response | GetLargeFaceListFaceDefaultResponse

Returns

response

isUnexpected(UpdateLargeFaceListFace200Response | UpdateLargeFaceListFaceDefaultResponse)

function isUnexpected(response: UpdateLargeFaceListFace200Response | UpdateLargeFaceListFaceDefaultResponse): response

Parameters

response

UpdateLargeFaceListFace200Response | UpdateLargeFaceListFaceDefaultResponse

Returns

response

isUnexpected(CreatePersonGroup200Response | CreatePersonGroupDefaultResponse)

function isUnexpected(response: CreatePersonGroup200Response | CreatePersonGroupDefaultResponse): response

Parameters

response

CreatePersonGroup200Response | CreatePersonGroupDefaultResponse

Returns

response

isUnexpected(DeletePersonGroup200Response | DeletePersonGroupDefaultResponse)

function isUnexpected(response: DeletePersonGroup200Response | DeletePersonGroupDefaultResponse): response

Parameters

response

DeletePersonGroup200Response | DeletePersonGroupDefaultResponse

Returns

response

isUnexpected(GetPersonGroup200Response | GetPersonGroupDefaultResponse)

function isUnexpected(response: GetPersonGroup200Response | GetPersonGroupDefaultResponse): response

Parameters

response

GetPersonGroup200Response | GetPersonGroupDefaultResponse

Returns

response

isUnexpected(UpdatePersonGroup200Response | UpdatePersonGroupDefaultResponse)

function isUnexpected(response: UpdatePersonGroup200Response | UpdatePersonGroupDefaultResponse): response

Parameters

response

UpdatePersonGroup200Response | UpdatePersonGroupDefaultResponse

Returns

response

isUnexpected(GetPersonGroups200Response | GetPersonGroupsDefaultResponse)

function isUnexpected(response: GetPersonGroups200Response | GetPersonGroupsDefaultResponse): response

Parameters

response

GetPersonGroups200Response | GetPersonGroupsDefaultResponse

Returns

response

isUnexpected(GetPersonGroupTrainingStatus200Response | GetPersonGroupTrainingStatusDefaultResponse)

function isUnexpected(response: GetPersonGroupTrainingStatus200Response | GetPersonGroupTrainingStatusDefaultResponse): response

Parameters

response

GetPersonGroupTrainingStatus200Response | GetPersonGroupTrainingStatusDefaultResponse

Returns

response

isUnexpected(TrainPersonGroup202Response | TrainPersonGroupDefaultResponse | TrainPersonGroupLogicalResponse)

function isUnexpected(response: TrainPersonGroup202Response | TrainPersonGroupDefaultResponse | TrainPersonGroupLogicalResponse): response

Parameters

response

TrainPersonGroup202Response | TrainPersonGroupDefaultResponse | TrainPersonGroupLogicalResponse

Returns

response

isUnexpected(CreatePersonGroupPerson200Response | CreatePersonGroupPersonDefaultResponse)

function isUnexpected(response: CreatePersonGroupPerson200Response | CreatePersonGroupPersonDefaultResponse): response

Parameters

response

CreatePersonGroupPerson200Response | CreatePersonGroupPersonDefaultResponse

Returns

response

isUnexpected(GetPersonGroupPersons200Response | GetPersonGroupPersonsDefaultResponse)

function isUnexpected(response: GetPersonGroupPersons200Response | GetPersonGroupPersonsDefaultResponse): response

Parameters

response

GetPersonGroupPersons200Response | GetPersonGroupPersonsDefaultResponse

Returns

response

isUnexpected(DeletePersonGroupPerson200Response | DeletePersonGroupPersonDefaultResponse)

function isUnexpected(response: DeletePersonGroupPerson200Response | DeletePersonGroupPersonDefaultResponse): response

Parameters

response

DeletePersonGroupPerson200Response | DeletePersonGroupPersonDefaultResponse

Returns

response

isUnexpected(GetPersonGroupPerson200Response | GetPersonGroupPersonDefaultResponse)

function isUnexpected(response: GetPersonGroupPerson200Response | GetPersonGroupPersonDefaultResponse): response

Parameters

response

GetPersonGroupPerson200Response | GetPersonGroupPersonDefaultResponse

Returns

response

isUnexpected(UpdatePersonGroupPerson200Response | UpdatePersonGroupPersonDefaultResponse)

function isUnexpected(response: UpdatePersonGroupPerson200Response | UpdatePersonGroupPersonDefaultResponse): response

Parameters

response

UpdatePersonGroupPerson200Response | UpdatePersonGroupPersonDefaultResponse

Returns

response

isUnexpected(AddPersonGroupPersonFaceFromUrl200Response | AddPersonGroupPersonFaceFromUrlDefaultResponse)

function isUnexpected(response: AddPersonGroupPersonFaceFromUrl200Response | AddPersonGroupPersonFaceFromUrlDefaultResponse): response

Parameters

response

AddPersonGroupPersonFaceFromUrl200Response | AddPersonGroupPersonFaceFromUrlDefaultResponse

Returns

response

isUnexpected(AddPersonGroupPersonFace200Response | AddPersonGroupPersonFaceDefaultResponse)

function isUnexpected(response: AddPersonGroupPersonFace200Response | AddPersonGroupPersonFaceDefaultResponse): response

Parameters

response

AddPersonGroupPersonFace200Response | AddPersonGroupPersonFaceDefaultResponse

Returns

response

isUnexpected(DeletePersonGroupPersonFace200Response | DeletePersonGroupPersonFaceDefaultResponse)

function isUnexpected(response: DeletePersonGroupPersonFace200Response | DeletePersonGroupPersonFaceDefaultResponse): response

Parameters

response

DeletePersonGroupPersonFace200Response | DeletePersonGroupPersonFaceDefaultResponse

Returns

response

isUnexpected(GetPersonGroupPersonFace200Response | GetPersonGroupPersonFaceDefaultResponse)

function isUnexpected(response: GetPersonGroupPersonFace200Response | GetPersonGroupPersonFaceDefaultResponse): response

Parameters

response

GetPersonGroupPersonFace200Response | GetPersonGroupPersonFaceDefaultResponse

Returns

response

isUnexpected(UpdatePersonGroupPersonFace200Response | UpdatePersonGroupPersonFaceDefaultResponse)

function isUnexpected(response: UpdatePersonGroupPersonFace200Response | UpdatePersonGroupPersonFaceDefaultResponse): response

Parameters

response

UpdatePersonGroupPersonFace200Response | UpdatePersonGroupPersonFaceDefaultResponse

Returns

response

isUnexpected(CreateLargePersonGroup200Response | CreateLargePersonGroupDefaultResponse)

function isUnexpected(response: CreateLargePersonGroup200Response | CreateLargePersonGroupDefaultResponse): response

Parameters

response

CreateLargePersonGroup200Response | CreateLargePersonGroupDefaultResponse

Returns

response

isUnexpected(DeleteLargePersonGroup200Response | DeleteLargePersonGroupDefaultResponse)

function isUnexpected(response: DeleteLargePersonGroup200Response | DeleteLargePersonGroupDefaultResponse): response

Parameters

response

DeleteLargePersonGroup200Response | DeleteLargePersonGroupDefaultResponse

Returns

response

isUnexpected(GetLargePersonGroup200Response | GetLargePersonGroupDefaultResponse)

function isUnexpected(response: GetLargePersonGroup200Response | GetLargePersonGroupDefaultResponse): response

Parameters

response

GetLargePersonGroup200Response | GetLargePersonGroupDefaultResponse

Returns

response

isUnexpected(UpdateLargePersonGroup200Response | UpdateLargePersonGroupDefaultResponse)

function isUnexpected(response: UpdateLargePersonGroup200Response | UpdateLargePersonGroupDefaultResponse): response

Parameters

response

UpdateLargePersonGroup200Response | UpdateLargePersonGroupDefaultResponse

Returns

response

isUnexpected(GetLargePersonGroups200Response | GetLargePersonGroupsDefaultResponse)

function isUnexpected(response: GetLargePersonGroups200Response | GetLargePersonGroupsDefaultResponse): response

Parameters

response

GetLargePersonGroups200Response | GetLargePersonGroupsDefaultResponse

Returns

response

isUnexpected(GetLargePersonGroupTrainingStatus200Response | GetLargePersonGroupTrainingStatusDefaultResponse)

function isUnexpected(response: GetLargePersonGroupTrainingStatus200Response | GetLargePersonGroupTrainingStatusDefaultResponse): response

Parameters

response

GetLargePersonGroupTrainingStatus200Response | GetLargePersonGroupTrainingStatusDefaultResponse

Returns

response

isUnexpected(TrainLargePersonGroup202Response | TrainLargePersonGroupDefaultResponse | TrainLargePersonGroupLogicalResponse)

function isUnexpected(response: TrainLargePersonGroup202Response | TrainLargePersonGroupDefaultResponse | TrainLargePersonGroupLogicalResponse): response

Parameters

response

TrainLargePersonGroup202Response | TrainLargePersonGroupDefaultResponse | TrainLargePersonGroupLogicalResponse

Returns

response

isUnexpected(CreateLargePersonGroupPerson200Response | CreateLargePersonGroupPersonDefaultResponse)

function isUnexpected(response: CreateLargePersonGroupPerson200Response | CreateLargePersonGroupPersonDefaultResponse): response

Parameters

response

CreateLargePersonGroupPerson200Response | CreateLargePersonGroupPersonDefaultResponse

Returns

response

isUnexpected(GetLargePersonGroupPersons200Response | GetLargePersonGroupPersonsDefaultResponse)

function isUnexpected(response: GetLargePersonGroupPersons200Response | GetLargePersonGroupPersonsDefaultResponse): response

Parameters

response

GetLargePersonGroupPersons200Response | GetLargePersonGroupPersonsDefaultResponse

Returns

response

isUnexpected(DeleteLargePersonGroupPerson200Response | DeleteLargePersonGroupPersonDefaultResponse)

function isUnexpected(response: DeleteLargePersonGroupPerson200Response | DeleteLargePersonGroupPersonDefaultResponse): response

Parameters

response

DeleteLargePersonGroupPerson200Response | DeleteLargePersonGroupPersonDefaultResponse

Returns

response

isUnexpected(GetLargePersonGroupPerson200Response | GetLargePersonGroupPersonDefaultResponse)

function isUnexpected(response: GetLargePersonGroupPerson200Response | GetLargePersonGroupPersonDefaultResponse): response

Parameters

response

GetLargePersonGroupPerson200Response | GetLargePersonGroupPersonDefaultResponse

Returns

response

isUnexpected(UpdateLargePersonGroupPerson200Response | UpdateLargePersonGroupPersonDefaultResponse)

function isUnexpected(response: UpdateLargePersonGroupPerson200Response | UpdateLargePersonGroupPersonDefaultResponse): response

Parameters

response

UpdateLargePersonGroupPerson200Response | UpdateLargePersonGroupPersonDefaultResponse

Returns

response

isUnexpected(AddLargePersonGroupPersonFaceFromUrl200Response | AddLargePersonGroupPersonFaceFromUrlDefaultResponse)

function isUnexpected(response: AddLargePersonGroupPersonFaceFromUrl200Response | AddLargePersonGroupPersonFaceFromUrlDefaultResponse): response

Parameters

response

AddLargePersonGroupPersonFaceFromUrl200Response | AddLargePersonGroupPersonFaceFromUrlDefaultResponse

Returns

response

isUnexpected(AddLargePersonGroupPersonFace200Response | AddLargePersonGroupPersonFaceDefaultResponse)

function isUnexpected(response: AddLargePersonGroupPersonFace200Response | AddLargePersonGroupPersonFaceDefaultResponse): response

Parameters

response

AddLargePersonGroupPersonFace200Response | AddLargePersonGroupPersonFaceDefaultResponse

Returns

response

isUnexpected(DeleteLargePersonGroupPersonFace200Response | DeleteLargePersonGroupPersonFaceDefaultResponse)

function isUnexpected(response: DeleteLargePersonGroupPersonFace200Response | DeleteLargePersonGroupPersonFaceDefaultResponse): response

Parameters

response

DeleteLargePersonGroupPersonFace200Response | DeleteLargePersonGroupPersonFaceDefaultResponse

Returns

response

isUnexpected(GetLargePersonGroupPersonFace200Response | GetLargePersonGroupPersonFaceDefaultResponse)

function isUnexpected(response: GetLargePersonGroupPersonFace200Response | GetLargePersonGroupPersonFaceDefaultResponse): response

Parameters

response

GetLargePersonGroupPersonFace200Response | GetLargePersonGroupPersonFaceDefaultResponse

Returns

response

isUnexpected(UpdateLargePersonGroupPersonFace200Response | UpdateLargePersonGroupPersonFaceDefaultResponse)

function isUnexpected(response: UpdateLargePersonGroupPersonFace200Response | UpdateLargePersonGroupPersonFaceDefaultResponse): response

Parameters

response

UpdateLargePersonGroupPersonFace200Response | UpdateLargePersonGroupPersonFaceDefaultResponse

Returns

response

isUnexpected(CreateLivenessSession200Response | CreateLivenessSessionDefaultResponse)

function isUnexpected(response: CreateLivenessSession200Response | CreateLivenessSessionDefaultResponse): response

Parameters

response

CreateLivenessSession200Response | CreateLivenessSessionDefaultResponse

Returns

response

isUnexpected(DeleteLivenessSession204Response | DeleteLivenessSessionDefaultResponse)

function isUnexpected(response: DeleteLivenessSession204Response | DeleteLivenessSessionDefaultResponse): response

Parameters

response

DeleteLivenessSession204Response | DeleteLivenessSessionDefaultResponse

Returns

response

isUnexpected(GetLivenessSessionResult200Response | GetLivenessSessionResultDefaultResponse)

function isUnexpected(response: GetLivenessSessionResult200Response | GetLivenessSessionResultDefaultResponse): response

Parameters

response

GetLivenessSessionResult200Response | GetLivenessSessionResultDefaultResponse

Returns

response

isUnexpected(CreateLivenessWithVerifySession200Response | CreateLivenessWithVerifySessionDefaultResponse)

function isUnexpected(response: CreateLivenessWithVerifySession200Response | CreateLivenessWithVerifySessionDefaultResponse): response

Parameters

response

CreateLivenessWithVerifySession200Response | CreateLivenessWithVerifySessionDefaultResponse

Returns

response

isUnexpected(DeleteLivenessWithVerifySession204Response | DeleteLivenessWithVerifySessionDefaultResponse)

function isUnexpected(response: DeleteLivenessWithVerifySession204Response | DeleteLivenessWithVerifySessionDefaultResponse): response

Parameters

response

DeleteLivenessWithVerifySession204Response | DeleteLivenessWithVerifySessionDefaultResponse

Returns

response

isUnexpected(GetLivenessWithVerifySessionResult200Response | GetLivenessWithVerifySessionResultDefaultResponse)

function isUnexpected(response: GetLivenessWithVerifySessionResult200Response | GetLivenessWithVerifySessionResultDefaultResponse): response

Parameters

response

GetLivenessWithVerifySessionResult200Response | GetLivenessWithVerifySessionResultDefaultResponse

Returns

response

isUnexpected(GetSessionImage200Response | GetSessionImageDefaultResponse)

function isUnexpected(response: GetSessionImage200Response | GetSessionImageDefaultResponse): response

Parameters

response

GetSessionImage200Response | GetSessionImageDefaultResponse

Returns

response