Skip to content

Commit

Permalink
.NET SDK Resource Provider:'Face'
Browse files Browse the repository at this point in the history 
REST Spec PR 'Azure/azure-rest-api-specs#5722'
REST Spec PR Author 'lebronJ'
REST Spec PR Last commit
  • Loading branch information
@adxsdknet
adxsdknet committed Apr 21, 2019
1 parent b1703de commit 1d85364
Show file tree
Hide file tree
Showing 23 changed files with 788 additions and 263 deletions.
63 changes: 47 additions & 16 deletions src/SDKs/CognitiveServices/dataPlane/Vision/Face/Face/Generated/FaceListOperations.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ public FaceListOperations(FaceClient client)
/// Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
/// <br /> After creation, user should use [FaceList - Add
/// Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250)
/// to import the faces. Faces are stored on server until [FaceList -
/// to import the faces. No image will be stored. Only the extracted face
/// features are stored on server until [FaceList -
/// Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f)
/// is called.
/// <br /> Find Similar is used for scenario like finding celebrity-like
Expand All @@ -73,14 +74,20 @@ public FaceListOperations(FaceClient client)
/// <br /> Please consider
/// [LargeFaceList](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc)
/// when the face number is large. It can support up to 1,000,000 faces.
/// 'recognitionModel' should be specified to associate with this face list.
/// 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 face list will use the
/// recognition model that's already associated with the collection. Existing
/// face features in a face list can't be updated to features extracted by
/// another version of recognition model.
///
/// <br />'recognitionModel' should be specified to associate with this
/// face list. 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 face list will use
/// the recognition model that's already associated with the collection.
/// Existing face features in a face list can't be updated to features
/// extracted by another version of recognition model.
/// * 'recognition_01': The default recognition model for [FaceList-
/// Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b).
/// All those face lists created before 2019 March are bonded with this
/// recognition model.
/// * 'recognition_02': Recognition model released in 2019 March.
/// 'recognition_02' is recommended since its overall accuracy is improved
/// compared with 'recognition_01'.
/// </summary>
/// <param name='faceListId'>
/// Id referencing a particular face list.
Expand Down Expand Up @@ -616,8 +623,7 @@ public FaceListOperations(FaceClient client)
}

/// <summary>
/// Delete an existing face list according to faceListId. Persisted face images
/// in the face list will also be deleted.
/// Delete a specified face list.
/// </summary>
/// <param name='faceListId'>
/// Id referencing a particular face list.
Expand Down Expand Up @@ -922,8 +928,9 @@ public FaceListOperations(FaceClient client)
}

/// <summary>
/// Delete an existing face from a face list (given by a persistedFaceId and a
/// faceListId). Persisted image related to the face will also be deleted.
/// Delete a face from a face list by specified faceListId and persistedFaceId.
/// &lt;br /&gt; Adding/deleting faces to/from a same face list are processed
/// sequentially and to/from different face lists are in parallel.
/// </summary>
/// <param name='faceListId'>
/// Id referencing a particular face list.
Expand Down Expand Up @@ -1071,9 +1078,33 @@ 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.
/// </summary>
/// <param name='faceListId'>
/// Id referencing a particular face list.
Expand Down
63 changes: 47 additions & 16 deletions ...Ks/CognitiveServices/dataPlane/Vision/Face/Face/Generated/FaceListOperationsExtensions.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ public static partial class FaceListOperationsExtensions
/// Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
/// &lt;br /&gt; After creation, user should use [FaceList - Add
/// Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250)
/// to import the faces. Faces are stored on server until [FaceList -
/// to import the faces. No image will be stored. Only the extracted face
/// features are stored on server until [FaceList -
/// Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f)
/// is called.
/// &lt;br /&gt; Find Similar is used for scenario like finding celebrity-like
Expand All @@ -45,14 +46,20 @@ public static partial class FaceListOperationsExtensions
/// &lt;br /&gt; Please consider
/// [LargeFaceList](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc)
/// when the face number is large. It can support up to 1,000,000 faces.
/// 'recognitionModel' should be specified to associate with this face list.
/// 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 face list will use the
/// recognition model that's already associated with the collection. Existing
/// face features in a face list can't be updated to features extracted by
/// another version of recognition model.
///
/// &lt;br /&gt;'recognitionModel' should be specified to associate with this
/// face list. 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 face list will use
/// the recognition model that's already associated with the collection.
/// Existing face features in a face list can't be updated to features
/// extracted by another version of recognition model.
/// * 'recognition_01': The default recognition model for [FaceList-
/// Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b).
/// All those face lists created before 2019 March are bonded with this
/// recognition model.
/// * 'recognition_02': Recognition model released in 2019 March.
/// 'recognition_02' is recommended since its overall accuracy is improved
/// compared with 'recognition_01'.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
Expand Down Expand Up @@ -127,8 +134,7 @@ public static partial class FaceListOperationsExtensions
}

