Skip to content

[FaceAPI] Add detection model parameter #6522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shahabhijeet merged 1 commit into from
Jun 24, 2019
Merged

[FaceAPI] Add detection model parameter #6522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 85 additions & 5 deletions sdk/cognitiveservices/Vision.Face/src/Generated/FaceListOperations.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1105,6 +1105,21 @@ public FaceListOperations(FaceClient client)
/// or large occlusions will cause failures.
/// * Adding/deleting faces to/from a same face list are processed sequentially
/// and to/from different face lists are in parallel.
/// * 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 [How to specify a detection
/// model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)
/// | Model | Recommended use-case(s) |
/// | ---------- | -------- |
/// | 'detection_01': | The default detection model for [FaceList - Add
/// Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250).
/// Recommend for near frontal face detection. For scenarios with exceptionally
/// large angle (head-pose) faces, occluded faces or wrong image orientation,
/// the faces in such cases may not be detected. |
/// | 'detection_02': | Detection model released in 2019 May with improved
/// accuracy especially on small, side and blurry faces. |
/// </summary>
/// <param name='faceListId'>
/// Id referencing a particular face list.
Expand All @@ -1123,6 +1138,14 @@ public FaceListOperations(FaceClient client)
/// targetFace is required to specify which face to add. No targetFace means
/// there is only one face detected in the entire image.
/// </param>
/// <param name='detectionModel'>
/// Name of detection model. Detection model is used to detect faces in the
/// submitted image. A detection model name can be provided when performing
/// Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add
/// Face. The default value is 'detection_01', if another model is needed,
/// please explicitly specify it. Possible values include: 'detection_01',
/// 'detection_02'
/// </param>
/// <param name='customHeaders'>
/// Headers that will be added to request.
/// </param>
Expand All @@ -1144,7 +1167,7 @@ public FaceListOperations(FaceClient client)
/// <return>
/// A response object containing the response body and response headers.
/// </return>
public async Task<HttpOperationResponse<PersistedFace>> AddFaceFromUrlWithHttpMessagesAsync(string faceListId, string url, string userData = default(string), IList<int> targetFace = default(IList<int>), Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))
public async Task<HttpOperationResponse<PersistedFace>> AddFaceFromUrlWithHttpMessagesAsync(string faceListId, string url, string userData = default(string), IList<int> targetFace = default(IList<int>), string detectionModel = default(string), Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (Client.Endpoint == null)
{
Expand Down Expand Up @@ -1191,6 +1214,7 @@ public FaceListOperations(FaceClient client)
tracingParameters.Add("faceListId", faceListId);
tracingParameters.Add("userData", userData);
tracingParameters.Add("targetFace", targetFace);
tracingParameters.Add("detectionModel", detectionModel);
tracingParameters.Add("imageUrl", imageUrl);
tracingParameters.Add("cancellationToken", cancellationToken);
ServiceClientTracing.Enter(_invocationId, this, "AddFaceFromUrl", tracingParameters);
Expand All @@ -1209,6 +1233,10 @@ public FaceListOperations(FaceClient client)
{
_queryParameters.Add(string.Format("targetFace={0}", System.Uri.EscapeDataString(string.Join(",", targetFace))));
}
if (detectionModel != null)
{
_queryParameters.Add(string.Format("detectionModel={0}", System.Uri.EscapeDataString(detectionModel)));
}
if (_queryParameters.Count > 0)
{
_url += "?" + string.Join("&", _queryParameters);
Expand Down Expand Up @@ -1320,9 +1348,48 @@ public FaceListOperations(FaceClient client)
}

/// <summary>
/// Add a face to a face list. The input face is specified as an image with a
/// targetFace rectangle. It returns a persistedFaceId representing the added
/// face, and persistedFaceId will not expire.
/// Add a face to a specified face list, up to 1,000 faces.
/// &lt;br /&gt; To deal with an image contains 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 will be stored on server until [FaceList -
/// Delete
/// Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251)
/// or [FaceList -
/// Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f)
/// is called.
/// &lt;br /&gt; Note persistedFaceId is different from faceId generated by
/// [Face -
/// Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
/// * Higher face image quality means better detection and recognition
/// precision. Please consider high-quality faces: frontal, clear, and face
/// size is 200x200 pixels (100 pixels between eyes) or bigger.
/// * 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 [Face -
/// Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
/// 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.
/// * Adding/deleting faces to/from a same face list are processed sequentially
/// and to/from different face lists are in parallel.
/// * 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 [How to specify a detection
/// model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)
/// | Model | Recommended use-case(s) |
/// | ---------- | -------- |
/// | 'detection_01': | The default detection model for [FaceList - Add
/// Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250).
/// Recommend for near frontal face detection. For scenarios with exceptionally
/// large angle (head-pose) faces, occluded faces or wrong image orientation,
/// the faces in such cases may not be detected. |
/// | 'detection_02': | Detection model released in 2019 May with improved
/// accuracy especially on small, side and blurry faces. |
/// </summary>
/// <param name='faceListId'>
/// Id referencing a particular face list.
Expand All @@ -1341,6 +1408,14 @@ public FaceListOperations(FaceClient client)
/// targetFace is required to specify which face to add. No targetFace means
/// there is only one face detected in the entire image.
/// </param>
/// <param name='detectionModel'>
/// Name of detection model. Detection model is used to detect faces in the
/// submitted image. A detection model name can be provided when performing
/// Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add
/// Face. The default value is 'detection_01', if another model is needed,
/// please explicitly specify it. Possible values include: 'detection_01',
/// 'detection_02'
/// </param>
/// <param name='customHeaders'>
/// Headers that will be added to request.
/// </param>
Expand All @@ -1362,7 +1437,7 @@ public FaceListOperations(FaceClient client)
/// <return>
/// A response object containing the response body and response headers.
/// </return>
public async Task<HttpOperationResponse<PersistedFace>> AddFaceFromStreamWithHttpMessagesAsync(string faceListId, Stream image, string userData = default(string), IList<int> targetFace = default(IList<int>), Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))
public async Task<HttpOperationResponse<PersistedFace>> AddFaceFromStreamWithHttpMessagesAsync(string faceListId, Stream image, string userData = default(string), IList<int> targetFace = default(IList<int>), string detectionModel = default(string), Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (Client.Endpoint == null)
{
Expand Down Expand Up @@ -1405,6 +1480,7 @@ public FaceListOperations(FaceClient client)
tracingParameters.Add("userData", userData);
tracingParameters.Add("targetFace", targetFace);
tracingParameters.Add("image", image);
tracingParameters.Add("detectionModel", detectionModel);
tracingParameters.Add("cancellationToken", cancellationToken);
ServiceClientTracing.Enter(_invocationId, this, "AddFaceFromStream", tracingParameters);
}
Expand All @@ -1422,6 +1498,10 @@ public FaceListOperations(FaceClient client)
{
_queryParameters.Add(string.Format("targetFace={0}", System.Uri.EscapeDataString(string.Join(",", targetFace))));
}
if (detectionModel != null)
{
_queryParameters.Add(string.Format("detectionModel={0}", System.Uri.EscapeDataString(detectionModel)));
}
if (_queryParameters.Count > 0)
{
_url += "?" + string.Join("&", _queryParameters);
Expand Down
Loading