@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Face Client
@version 1.0
@auth ApiKey Ocp-Apim-Subscription-Key in header
@endpoints 63
@hint download_for_search
@toc findsimilars(1), group(1), identify(1), verify(1), persongroups(16), facelists(7), detect(1), largepersongroups(16), largefacelists(12), snapshots(6), operations(1)

@group findsimilars
@endpoint POST /findsimilars
@required {body: map}
@returns(200)

@endgroup

@group group
@endpoint POST /group
@required {body: map}
@returns(200)

@endgroup

@group identify
@endpoint POST /identify
@required {body: map}
@returns(200)

@endgroup

@group verify
@endpoint POST /verify
@required {body: map}
@returns(200)

@endgroup

@group persongroups
@endpoint POST /persongroups/{personGroupId}/persons
@required {personGroupId: any, body: map}
@returns(200)

@endpoint GET /persongroups/{personGroupId}/persons
@required {personGroupId: any}
@optional {start: any, top: any}
@returns(200)

@endpoint DELETE /persongroups/{personGroupId}/persons/{personId}
@required {personGroupId: any, personId: any}
@returns(200)

@endpoint GET /persongroups/{personGroupId}/persons/{personId}
@required {personGroupId: any, personId: any}
@returns(200)

@endpoint PATCH /persongroups/{personGroupId}/persons/{personId}
@required {personGroupId: any, personId: any, body: map}
@returns(200)

@endpoint DELETE /persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
@required {personGroupId: any, personId: any, persistedFaceId: any}
@returns(200)

@endpoint GET /persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
@required {personGroupId: any, personId: any, persistedFaceId: any}
@returns(200)

@endpoint PATCH /persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
@required {personGroupId: any, personId: any, persistedFaceId: any, body: map}
@returns(200)

@endpoint PUT /persongroups/{personGroupId}
@required {personGroupId: any, body: map}
@returns(200)

@endpoint DELETE /persongroups/{personGroupId}
@required {personGroupId: any}
@returns(200)

@endpoint GET /persongroups/{personGroupId}
@required {personGroupId: any}
@optional {returnRecognitionModel: any}
@returns(200)

@endpoint PATCH /persongroups/{personGroupId}
@required {personGroupId: any, body: map}
@returns(200)

@endpoint GET /persongroups/{personGroupId}/training
@required {personGroupId: any}
@returns(200)

@endpoint GET /persongroups
@optional {start: any, top: any, returnRecognitionModel: any}
@returns(200)

@endpoint POST /persongroups/{personGroupId}/train
@required {personGroupId: any}
@returns(202)

@endgroup

@group facelists
@endpoint PUT /facelists/{faceListId}
@required {faceListId: any, body: map}
@returns(200)

@endpoint GET /facelists/{faceListId}
@required {faceListId: any}
@optional {returnRecognitionModel: any}
@returns(200)

@endpoint PATCH /facelists/{faceListId}
@required {faceListId: any, body: map}
@returns(200)

@endpoint DELETE /facelists/{faceListId}
@required {faceListId: any}
@returns(200)

@endpoint GET /facelists
@optional {returnRecognitionModel: any}
@returns(200)

@endpoint DELETE /facelists/{faceListId}/persistedfaces/{persistedFaceId}
@required {faceListId: any, persistedFaceId: any}
@returns(200)

@endgroup

@group persongroups
@endpoint POST /persongroups/{personGroupId}/persons/{personId}/persistedfaces
@required {personGroupId: any, personId: any}
@optional {userData: any, targetFace: any, detectionModel: any}
@returns(200)

@endgroup

@group detect
@endpoint POST /detect
@optional {returnFaceId: any, returnFaceLandmarks: any, returnFaceAttributes: any, recognitionModel: any, returnRecognitionModel: any, detectionModel: any, faceIdTimeToLive: any}
@returns(200)

@endgroup

@group facelists
@endpoint POST /facelists/{faceListId}/persistedfaces
@required {faceListId: any}
@optional {userData: any, targetFace: any, detectionModel: any}
@returns(200)

@endgroup

@group largepersongroups
@endpoint POST /largepersongroups/{largePersonGroupId}/persons
@required {largePersonGroupId: any, body: map}
@returns(200)

@endpoint GET /largepersongroups/{largePersonGroupId}/persons
@required {largePersonGroupId: any}
@optional {start: any, top: any}
@returns(200)

