@azure-rest/ai-vision-face 1.0.0-alpha.20250205.1 → 1.0.0-alpha.20250207.1

package/README.md

@@ -90,17 +90,13 @@ You will also need to [register a new Microsoft Entra ID application and grant a
 Once completed, set the values of the client ID, tenant ID, and client secret of the Microsoft Entra ID application as environment variables:
 `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
 
-```js
-/**
- * DefaultAzureCredential will use the values from these environment
- * variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
- */
+```ts snippet:ReadmeSampleCreateClient_Entra
 import { DefaultAzureCredential } from "@azure/identity";
-import createFaceClient from "@azure-rest/ai-vision-face";
+import FaceClient from "@azure-rest/ai-vision-face";
 
 const endpoint = process.env["FACE_ENDPOINT"] || "<endpoint>";
 const credential = new DefaultAzureCredential();
-const client = createFaceClient(endpoint, credential);
+const client = FaceClient(endpoint, credential);
 ```
 
 #### Create the client with AzureKeyCredential
@@ -113,14 +109,14 @@ You can get the API key for your Face resource using the [Azure Portal](https://
 az cognitiveservices account keys list --name "<resource-name>" --resource-group "<resource-group-name>"
 ```
 
-```js
+```ts snippet:ReadmeSampleCreateClient_KeyCredential
 import { AzureKeyCredential } from "@azure/core-auth";
-import createFaceClient from "@azure-rest/ai-vision-face";
+import FaceClient from "@azure-rest/ai-vision-face";
 
 const endpoint = process.env["FACE_ENDPOINT"] || "<endpoint>";
 const apikey = process.env["FACE_APIKEY"] || "<apikey>";
 const credential = new AzureKeyCredential(apikey);
-const client = createFaceClient(endpoint, credential);
+const client = FaceClient(endpoint, credential);
 ```
 
 ## Key concepts
@@ -162,16 +158,14 @@ The following section provides several code snippets covering some of the most c
 
 Detect faces and analyze them from an binary data.
 
-```js
-import { readFileSync } from "fs";
-import { AzureKeyCredential } from "@azure/core-auth";
-
-import createFaceClient, { isUnexpected } from "@azure-rest/ai-vision-face";
+```ts snippet:ReadmeSampleFaceDetection
+import { DefaultAzureCredential } from "@azure/identity";
+import FaceClient, { isUnexpected } from "@azure-rest/ai-vision-face";
+import { readFileSync } from "node:fs";
 
 const endpoint = process.env["FACE_ENDPOINT"] || "<endpoint>";
-const apikey = process.env["FACE_APIKEY"] || "<apikey>";
-const credential = new AzureKeyCredential(apikey);
-const client = createFaceClient(endpoint, credential);
+const credential = new DefaultAzureCredential();
+const client = FaceClient(endpoint, credential);
 
 const response = await client.path("/detect").post({
   contentType: "application/octet-stream",
@@ -186,9 +180,11 @@ const response = await client.path("/detect").post({
   },
   body: readFileSync("path/to/test/image"),
 });
+
 if (isUnexpected(response)) {
   throw new Error(response.body.error.message);
 }
+
 console.log(response.body);
 ```
 
@@ -198,16 +194,14 @@ Identify a face against a defined LargePersonGroup.
 
 First, we have to create a LargePersonGroup, add a few Persons to it, and then register faces with these Persons.
 
-```js
-import { readFileSync } from "fs";
-import { AzureKeyCredential } from "@azure/core-auth";
-
-import createFaceClient, { getLongRunningPoller, isUnexpected } from "@azure-rest/ai-vision-face";
+```ts snippet:ReadmeSampleFaceRecognitionFromLargePersonGroup
+import { DefaultAzureCredential } from "@azure/identity";
+import FaceClient, { isUnexpected } from "@azure-rest/ai-vision-face";
+import { readFileSync } from "node:fs";
 
 const endpoint = process.env["FACE_ENDPOINT"] || "<endpoint>";
-const apikey = process.env["FACE_APIKEY"] || "<apikey>";
-const credential = new AzureKeyCredential(apikey);
-const client = createFaceClient(endpoint, credential);
+const credential = new DefaultAzureCredential();
+const client = FaceClient(endpoint, credential);
 
 const largePersonGroupId = "lpg_family";
 
@@ -230,9 +224,11 @@ const createLargePersonGroupPersonResponse_bill = await client
       userData: "Dad",
     },
   });
+
 if (isUnexpected(createLargePersonGroupPersonResponse_bill)) {
   throw new Error(createLargePersonGroupPersonResponse_bill.body.error.message);
 }
+
 const personId_bill = createLargePersonGroupPersonResponse_bill.body.personId;
 await client
   .path(
@@ -258,9 +254,11 @@ const createLargePersonGroupPersonResponse_clare = await client
       userData: "Mom",
     },
   });
+
 if (isUnexpected(createLargePersonGroupPersonResponse_clare)) {
   throw new Error(createLargePersonGroupPersonResponse_clare.body.error.message);
 }
+
 const personId_clare = createLargePersonGroupPersonResponse_clare.body.personId;
 await client
   .path(
@@ -280,47 +278,79 @@ await client
 
 Before doing the identification, we must train the LargePersonGroup first.
 
-```js
+```ts snippet:ReadmeSampleFaceRecognitionFromLargePersonGroup_Train
+import { DefaultAzureCredential } from "@azure/identity";
+import FaceClient, { getLongRunningPoller } from "@azure-rest/ai-vision-face";
+
+const endpoint = process.env["FACE_ENDPOINT"] || "<endpoint>";
+const credential = new DefaultAzureCredential();
+const client = FaceClient(endpoint, credential);
+
+const largePersonGroupId = "lpg_family";
+
 console.log(`Start to train the large person group: ${largePersonGroupId}`);
 const trainResponse = await client
   .path("/largepersongroups/{largePersonGroupId}/train", largePersonGroupId)
   .post();
 const trainPoller = await getLongRunningPoller(client, trainResponse);
 await trainPoller.pollUntilDone();
-// Check if poller.getOperationState().status is 'succeeded'.
 ```
 
 When the training operation is completed successfully, we can identify the faces in this LargePersonGroup throught.
 
-```js
-console.log('Detect faces from the target image.');
-const detectResponse = await client.path('/detect').post({
-    contentType: 'application/octet-stream',
-    queryParameters: {
-        detectionModel: 'detection_03',
-        recognitionModel: 'recognition_04',
-        returnFaceId: true,
-    },
-    body: readFileSync('path/to/target/image'),
+```ts snippet:ReadmeSampleFaceRecognitionFromLargePersonGroup_Identify
+import { DefaultAzureCredential } from "@azure/identity";
+import FaceClient, { isUnexpected } from "@azure-rest/ai-vision-face";
+import { readFileSync } from "node:fs";
+
+const endpoint = process.env["FACE_ENDPOINT"] || "<endpoint>";
+const credential = new DefaultAzureCredential();
+const client = FaceClient(endpoint, credential);
+
+const largePersonGroupId = "lpg_family";
+
+console.log("Detect faces from the target image.");
+const detectResponse = await client.path("/detect").post({
+  contentType: "application/octet-stream",
+  queryParameters: {
+    detectionModel: "detection_03",
+    recognitionModel: "recognition_04",
+    returnFaceId: true,
+  },
+  body: readFileSync("path/to/target/image"),
 });
+
 if (isUnexpected(detectResponse)) {
-    throw new Error(detectResponse.body.error.message);
+  throw new Error(detectResponse.body.error.message);
 }
-const faceIds = detectResponse.body.map(face => face.faceId as string)
 
-console.log('Identify the faces in the large person group.');
-const identifyResponse = await client.path('/identify').post({
-    body: { faceIds, largePersonGroupId },
+const faceIds = detectResponse.body.map((face) => face.faceId as string);
+
+console.log("Identify the faces in the large person group.");
+
+const identifyResponse = await client.path("/identify").post({
+  body: { faceIds, largePersonGroupId },
 });
+
 if (isUnexpected(identifyResponse)) {
-    throw new Error(identifyResponse.body.error.message);
+  throw new Error(identifyResponse.body.error.message);
 }
+
 console.log(identifyResponse.body);
 ```
 
 Finally, remove the large person group if you don't need it anymore.
 
-```js
+```ts snippet:ReadmeSampleFaceRecognitionFromLargePersonGroup_Delete
+import { DefaultAzureCredential } from "@azure/identity";
+import FaceClient from "@azure-rest/ai-vision-face";
+
+const endpoint = process.env["FACE_ENDPOINT"] || "<endpoint>";
+const credential = new DefaultAzureCredential();
+const client = FaceClient(endpoint, credential);
+
+const largePersonGroupId = "lpg_family";
+
 console.log(`Delete the large person group: ${largePersonGroupId}`);
 await client.path("/largepersongroups/{largePersonGroupId}", largePersonGroupId).delete();
 ```
@@ -345,17 +375,14 @@ integrate the UI and the code into your native frontend application, please foll
 
 Here is an example to create and get the liveness detection result of a session.
 
-```js
-import { randomUUID } from "crypto";
-
-import { AzureKeyCredential } from "@azure/core-auth";
-
-import createFaceClient, { isUnexpected } from "@azure-rest/ai-vision-face";
+```ts snippet:ReadmeSampleLivenessDetection
+import { DefaultAzureCredential } from "@azure/identity";
+import FaceClient, { isUnexpected } from "@azure-rest/ai-vision-face";
+import { randomUUID } from "node:crypto";
 
 const endpoint = process.env["FACE_ENDPOINT"] || "<endpoint>";
-const apikey = process.env["FACE_APIKEY"] || "<apikey>";
-const credential = new AzureKeyCredential(apikey);
-const client = createFaceClient(endpoint, credential);
+const credential = new DefaultAzureCredential();
+const client = FaceClient(endpoint, credential);
 
 console.log("Create a new liveness session.");
 const createLivenessSessionResponse = await client
@@ -368,6 +395,7 @@ const createLivenessSessionResponse = await client
       authTokenTimeToLiveInSeconds: 60,
     },
   });
+
 if (isUnexpected(createLivenessSessionResponse)) {
   throw new Error(createLivenessSessionResponse.body.error.message);
 }
@@ -379,6 +407,7 @@ console.log("Get liveness detection results.");
 const getLivenessSessionResponse = await client
   .path("/detectLiveness/singleModal/sessions/{sessionId}", sessionId)
   .get();
+
 if (isUnexpected(getLivenessSessionResponse)) {
   throw new Error(getLivenessSessionResponse.body.error.message);
 }
@@ -387,18 +416,15 @@ console.log(getLivenessSessionResponse.body);
 
 Here is another example for the liveness detection with face verification.
 
-```js
-import { randomUUID } from "crypto";
-import { readFileSync } from "fs";
-
-import { AzureKeyCredential } from "@azure/core-auth";
-
-import createFaceClient, { isUnexpected } from "@azure-rest/ai-vision-face";
+```ts snippet:ReadmeSampleLivenessDetectionWithVerify
+import { DefaultAzureCredential } from "@azure/identity";
+import FaceClient, { isUnexpected } from "@azure-rest/ai-vision-face";
+import { readFileSync } from "node:fs";
+import { randomUUID } from "node:crypto";
 
 const endpoint = process.env["FACE_ENDPOINT"] || "<endpoint>";
-const apikey = process.env["FACE_APIKEY"] || "<apikey>";
-const credential = new AzureKeyCredential(apikey);
-const client = createFaceClient(endpoint, credential);
+const credential = new DefaultAzureCredential();
+const client = FaceClient(endpoint, credential);
 
 console.log("Create a new liveness with verify session with verify image.");
 const createLivenessSessionResponse = await client
@@ -421,6 +447,7 @@ const createLivenessSessionResponse = await client
       },
     ],
   });
