Sign in

v27

latestSwagger 2.0raw.githubusercontent.com2022-12-116362180.5 KB

List large face lists’ information of largeFaceListId, name, userData and recognitionModel. <br /> To get face information inside largeFaceList use LargeFaceList Face - Get<br />

  • Large face lists are stored in alphabetical order of largeFaceListId.
  • "start" parameter (string, optional) is a user-provided largeFaceListId value that returned entries have larger ids by string comparison. "start" set to empty to indicate return from the first item.
  • "top" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify "start" with the last returned entry’s Id of the current call. <br />

For example, total 5 large person lists: "list1", ..., "list5". <br /> "start=&top=" will return all 5 lists. <br /> "start=&top=2" will return "list1", "list2". <br /> "start=list2&top=3" will return "list3", "list4", "list5".

get/largefacelists

Query parameters

returnRecognitionModelboolean

A value indicating whether the operation should return 'recognitionModel' in response.

startstring

Starting large face list id to return (used to list a range of large face lists).

topinteger

Number of large face lists to return starting with the large face list id indicated by the 'start' parameter.

Response

A successful call returns an array of largeFaceList.

largeFaceListIdstring required

LargeFaceListId of the target large face list.

namestring required

User defined name, maximum length is 128.

userDatastring

User specified data. Length should not exceed 16KB.

recognitionModel'recognition_01' | 'recognition_02' | 'recognition_03' | 'recognition_04'

Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need.