EOIAddFacerecPersonInputs
eyesonit-typescript-sdk / EOIAddFacerecPersonInputs
Class: EOIAddFacerecPersonInputs
Request payload for creating a face recognition person profile.
Constructors
Constructor
new EOIAddFacerecPersonInputs(
person_id,person_display_name,person_groups):EOIAddFacerecPersonInputs
Parameters
person_id
string
Stable person identifier used in API operations. Minimum length: 2.
person_display_name
string
Display name shown to users. Minimum length: 2.
person_groups
string[]
Face recognition group IDs to associate with this person.
Returns
EOIAddFacerecPersonInputs
Properties
person_images
person_images:
EOIAddFacerecPersonImage[] =[]
Images associated with the person profile. At least one valid image or file path is required.
person_id
person_id:
string
Stable person identifier used in API operations. Minimum length: 2.
person_display_name
person_display_name:
string
Display name shown to users. Minimum length: 2.
person_groups
person_groups:
string[]
Face recognition group IDs to associate with this person.
Methods
fromJsonObj()
staticfromJsonObj(obj):EOIAddFacerecPersonInputs|null
Parameters
obj
any
Returns
EOIAddFacerecPersonInputs | null
addImageBase64()
addImageBase64(
image,file_path):void
Adds a base64 image entry and sets capture_time to the current timestamp.
Parameters
image
string
Base64-encoded image data.
file_path
string
Optional file path associated with this image.
Returns
void
Example
`inputs.addImageBase64(base64Jpeg, "C:\\images\\person.jpg")`
validate()
validate():
EOIResponse
Validates this payload against SDK-side constraints.