Skip to content

Commit 9f55143

Browse files
authored
Prepare for Face SDK release (Azure#44153)
* Update codegen * Correct sample and customization * Remove not supported operation from README * Update to latest spec * Add back assert for detect customization * Update 1.0.0-beta.1 release date * Remove empty block in changelog
1 parent ed4a20a commit 9f55143

File tree

124 files changed

+336
-38544
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+336
-38544
lines changed
Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release History
22

3-
## 1.0.0-beta.1 (Unreleased)
3+
## 1.0.0-beta.1 (2024-05-24)
44

55
This is the first preview Azure AI Face client library that follows the [.NET Azure SDK Design Guidelines](https://azure.github.io/azure-sdk/dotnet_introduction.html).
66
This library replaces the package [Microsoft.Azure.CognitiveServices.Vision.Face](https://www.nuget.org/packages/Microsoft.Azure.CognitiveServices.Vision.Face).
@@ -10,16 +10,9 @@ This package's [documentation](https://github.com/Azure/azure-sdk-for-net/tree/m
1010
- This library supports only the Azure AI Face v1.1-preview.1 API.
1111
- The namespace/package name for Azure AI Face has changed from `Microsoft.Azure.CognitiveServices.Vision.Face` to `Azure.AI.Vision.Face`.
1212
- Three client design:
13-
- `FaceClient` to perform core Face functions such as face detection, recognition(identification and verification), finding similar faces and grouping faces.
14-
- `FaceAdministrationClient` to managed the following data structures that hold data on faces and persons for Face recognition.
13+
- `FaceClient` to perform core Face functions such as face detection, verification, finding similar faces and grouping faces.
1514
- `FaceSessionClient` to interact with sessions which is used for Liveness detection.
1615

1716
### Features Added
1817

1918
- Added support for Liveness detection.
20-
21-
### Breaking Changes
22-
23-
### Bugs Fixed
24-
25-
### Other Changes

sdk/face/Azure.AI.Vision.Face/README.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ Use the client library for to:
88
- Liveness detection
99
- Face recognition
1010
- Face verification ("one-to-one" matching)
11-
- Face identification ("one-to-many" matching)
1211
- Find similar faces
1312
- Group faces
1413

@@ -108,21 +107,10 @@ var client = new FaceClient(endpoint, credential);
108107

109108
- Face detection and analysis: Detect human faces in an image and return the rectangle coordinates of their locations, and optionally with landmarks, and face-related attributes. This operation is required as a first step in all the other face recognition scenarios.
110109
- Face recognition: Confirm that a user is who they claim to be based on how closely their face data matches the target face.
111-
It includes Face verification ("one-to-one" matching) and Face identification ("one-to-many" matching).
110+
Support Face verification ("one-to-one" matching).
112111
- Finding similar faces from a smaller set of faces that look similar to the target face.
113112
- Grouping faces into several smaller groups based on similarity.
114113

115-
### FaceAdministrationClient
116-
117-
`FaceAdministrationClient` is provided to interact with the following data structures that hold data on faces and
118-
persons for Face recognition:
119-
120-
- PersonDirectory
121-
- FaceList
122-
- LargeFaceList
123-
- PersonGroup
124-
- LargePersonGroup
125-
126114
### FaceSessionClient
127115

128116
`FaceSessionClient` is provided to interact with sessions which is used for Liveness detection.
@@ -278,7 +266,7 @@ For example, if you submit a image with an invalid `Uri`, a `400` error is retur
278266
```C# Snippet:DetectFacesInvalidUrl
279267
var invalidUri = new Uri("http://invalid.uri");
280268
try {
281-
var detectResponse = client.DetectFromUrl(
269+
var detectResponse = client.Detect(
282270
invalidUri,
283271
FaceDetectionModel.Detection01,
284272
FaceRecognitionModel.Recognition04,
@@ -373,8 +361,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
373361
[face_sample_detection]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/samples/Sample1_FaceDetection.md
374362
[liveness_tutorial]: https://learn.microsoft.com/azure/ai-services/computer-vision/tutorials/liveness
375363
[integrate_liveness_into_mobile_application]: https://learn.microsoft.com/azure/ai-services/computer-vision/tutorials/liveness#integrate-liveness-into-mobile-application
376-
[face_sample_liveness_session]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/samples/Sample3_DetectLivenessWithSession.md
377-
[face_sample_liveness_with_verify_session]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/samples/Sample4_DetectLivenessWithVerifyWithSession.md
364+
[face_sample_liveness_session]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/samples/Sample2_DetectLivenessWithSession.md
365+
[face_sample_liveness_with_verify_session]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/samples/Sample3_DetectLivenessWithVerifyWithSession.md
378366

379367
[logging]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/core/Azure.Core/samples/Diagnostics.md
380368

sdk/face/Azure.AI.Vision.Face/samples/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,5 @@ Azure AI Vision Face is a cloud service that gives you access to advanced algor
1515
- Detect faces from image [synchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample1_FaceDetection.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample1_FaceDetectionAsync.cs)
1616
- From local image file
1717
- From URL
18-
- Verification and identification from Large Person Group [synchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample2_LargePersonGroup.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample2_LargePersonGroupAsync.cs)
19-
- Detect liveness in faces with session [synchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample3_DetectLivenessWithSession.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample3_DetectLivenessWithSessionAsync.cs)
20-
- Detect liveness with face verification with session [synchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample4_DetectLivenessWithVerifyWithSession.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample4_DetectLivenessWithVerifyWithSessionAsync.cs)
18+
- Detect liveness in faces with session [synchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample2_DetectLivenessWithSession.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample2_DetectLivenessWithSessionAsync.cs)
19+
- Detect liveness with face verification with session [synchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample3_DetectLivenessWithVerifyWithSession.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/face/Azure.AI.Vision.Face/tests/samples/Sample3_DetectLivenessWithVerifyWithSessionAsync.cs)

sdk/face/Azure.AI.Vision.Face/samples/Sample1_FaceDetection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ foreach (var detectedFace in detectedFaces)
7979
You can also detect faces from an image URL. The following code demonstrates how to detect faces from an image URL.
8080

8181
```C# Snippet:DetectFacesFromUrl
82-
var detectResponse = client.DetectFromUrl(
82+
var detectResponse = client.Detect(
8383
imageUri,
8484
FaceDetectionModel.Detection01,
8585
FaceRecognitionModel.Recognition04,

sdk/face/Azure.AI.Vision.Face/samples/Sample1_FaceDetectionAsync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ foreach (var detectedFace in detectedFaces)
7979
You can also detect faces from an image URL. The following code demonstrates how to detect faces from an image URL.
8080

8181
```C# Snippet:DetectFacesFromUrlAsync
82-
var detectResponse = await client.DetectFromUrlAsync(
82+
var detectResponse = await client.DetectAsync(
8383
imageUri,
8484
FaceDetectionModel.Detection01,
8585
FaceRecognitionModel.Recognition04,

sdk/face/Azure.AI.Vision.Face/samples/Sample2_LargePersonGroup.md

Lines changed: 0 additions & 85 deletions
This file was deleted.

sdk/face/Azure.AI.Vision.Face/samples/Sample2_LargePersonGroupAsync.md

Lines changed: 0 additions & 85 deletions
This file was deleted.

0 commit comments

Comments
 (0)