Share via

Large Person Group - List

Service:
Azure AI Services
API Version:
1.0-preview

List all existing large person groups’ largePersonGroupId, name, userData and recognitionModel.

  • Large person groups are stored in alphabetical order of largePersonGroupId.
  • "start" parameter (string, optional) is a user-provided largePersonGroupId 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.
    For example, total 5 large person groups: "group1", ..., "group5".
    "start=&top=" will return all 5 groups.
    "start=&top=2" will return "group1", "group2".
    "start=group2&top=3" will return "group3", "group4", "group5".
GET {Endpoint}/face/v1.0-preview/largepersongroups
With optional parameters: 
GET {Endpoint}/face/v1.0-preview/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
returnRecognitionModel
 query

boolean

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

string

maxLength: 64

List large person groups from the least largePersonGroupId greater than the "start".
top
 query

integer

minimum: 1
maximum: 1000

The number of large person groups to list.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Responses

Name Type Description
200 OK

LargePersonGroup[]

A successful call returns an array of large person groups and their information.
Other Status Codes

APIError

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

List large person groups example

Sample request

GET {Endpoint}/face/v1.0-preview/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True

Sample response

Status code:
200 
[
  {
    "largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
    "name": "large-person-group-name1",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  },
  {
    "largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
    "name": "large-person-group-name2",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  }
]

Definitions

Name Description
APIError

Error information returned by the API
Error

Error body.
LargePersonGroup

Large person group object.
RecognitionModel

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.

APIError

Object

Error information returned by the API

Name Type Description
error

Error

Error body.

Error

Object

Error body.

Name Type Description
code

string

message

string

LargePersonGroup

Object

Large person group object.

Name Type Default value Description
largePersonGroupId

string

maxLength: 64
pattern: ^[a-z0-9-_]+$

LargePersonGroupId of the target large person groups
name

string

minLength: 1
maxLength: 128

User defined name, maximum length is 128.
recognitionModel

RecognitionModel

recognition_01

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.
userData

string

maxLength: 16384

User specified data. Length should not exceed 16KB.

RecognitionModel

Enumeration

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.

Value Description
recognition_01
recognition_02
recognition_03
recognition_04