Package version:

Interface AddLargeFaceListFaceFromUrl

interface AddLargeFaceListFaceFromUrl {
    get(options?): StreamableMethod<GetLargeFaceListFaces200Response | GetLargeFaceListFacesDefaultResponse>;
    post(options?): StreamableMethod<AddLargeFaceListFaceFromUrl200Response | AddLargeFaceListFaceFromUrlDefaultResponse>;
    post(options): StreamableMethod<AddLargeFaceListFace200Response | AddLargeFaceListFaceDefaultResponse>;
}

Methods

Methods

  • Faces are stored in alphabetical order of persistedFaceId created in "Add Large Face List Face".

      • "start" parameter (string, optional) specifies an ID value from which returned entries will have larger IDs based on string comparison. Setting "start" to an empty value indicates that entries should be returned starting from the first item.
      • "top" parameter (int, optional) determines the maximum number of entries to be returned, with a limit of up to 1000 entries per call. To retrieve additional entries beyond this limit, specify "start" with the personId of the last entry returned in the current call.

    [!TIP]

    • For example, there are total 5 items with their IDs: "itemId1", ..., "itemId5".
      • "start=&top=" will return all 5 items.
      • "start=&top=2" will return "itemId1", "itemId2".
      • "start=itemId2&top=3" will return "itemId3", "itemId4", "itemId5".

    Parameters

    • Optional options: any

    Returns StreamableMethod<GetLargeFaceListFaces200Response | GetLargeFaceListFacesDefaultResponse>

  • To deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature(s) will be stored on server until "Delete Large Face List Face" or "Delete Large Face List" is called.

    Note that persistedFaceId is different from faceId generated by "Detect".

      • Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
      • Each person entry can hold up to 248 faces.
      • JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
      • "targetFace" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided "targetFace" rectangle is not returned from "Detect", there's no guarantee to detect and add the face successfully.
      • Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
      • The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
      • Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model

    [!NOTE]

      • Free-tier subscription quota: 1,000 faces per Large Face List.
      • S0-tier subscription quota: 1,000,000 faces per Large Face List.

    Parameters

    • Optional options: any

    Returns StreamableMethod<AddLargeFaceListFaceFromUrl200Response | AddLargeFaceListFaceFromUrlDefaultResponse>

  • To deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature(s) will be stored on server until "Delete Large Face List Face" or "Delete Large Face List" is called.

    Note that persistedFaceId is different from faceId generated by "Detect".

      • Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
      • Each person entry can hold up to 248 faces.
      • JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
      • "targetFace" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided "targetFace" rectangle is not returned from "Detect", there's no guarantee to detect and add the face successfully.
      • Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
      • The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
      • Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model

    [!NOTE]

      • Free-tier subscription quota: 1,000 faces per Large Face List.
      • S0-tier subscription quota: 1,000,000 faces per Large Face List.

    Parameters

    • options: any

    Returns StreamableMethod<AddLargeFaceListFace200Response | AddLargeFaceListFaceDefaultResponse>