GET /settings — ai-face · SKMTC Hub

/

/Azure AI Face API

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 25m ago · Updated 2mo ago

Filter operations

postDetect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
postCreate a new detect liveness session.
get/detectLiveness-sessions/{sessionId}
deleteDelete all session related information for matching the specified session id.
postCreate a new liveness session with verify. Provide the verify image during session creation.
get/detectLivenessWithVerify-sessions/{sessionId}
deleteDelete all session related information for matching the specified session id.
get/facelists
get/facelists/{faceListId}
putCreate an empty Face List with user-specified faceListId, name, an optional userData and recognitionModel.
delete/facelists/{faceListId}
patch/facelists/{faceListId}
postAdd a face to a specified Face List, up to 1,000 faces.
deleteDelete a face from a Face List by specified faceListId and persistedFaceId.
postGiven query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect.
postDivide candidate faces into groups based on face similarity.
post1-to-many identification to find the closest matches of the specific query person face from a Person Group.
getList Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.
get/largefacelists/{largeFaceListId}
putCreate an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel.
deleteDelete a face from a Large Face List by specified largeFaceListId and persistedFaceId.
patch/largefacelists/{largeFaceListId}
getList faces' persistedFaceId and userData in a specified Large Face List.
postAdd a face to a specified Large Face List, up to 1,000,000 faces.
get/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}
delete/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}
patch/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}
postSubmit a Large Face List training task.
get/largefacelists/{largeFaceListId}/training
getList all existing Large Person Groups' largePersonGroupId, name, userData and recognitionModel.
get/largepersongroups/{largePersonGroupId}
putCreate a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.
delete/largepersongroups/{largePersonGroupId}
patch/largepersongroups/{largePersonGroupId}
getList all persons' information in the specified Large Person Group, including personId, name, userData and persistedFaceIds of registered person faces.
postCreate a new person in a specified Large Person Group. To add face to this person, please call "Add Large Person Group Person Face".
get/largepersongroups/{largePersonGroupId}/persons/{personId}
delete/largepersongroups/{largePersonGroupId}/persons/{personId}
patch/largepersongroups/{largePersonGroupId}/persons/{personId}
postAdd a face to a person into a Large Person Group for face identification or verification.
get/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
deleteDelete a face from a person in a Large Person Group by specified largePersonGroupId, personId and persistedFaceId.
patch/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
postSubmit 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".
getTo 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.
getList Person Groups' personGroupId, name, userData and recognitionModel.
get/persongroups/{personGroupId}
putCreate a new Person Group with specified personGroupId, name, user-provided userData and recognitionModel.
delete/persongroups/{personGroupId}
patch/persongroups/{personGroupId}
getList all persons' information in the specified Person Group, including personId, name, userData and persistedFaceIds of registered person faces.
postCreate a new person in a specified Person Group. To add face to this person, please call "Add Person Group Person Face".
get/persongroups/{personGroupId}/persons/{personId}
delete/persongroups/{personGroupId}/persons/{personId}
patch/persongroups/{personGroupId}/persons/{personId}
postAdd a face to a person into a Person Group for face identification or verification.
get/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
deleteDelete a face from a person in a Person Group by specified personGroupId, personId and persistedFaceId.
patch/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
postSubmit a Person Group training task. Training is a crucial step that only a trained Person Group can be used by "Identify From Person Group".
get/persongroups/{personGroupId}/training
get/sessionImages/{sessionImageId}
get/settings
patch/settings
get/settings/getClientAssetsAccessToken
postVerify whether two faces belong to a same person.

Get the liveness sessions setting object.

get/settings

Response

The request has succeeded.

Changes