PersonGroup interface

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Package:

@azure/cognitiveservices-face

Person group object.

Extends

MetaDataContract

Properties

name	User defined name, maximum length is 128.
personGroupId	PersonGroupId of the target person group.
recognitionModel	Possible values include: 'recognition_01', 'recognition_02', 'recognition_03', 'recognition_04'. Default value: 'recognition_01'.
userData	User specified data. Length should not exceed 16KB.

Property Details

name

User defined name, maximum length is 128.

name: string

Property Value

string

personGroupId

PersonGroupId of the target person group.

personGroupId: string

Property Value

string

recognitionModel

Possible values include: 'recognition_01', 'recognition_02', 'recognition_03', 'recognition_04'. Default value: 'recognition_01'.

recognitionModel?: RecognitionModel

Property Value

RecognitionModel

userData

User specified data. Length should not exceed 16KB.

userData?: undefined | string

Property Value

undefined | string