Package version:

Interface IdentifyFromPersonGroup

Methods

Methods

  • For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the Person Group (given by personGroupId), and return candidate person(s) for that face ranked by similarity confidence. The Person Group should be trained to make it ready for identification. See more in "Train Person Group".

    [!NOTE]

      • The algorithm allows more than one face to be identified independently at the same request, but no more than 10 faces.
      • Each person could have more than one face, but no more than 248 faces.
      • Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
      • Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the returned candidates will be an empty array.
      • Try "Find Similar" when you need to find similar faces from a Face List/Large Face List instead of a Person Group.
      • The 'recognitionModel' associated with the query faces' faceIds should be the same as the 'recognitionModel' used by the target Person Group.

    Parameters

    • Optional options: any

    Returns StreamableMethod<IdentifyFromPersonGroup200Response | IdentifyFromPersonGroupDefaultResponse>

  • For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the Large Person Group (given by largePersonGroupId), and return candidate person(s) for that face ranked by similarity confidence. The Large Person Group should be trained to make it ready for identification. See more in "Train Large Person Group".

    [!NOTE]

      • The algorithm allows more than one face to be identified independently at the same request, but no more than 10 faces.
      • Each person could have more than one face, but no more than 248 faces.
      • Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
      • Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the returned candidates will be an empty array.
      • Try "Find Similar" when you need to find similar faces from a Face List/Large Face List instead of a Person Group/Large Person Group.
      • The 'recognitionModel' associated with the query faces' faceIds should be the same as the 'recognitionModel' used by the target Person Group or Large Person Group.

    Parameters

    • Optional options: any

    Returns StreamableMethod<IdentifyFromLargePersonGroup200Response | IdentifyFromLargePersonGroupDefaultResponse>

  • For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the Person Directory Persons (given by personIds), and return candidate person(s) for that face ranked by similarity confidence. Passing personIds with an array with one element "*" can perform the operation over entire person directory.

    [!NOTE]

      • The algorithm allows more than one face to be identified independently at the same request, but no more than 10 faces.
      • Each person could have more than one face, but no more than 248 faces.
      • Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
      • Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the returned candidates will be an empty array.
      • The Identify operation can only match faces obtained with the same recognition model, that is associated with the query faces.

    Parameters

    • Optional options: any

    Returns StreamableMethod<IdentifyFromPersonDirectory200Response | IdentifyFromPersonDirectoryDefaultResponse>

  • For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the Dynamic Person Group (given by dynamicPersonGroupId), and return candidate person(s) for that face ranked by similarity confidence.

    [!NOTE]

      • The algorithm allows more than one face to be identified independently at the same request, but no more than 10 faces.
      • Each person could have more than one face, but no more than 248 faces.
      • Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
      • Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the returned candidates will be an empty array.
      • The Identify operation can only match faces obtained with the same recognition model, that is associated with the query faces.

    Parameters

    • Optional options: any

    Returns StreamableMethod<IdentifyFromDynamicPersonGroup200Response | IdentifyFromDynamicPersonGroupDefaultResponse>