+
 if (isUnexpected(createLivenessSessionResponse)) {
   throw new Error(createLivenessSessionResponse.body.error.message);
 }
@@ -432,6 +459,7 @@ console.log("Get the liveness detection and verification result.");
 const getLivenessSessionResultResponse = await client
   .path("/detectLivenessWithVerify/singleModal/sessions/{sessionId}", sessionId)
   .get();
+
 if (isUnexpected(getLivenessSessionResultResponse)) {
   throw new Error(getLivenessSessionResultResponse.body.error.message);
 }
@@ -448,8 +476,8 @@ Error codes and messages raised by the Face service can be found in the [service
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-rest/ai-vision-face",
-  "version": "1.0.0-alpha.20250205.1",
+  "version": "1.0.0-alpha.20250207.1",
   "description": "Face API REST Client",
   "engines": {
     "node": ">=18.0.0"
@@ -8,6 +8,7 @@
   "sideEffects": false,
   "autoPublish": false,
   "tshy": {
+    "project": "./tsconfig.src.json",
     "exports": {
       "./package.json": "./package.json",
       ".": "./src/index.ts"
@@ -20,8 +21,7 @@
       "browser",
       "react-native"
     ],
-    "selfLink": false,
-    "project": "./tsconfig.src.json"
+    "selfLink": false
   },
   "type": "module",
   "keywords": [
@@ -35,11 +35,9 @@
   "author": "Microsoft Corporation",
   "license": "MIT",
   "files": [
-    "dist",
+    "dist/",
     "README.md",
-    "LICENSE",
-    "review/*",
-    "CHANGELOG.md"
+    "LICENSE"
   ],
   "sdk-type": "client",
   "repository": "github:Azure/azure-sdk-for-js",
@@ -58,54 +56,56 @@
   },
   "dependencies": {
     "@azure-rest/core-client": "^2.1.0",
-    "@azure/core-auth": "^1.6.0",
-    "@azure/core-rest-pipeline": "^1.5.0",
-    "@azure/logger": "^1.0.0",
-    "tslib": "^2.6.2",
+    "@azure/abort-controller": "^2.1.2",
+    "@azure/core-auth": "^1.9.0",
     "@azure/core-lro": "^3.0.0",
-    "@azure/abort-controller": "^2.1.2"
+    "@azure/core-rest-pipeline": "^1.18.2",
+    "@azure/logger": "^1.1.4",
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "dotenv": "^16.0.0",
+    "@azure-tools/test-credential": "^2.0.0",
+    "@azure-tools/test-recorder": ">=4.1.0-alpha <4.1.0-alphb",
+    "@azure-tools/test-utils-vitest": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
+    "@azure/identity": "^4.6.0",
     "@types/node": "^18.0.0",
+    "@vitest/browser": "^3.0.3",
+    "@vitest/coverage-istanbul": "^3.0.3",
+    "dotenv": "^16.0.0",
     "eslint": "^9.9.0",
+    "playwright": "^1.50.1",
     "prettier": "^3.2.5",
-    "typescript": "~5.7.2",
     "tshy": "^1.11.1",
-    "@azure/identity": "^4.2.1",
-    "@vitest/browser": "^3.0.3",
-    "@vitest/coverage-istanbul": "^3.0.3",
-    "playwright": "^1.41.2",
-    "vitest": "^3.0.3",
-    "@azure-tools/test-credential": "^2.0.0",
-    "@azure-tools/test-recorder": "^4.0.0",
-    "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
-    "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb"
+    "typescript": "~5.7.2",
+    "vitest": "^3.0.3"
   },
   "scripts": {
-    "clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
-    "extract-api": "dev-tool run vendored rimraf review && dev-tool run extract-api",
-    "pack": "npm pack 2>&1",
-    "lint": "eslint package.json api-extractor.json src test",
-    "lint:fix": "eslint package.json api-extractor.json src test --fix --fix-type [problem,suggestion]",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
-    "unit-test:browser": "npm run build:test && dev-tool run test:vitest --browser",
-    "unit-test:node": "dev-tool run test:vitest",
-    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
-    "integration-test:browser": "echo skipped",
-    "integration-test:node": "echo skipped",
     "audit": "node ../../../common/scripts/rush-audit.js && dev-tool run vendored rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
+    "build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
     "build:samples": "echo skipped",
+    "build:test": "npm run clean && tshy && dev-tool run build-test",
     "check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ",
+    "clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
     "execute:samples": "echo skipped",
+    "extract-api": "dev-tool run vendored rimraf review && dev-tool run extract-api",
     "format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ",
     "generate:client": "echo skipped",
-    "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "integration-test:browser": "echo skipped",
+    "integration-test:node": "dev-tool run test:vitest --esm",
+    "lint": "eslint package.json api-extractor.json src test",
+    "lint:fix": "eslint package.json api-extractor.json src test --fix --fix-type [problem,suggestion]",
     "minify": "dev-tool run vendored uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
-    "build:test": "npm run clean && tshy && dev-tool run build-test",
-    "build": "npm run clean && tshy && dev-tool run extract-api",
+    "pack": "npm pack 2>&1",
+    "test": "npm run clean && tshy && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test",
+    "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
     "test:node": "npm run clean && tshy && npm run unit-test:node && npm run integration-test:node",
-    "test": "npm run clean && tshy && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test"
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
+    "unit-test:browser": "echo skipped",
+    "unit-test:node": "dev-tool run test:vitest",
+    "update-snippets": "dev-tool run update-snippets"
   },
   "//sampleConfiguration": {
     "productName": "Face API",
@@ -133,22 +133,18 @@
     "./package.json": "./package.json",
     ".": {
       "browser": {
-        "source": "./src/index.ts",
         "types": "./dist/browser/index.d.ts",
         "default": "./dist/browser/index.js"
       },
       "react-native": {
-        "source": "./src/index.ts",
         "types": "./dist/react-native/index.d.ts",
         "default": "./dist/react-native/index.js"
       },
       "import": {
-        "source": "./src/index.ts",
         "types": "./dist/esm/index.d.ts",
         "default": "./dist/esm/index.js"
       },
       "require": {
-        "source": "./src/index.ts",
         "types": "./dist/commonjs/index.d.ts",
         "default": "./dist/commonjs/index.js"
       }
@@ -156,5 +152,7 @@
   },
   "main": "./dist/commonjs/index.js",
   "types": "./dist/commonjs/index.d.ts",
-  "module": "./dist/esm/index.js"
+  "module": "./dist/esm/index.js",
+  "browser": "./dist/browser/index.js",
+  "react-native": "./dist/react-native/index.js"
 }

package/CHANGELOG.md

@@ -1,45 +0,0 @@
-# Release History
-
-## 1.0.0-beta.3 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
-
-## 1.0.0-beta.2 (2024-10-14)
-
-This library now supports the Azure AI Face v1.2-preview.1 API.
-
-### Features Added
-
-- Added support for latest Detect Liveness Session API
-  - New face detection operation: [Detect From Session Image Id](https://learn.microsoft.com/rest/api/face/face-detection-operations/detect-from-session-image-id?view=rest-face-v1.2-preview.1) using `DetectFromSessionImageIdParameters`.
-  - New liveness session operation: [Get Session Image](https://learn.microsoft.com/rest/api/face/liveness-session-operations/get-session-image?view=rest-face-v1.2-preview.1).
-  - New properties `enableSessionImage?: boolean`, `livenessSingleModalModel?: LivenessModel` to `CreateLivenessSessionContent`.
-  - New model `CreateLivenessWithVerifySessionJsonContent` for liveness session operations [Create Liveness With Verify Session](https://learn.microsoft.com/rest/api/face/liveness-session-operations/create-liveness-with-verify-session?view=rest-face-v1.2-preview.1) and [Create Liveness With Verify Session With Verify Image](https://learn.microsoft.com/rest/api/face/liveness-session-operations/create-liveness-with-verify-session-with-verify-image?view=rest-face-v1.2-preview.1).
-
-## 1.0.0-beta.1 (2024-05-23)
-
-This is the first preview of the Azure Face Service client library `@azure-rest/ai-vision-face` that follows the [TypeScript Azure SDK Design Guidelines](https://azure.github.io/azure-sdk/typescript_introduction.html).
-This library replaces the package [@azure/cognitiveservices-face](https://www.npmjs.com/package/@azure/cognitiveservices-face).
-
-This package's [documentation](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/face/ai-vision-face-rest/README.md) and [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/face/ai-vision-face-rest/samples) demonstrate the new API.
-
-### Features Added
-
-These are the new features not supported by the old package [@azure/cognitiveservices-face](https://www.npmjs.com/package/@azure/cognitiveservices-face).
-
-- Added support for Liveness Detection.
-- Added support for `Person` and `DynamicPersonGroup` operations.
-- Added support for face recognition with `PersonDirectory` by passing `IdentifyFromPersonDirectoryParameters` or `IdentifyFromDynamicPersonGroupParameters` to `/identify`.
-- Added support for authentication with Microsoft Entra ID using `DefaultAzureCredential` from `@azure/identity`.
-
-### Breaking Changes
-
-- This library supports only the Azure AI Face v1.1-preview.1 API, whose data models are not compatible with the v1.0 API used by [@azure/cognitiveservices-face](https://www.npmjs.com/package/@azure/cognitiveservices-face).
-- This library follows the design of [REST client](https://devblogs.microsoft.com/azure-sdk/azure-rest-libraries-for-javascript/), which is essentially different from [@azure/cognitiveservices-face](https://www.npmjs.com/package/@azure/cognitiveservices-face).
-- The Snapshot operations are all removed as [the Snapshot API is no longer supported](https://azure.microsoft.com/updates/facelimitedaccess/).