Package version:

interface CreatePersonGroup {
    delete(options?): StreamableMethod<DeletePersonGroup200Response | DeletePersonGroupDefaultResponse>;
    get(options?): StreamableMethod<GetPersonGroup200Response | GetPersonGroupDefaultResponse>;
    patch(options?): StreamableMethod<UpdatePersonGroup200Response | UpdatePersonGroupDefaultResponse>;
    put(options?): StreamableMethod<CreatePersonGroup200Response | CreatePersonGroupDefaultResponse>;
}

Methods

  • A Person Group is a container holding the uploaded person data, including face recognition features.

    After creation, use "Create Person Group Person" to add persons into the group, and then call "Train Person Group" to get this group ready for "Identify From Person Group".

    No image will be stored. Only the person's extracted face feature(s) and userData will be stored on server until "Delete Person Group Person" or "Delete Person Group" is called.

    'recognitionModel' should be specified to associate with this Person Group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing Person Group will use the recognition model that's already associated with the collection. Existing face feature(s) in a Person Group can't be updated to features extracted by another version of recognition model.

    [!NOTE]

      • Free-tier subscription quota: 1,000 Person Groups. Each holds up to 1,000 persons.
      • S0-tier subscription quota: 1,000,000 Person Groups. Each holds up to 10,000 persons.
      • to handle larger scale face identification problem, please consider using Large Person Group.

    Parameters

    • Optional options: any

    Returns StreamableMethod<CreatePersonGroup200Response | CreatePersonGroupDefaultResponse>