/// <summary>
/// Delete an existing face list according to faceListId. Persisted face images
/// in the face list will also be deleted.
/// Delete a specified face list.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
Expand Down Expand Up @@ -170,8 +176,9 @@ public static partial class FaceListOperationsExtensions
}

/// <summary>
/// Delete an existing face from a face list (given by a persistedFaceId and a
/// faceListId). Persisted image related to the face will also be deleted.
/// Delete a face from a face list by specified faceListId and persistedFaceId.
/// &lt;br /&gt; Adding/deleting faces to/from a same face list are processed
/// sequentially and to/from different face lists are in parallel.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
Expand All @@ -191,9 +198,33 @@ public static partial class FaceListOperationsExtensions
}

/// <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.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
Expand Down
6 changes: 2 additions & 4 deletions src/SDKs/CognitiveServices/dataPlane/Vision/Face/Face/Generated/FaceOperations.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -921,7 +921,7 @@ public FaceOperations(FaceClient client)
/// * Optional parameters including faceId, landmarks, and attributes.
/// Attributes include age, gender, headPose, smile, facialHair, glasses,
/// emotion, hair, makeup, occlusion, accessories, blur, exposure and noise.
/// * The extracted face feature, instead of the actual image, will be stored
/// * No image will be stored. Only the extracted face feature will be stored
/// on server. The faceId is an identifier of the face feature and will be used
/// in [Face -
/// Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239),
Expand All @@ -945,8 +945,7 @@ public FaceOperations(FaceClient client)
/// or being occluded, or wrong image orientation.
/// * Attributes (age, gender, headPose, smile, facialHair, glasses, emotion,
/// hair, makeup, occlusion, accessories, blur, exposure and noise) may not be
/// perfectly accurate. HeadPose's pitch value is a reserved field and will
/// always return 0.
/// perfectly accurate.
/// * Different 'recognitionModel' values are provided. If follow-up operations
/// like Verify, Identify, Find Similar are needed, please specify the
/// recognition model with 'recognitionModel' parameter. The default value for
Expand All @@ -955,7 +954,6 @@ public FaceOperations(FaceClient client)
/// the detected faceIds will be associated with the specified recognition
/// model. More details, please refer to [How to specify a recognition
/// model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)
///
/// </summary>
/// <param name='url'>
/// Publicly reachable URL of an image
Expand Down
6 changes: 2 additions & 4 deletions src/SDKs/CognitiveServices/dataPlane/Vision/Face/Face/Generated/FaceOperationsExtensions.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ public static partial class FaceOperationsExtensions
/// * Optional parameters including faceId, landmarks, and attributes.
/// Attributes include age, gender, headPose, smile, facialHair, glasses,
/// emotion, hair, makeup, occlusion, accessories, blur, exposure and noise.
/// * The extracted face feature, instead of the actual image, will be stored
/// * No image will be stored. Only the extracted face feature will be stored
/// on server. The faceId is an identifier of the face feature and will be used
/// in [Face -
/// Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239),
Expand All @@ -265,8 +265,7 @@ public static partial class FaceOperationsExtensions
/// or being occluded, or wrong image orientation.
/// * Attributes (age, gender, headPose, smile, facialHair, glasses, emotion,
/// hair, makeup, occlusion, accessories, blur, exposure and noise) may not be
/// perfectly accurate. HeadPose's pitch value is a reserved field and will
/// always return 0.
/// perfectly accurate.
/// * Different 'recognitionModel' values are provided. If follow-up operations
/// like Verify, Identify, Find Similar are needed, please specify the
/// recognition model with 'recognitionModel' parameter. The default value for
Expand All @@ -275,7 +274,6 @@ public static partial class FaceOperationsExtensions
/// the detected faceIds will be associated with the specified recognition
/// model. More details, please refer to [How to specify a recognition
/// model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)
///
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
Expand Down
Loading

0 comments on commit 1d85364

Please sign in to comment.