Skip to content

Commit

Permalink
Generate and implement Face SDK via TypeSpec (#35384)
Browse files Browse the repository at this point in the history
* CodeGen from PR 27576 in Azure/azure-rest-api-specs
Merge 482ba279cb21fbf7f4e6bbd4ad14b6c14aa979d7 into b8af2fc3af08e42d2df6f48d1c84070ef1f6589b

* Fix SDK error

* SDK Customization

* test-resources.json

* Samples

* Testcases

* Add SDK README.md

* Rename the folder from samples/_shared to samples/shared

* Update the detection interface

* Correct the comments in sample codes

* Update the README.md

* Update the interface of detect_from_url()

* Removed TODO tag

* Update README.md

* Correct the path of the model object

* Refine liveness samples

* Reorganize samples and tests folder

  - Only use images under samples/images for test.
  - Move all async samples under samples folder to address relative
  import failure
  - Delete the folder 'tests/images'
  - Add two utility methods in helpers class.

* Add assets.json

* Update CHANGELOG and README

* Fix errors reported by CI pipeline

* Fix typo

* Fix tests error

* Update CHANGELOG and README

* Update customized operations

* Update tests to fix test errors

* Not support live tests for this preview release

* Use `black` to reformat all samples and tests

* Remove all ignore flag from samples

* Add pyproject.toml

* Regenerated code

* update patches

* fix samples

* Update CHANGELOG

* Regenerate SDK based on the latest TypeSpec

* Update customized method to address the TypeSpec changes

* Update customized Enum classes definition and remove ignore flags from samples

* Update README.md

* Fix pylint error

* Use the new name of AAD: 'Microsoft Entra ID'

* Change the order of overload functions of

* Re-format the code snippet in README.md

---------

Co-authored-by: SDKAuto <sdkautomation@microsoft.com>
  • Loading branch information
zihyunting and SDKAuto authored May 16, 2024
1 parent c9fa6e6 commit a87b4c0
Show file tree
Hide file tree
Showing 104 changed files with 51,699 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .vscode/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -1775,6 +1775,29 @@
"wday",
"SNOMED"
]
},
{
"filename": "sdk/face/azure-ai-vision-face/**",
"words": [
"mros",
"Nify",
"ctxt",
"wday",
"faceid",
"facelistid",
"largefacelistid",
"persongroupid",
"largepersongroupid",
"dynamicpersongroupid",
"personid",
"maxnumofcandidatesreturned"
]
},
{
"filename": "sdk/face/azure-ai-vision-face/tests/**",
"words": [
"dcid"
]
}
],
"allowCompoundWords": true
Expand Down
31 changes: 31 additions & 0 deletions sdk/face/azure-ai-vision-face/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Release History

## 1.0.0b1 (Unreleased)

This is the first preview of the `azure-ai-vision-face` client library that follows the [Azure Python SDK Design Guidelines](https://azure.github.io/azure-sdk/python_design.html).
This library replaces the package [azure-cognitiveservices-vision-face](https://pypi.org/project/azure-cognitiveservices-vision-face/).

This package's [documentation](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/) and [samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples) demonstrate the new API.

### Features Added

- Added support for Liveness detection.
- Added support for `person` and `dynamic_person_group` operations.
- Added support for face recognition with `PersonDirectory` (`identify_from_person_directory()` and `identify_from_dynamic_person_group()`).
- Asynchronous APIs are added under `azure.ai.vision.face.aio` namespace.
- Authentication with Microsoft Entra ID is supported using `DefaultAzureCredential()` from `azure.identity`.

### Breaking Changes

- This library supports only the Azure AI Face v1.1-preview.1 API.
- The namespace/package name for Azure AI Face has changed from `azure.cognitiveservices.vision.face` to `azure.ai.vision.face`.
- Three client design:
- `FaceClient` to perform core Face functions such as face detection, recognition(identification and verification),
finding similar faces and grouping faces.
- `FaceAdministrationClient` to managed the following data structures that hold data on faces and persons for
Face recognition, like `face_list`, `large_face_list`, `person_group`, `large_person_group`, `person` and
`dynamic_person_group`.
- `FaceSessionClient` to interact with sessions which is used for Liveness detection.
- New function names that comply with [Azure Python SDK Design Guidelines](https://azure.github.io/azure-sdk/python_design.html):
- For example, the method `person_group_person.create()` is changed to `create_person_group_person()`.
- The Snapshot operations are all removed as [the Snapshot API is no longer supported](https://azure.microsoft.com/updates/facelimitedaccess/).
21 changes: 21 additions & 0 deletions sdk/face/azure-ai-vision-face/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Copyright (c) Microsoft Corporation.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
8 changes: 8 additions & 0 deletions sdk/face/azure-ai-vision-face/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
include *.md
include LICENSE
include azure/ai/vision/face/py.typed
recursive-include tests *.py
recursive-include samples *.py *.md
include azure/__init__.py
include azure/ai/__init__.py
include azure/ai/vision/__init__.py
Loading

0 comments on commit a87b4c0

Please sign in to comment.