@endpoint DELETE /largepersongroups/{largePersonGroupId}/persons/{personId}
@required {largePersonGroupId: any, personId: any}
@returns(200)

@endpoint GET /largepersongroups/{largePersonGroupId}/persons/{personId}
@required {largePersonGroupId: any, personId: any}
@returns(200)

@endpoint PATCH /largepersongroups/{largePersonGroupId}/persons/{personId}
@required {largePersonGroupId: any, personId: any, body: map}
@returns(200)

@endpoint DELETE /largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
@required {largePersonGroupId: any, personId: any, persistedFaceId: any}
@returns(200)

@endpoint GET /largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
@required {largePersonGroupId: any, personId: any, persistedFaceId: any}
@returns(200)

@endpoint PATCH /largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}
@required {largePersonGroupId: any, personId: any, persistedFaceId: any, body: map}
@returns(200)

@endpoint PUT /largepersongroups/{largePersonGroupId}
@required {largePersonGroupId: any, body: map}
@returns(200)

@endpoint DELETE /largepersongroups/{largePersonGroupId}
@required {largePersonGroupId: any}
@returns(200)

@endpoint GET /largepersongroups/{largePersonGroupId}
@required {largePersonGroupId: any}
@optional {returnRecognitionModel: any}
@returns(200)

@endpoint PATCH /largepersongroups/{largePersonGroupId}
@required {largePersonGroupId: any, body: map}
@returns(200)

@endpoint GET /largepersongroups/{largePersonGroupId}/training
@required {largePersonGroupId: any}
@returns(200)

@endpoint GET /largepersongroups
@optional {start: any, top: any, returnRecognitionModel: any}
@returns(200)

@endpoint POST /largepersongroups/{largePersonGroupId}/train
@required {largePersonGroupId: any}
@returns(202)

@endpoint POST /largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces
@required {largePersonGroupId: any, personId: any}
@optional {userData: any, targetFace: any, detectionModel: any}
@returns(200)

@endgroup

@group largefacelists
@endpoint PUT /largefacelists/{largeFaceListId}
@required {largeFaceListId: any, body: map}
@returns(200)

@endpoint GET /largefacelists/{largeFaceListId}
@required {largeFaceListId: any}
@optional {returnRecognitionModel: any}
@returns(200)

@endpoint PATCH /largefacelists/{largeFaceListId}
@required {largeFaceListId: any, body: map}
@returns(200)

@endpoint DELETE /largefacelists/{largeFaceListId}
@required {largeFaceListId: any}
@returns(200)

@endpoint GET /largefacelists/{largeFaceListId}/training
@required {largeFaceListId: any}
@returns(200)

@endpoint GET /largefacelists
@optional {returnRecognitionModel: any, start: any, top: any}
@returns(200)

@endpoint POST /largefacelists/{largeFaceListId}/train
@required {largeFaceListId: any}
@returns(202)

@endpoint DELETE /largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}
@required {largeFaceListId: any, persistedFaceId: any}
@returns(200)

@endpoint GET /largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}
@required {largeFaceListId: any, persistedFaceId: any}
@returns(200)

@endpoint PATCH /largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}
@required {largeFaceListId: any, persistedFaceId: any, body: map}
@returns(200)

@endpoint POST /largefacelists/{largeFaceListId}/persistedfaces
@required {largeFaceListId: any}
@optional {userData: any, targetFace: any, detectionModel: any}
@returns(200)

@endpoint GET /largefacelists/{largeFaceListId}/persistedfaces
@required {largeFaceListId: any}
@optional {start: any, top: any}
@returns(200)

@endgroup

@group snapshots
@endpoint POST /snapshots
@required {body: map}
@returns(202)

@endpoint GET /snapshots
@optional {type: any, applyScope: any}
@returns(200)

@endpoint GET /snapshots/{snapshotId}
@required {snapshotId: any}
@returns(200)

@endpoint PATCH /snapshots/{snapshotId}
@required {snapshotId: any, body: map}
@returns(200)

@endpoint DELETE /snapshots/{snapshotId}
@required {snapshotId: any}
@returns(200)

@endpoint POST /snapshots/{snapshotId}/apply
@required {snapshotId: any, body: map}
@returns(202)

@endgroup

@group operations
@endpoint GET /operations/{operationId}
@required {operationId: any}
@returns(200)

@endgroup

@end