flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

Face_DetectWithUrl

Detect human faces in an image and returns face locations, and optionally with faceIds, landmarks, and attributes.

OnInit
./lib/actions/Face_DetectWithUrl.js
OnStartup
-
OnClose
-

Attributes

-

FaceList_List

Retrieve information about all existing face lists. Only faceListId, name and userData will be returned.

OnInit
./lib/actions/FaceList_List.js
OnStartup
-
OnClose
-

Attributes

-

FaceList_Delete

Delete an existing face list according to faceListId. Persisted face images in the face list will also be deleted.

OnInit
./lib/actions/FaceList_Delete.js
OnStartup
-
OnClose
-

Attributes

-

FaceList_Get

Retrieve a face list's information.

OnInit
./lib/actions/FaceList_Get.js
OnStartup
-
OnClose
-

Attributes

-

FaceList_Update

Update information of a face list.

OnInit
./lib/actions/FaceList_Update.js
OnStartup
-
OnClose
-

Attributes

-

FaceList_Create

Create an empty face list. Up to 64 face lists are allowed to exist in one subscription.

OnInit
./lib/actions/FaceList_Create.js
OnStartup
-
OnClose
-

Attributes

-

FaceList_AddFaceFromUrl

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.

OnInit
./lib/actions/FaceList_AddFaceFromUrl.js
OnStartup
-
OnClose
-

Attributes

-

FaceList_DeleteFace

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.

OnInit
./lib/actions/FaceList_DeleteFace.js
OnStartup
-
OnClose
-

Attributes

-

Face_FindSimilar

Given query face's faceId, find the similar-looking faces from a faceId array, a face list or a large face list.

OnInit
./lib/actions/Face_FindSimilar.js
OnStartup
-
OnClose
-

Attributes

-

Face_Group

Divide candidate faces into groups based on face similarity.

OnInit
./lib/actions/Face_Group.js
OnStartup
-
OnClose
-

Attributes

-

Face_Identify

1-to-many identification to find the closest matches of the specific query person face from a person group or large person group.

OnInit
./lib/actions/Face_Identify.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_List

Retrieve information about all existing large face lists. Only largeFaceListId, name and userData will be returned.

OnInit
./lib/actions/LargeFaceList_List.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_Delete

Delete an existing large face list according to faceListId. Persisted face images in the large face list will also be deleted.

OnInit
./lib/actions/LargeFaceList_Delete.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_Get

Retrieve a large face list's information.

OnInit
./lib/actions/LargeFaceList_Get.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_Update

Update information of a large face list.

OnInit
./lib/actions/LargeFaceList_Update.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_Create

Create an empty large face list. Up to 64 large face lists are allowed to exist in one subscription.

OnInit
./lib/actions/LargeFaceList_Create.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_ListFaces

List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face).

OnInit
./lib/actions/LargeFaceList_ListFaces.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_AddFaceFromUrl

Add a face to a large 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.

OnInit
./lib/actions/LargeFaceList_AddFaceFromUrl.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_DeleteFace

Delete an existing face from a large face list (given by a persistedFaceId and a largeFaceListId). Persisted image related to the face will also be deleted.

OnInit
./lib/actions/LargeFaceList_DeleteFace.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_GetFace

Retrieve information about a persisted face (specified by persistedFaceId and its belonging largeFaceListId).

OnInit
./lib/actions/LargeFaceList_GetFace.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_UpdateFace

Update a persisted face's userData field.

OnInit
./lib/actions/LargeFaceList_UpdateFace.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_Train

Queue a large face list training task, the training task may not be started immediately.

OnInit
./lib/actions/LargeFaceList_Train.js
OnStartup
-
OnClose
-

Attributes

-

LargeFaceList_GetTrainingStatus

Retrieve the training status of a large face list (completed or ongoing).

OnInit
./lib/actions/LargeFaceList_GetTrainingStatus.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroup_List

List large person groups and their information.

OnInit
./lib/actions/LargePersonGroup_List.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroup_Delete

Delete an existing large person group. Persisted face features of all people in the large person group will also be deleted.

OnInit
./lib/actions/LargePersonGroup_Delete.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroup_Get

Retrieve the information of a large person group, including its name and userData.

OnInit
./lib/actions/LargePersonGroup_Get.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroup_Update

Update an existing large person group's display name and userData. The properties which does not appear in request body will not be updated.

OnInit
./lib/actions/LargePersonGroup_Update.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroup_Create

Create a new large person group with specified largePersonGroupId, name and user-provided userData.

OnInit
./lib/actions/LargePersonGroup_Create.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroupPerson_List

List all persons in a large person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).

OnInit
./lib/actions/LargePersonGroupPerson_List.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroupPerson_Create

Create a new person in a specified large person group.

OnInit
./lib/actions/LargePersonGroupPerson_Create.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroupPerson_Delete

Delete an existing person from a large person group. All stored person data, and face features in the person entry will be deleted.

OnInit
./lib/actions/LargePersonGroupPerson_Delete.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroupPerson_Get

Retrieve a person's information, including registered persisted faces, name and userData.

OnInit
./lib/actions/LargePersonGroupPerson_Get.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroupPerson_Update

Update name or userData of a person.

OnInit
./lib/actions/LargePersonGroupPerson_Update.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroupPerson_AddFaceFromUrl

Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.

OnInit
./lib/actions/LargePersonGroupPerson_AddFaceFromUrl.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroupPerson_DeleteFace

Delete a face from a person. Relative feature for the persisted face will also be deleted.

OnInit
./lib/actions/LargePersonGroupPerson_DeleteFace.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroupPerson_GetFace

Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging largePersonGroupId).

OnInit
./lib/actions/LargePersonGroupPerson_GetFace.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroupPerson_UpdateFace

Update a person persisted face's userData field.

OnInit
./lib/actions/LargePersonGroupPerson_UpdateFace.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroup_Train

Queue a large person group training task, the training task may not be started immediately.

OnInit
./lib/actions/LargePersonGroup_Train.js
OnStartup
-
OnClose
-

Attributes

-

LargePersonGroup_GetTrainingStatus

Retrieve the training status of a large person group (completed or ongoing).

OnInit
./lib/actions/LargePersonGroup_GetTrainingStatus.js
OnStartup
-
OnClose
-

Attributes

-

Snapshot_GetOperationStatus

Retrieve the status of a take/apply snapshot operation.

OnInit
./lib/actions/Snapshot_GetOperationStatus.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroup_List

List person groups and their information.

OnInit
./lib/actions/PersonGroup_List.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroup_Delete

Delete an existing person group. Persisted face features of all people in the person group will also be deleted.

OnInit
./lib/actions/PersonGroup_Delete.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroup_Get

Retrieve the information of a person group, including its name and userData.

OnInit
./lib/actions/PersonGroup_Get.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroup_Update

Update an existing person group's display name and userData. The properties which does not appear in request body will not be updated.

OnInit
./lib/actions/PersonGroup_Update.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroup_Create

Create a new person group with specified personGroupId, name and user-provided userData.

OnInit
./lib/actions/PersonGroup_Create.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroupPerson_List

List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).

OnInit
./lib/actions/PersonGroupPerson_List.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroupPerson_Create

Create a new person in a specified person group.

OnInit
./lib/actions/PersonGroupPerson_Create.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroupPerson_Delete

Delete an existing person from a person group. All stored person data, and face features in the person entry will be deleted.

OnInit
./lib/actions/PersonGroupPerson_Delete.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroupPerson_Get

Retrieve a person's information, including registered persisted faces, name and userData.

OnInit
./lib/actions/PersonGroupPerson_Get.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroupPerson_Update

Update name or userData of a person.

OnInit
./lib/actions/PersonGroupPerson_Update.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroupPerson_AddFaceFromUrl

Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.

OnInit
./lib/actions/PersonGroupPerson_AddFaceFromUrl.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroupPerson_DeleteFace

Delete a face from a person. Relative feature for the persisted face will also be deleted.

OnInit
./lib/actions/PersonGroupPerson_DeleteFace.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroupPerson_GetFace

Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId).

OnInit
./lib/actions/PersonGroupPerson_GetFace.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroupPerson_UpdateFace

Update a person persisted face's userData field.

OnInit
./lib/actions/PersonGroupPerson_UpdateFace.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroup_Train

Queue a person group training task, the training task may not be started immediately.

OnInit
./lib/actions/PersonGroup_Train.js
OnStartup
-
OnClose
-

Attributes

-

PersonGroup_GetTrainingStatus

Retrieve the training status of a person group (completed or ongoing).

OnInit
./lib/actions/PersonGroup_GetTrainingStatus.js
OnStartup
-
OnClose
-

Attributes

-

Snapshot_List

List all accessible snapshots with related information, including snapshots that were taken by the user, or snapshots to be applied to the user (subscription id was included in the applyScope in Snapshot - Take).

OnInit
./lib/actions/Snapshot_List.js
OnStartup
-
OnClose
-

Attributes

-

Snapshot_Take

Submit an operation to take a snapshot of face list, large face list, person group or large person group, with user-specified snapshot type, source object id, apply scope and an optional user data.
The snapshot interfaces are for users to backup and restore their face data from one face subscription to another, inside same region or across regions. The workflow contains two phases, user first calls Snapshot - Take to create a copy of the source object and store it as a snapshot, then calls Snapshot - Apply to paste the snapshot to target subscription. The snapshots are stored in a centralized location (per Azure instance), so that they can be applied cross accounts and regions.
Taking snapshot is an asynchronous operation. An operation id can be obtained from the "Operation-Location" field in response header, to be used in OperationStatus - Get for tracking the progress of creating the snapshot. The snapshot id will be included in the "resourceLocation" field in OperationStatus - Get response when the operation status is "succeeded".
Snapshot taking time depends on the number of person and face entries in the source object. It could be in seconds, or up to several hours for 1,000,000 persons with multiple faces.
Snapshots will be automatically expired and cleaned in 48 hours after it is created by Snapshot - Take. User can delete the snapshot using Snapshot - Delete by themselves any time before expiration.
Taking snapshot for a certain object will not block any other operations against the object. All read-only operations (Get/List and Identify/FindSimilar/Verify) can be conducted as usual. For all writable operations, including Add/Update/Delete the source object or its persons/faces and Train, they are not blocked but not recommended because writable updates may not be reflected on the snapshot during its taking. After snapshot taking is completed, all readable and writable operations can work as normal. Snapshot will also include the training results of the source object, which means target subscription the snapshot applied to does not need re-train the target object before calling Identify/FindSimilar.
* Free-tier subscription quota: 100 take operations per month. * S0-tier subscription quota: 100 take operations per day.

OnInit
./lib/actions/Snapshot_Take.js
OnStartup
-
OnClose
-

Attributes

-

Snapshot_Delete

Delete an existing snapshot according to the snapshotId. All object data and information in the snapshot will also be deleted. Only the source subscription who took the snapshot can delete the snapshot. If the user does not delete a snapshot with this API, the snapshot will still be automatically deleted in 48 hours after creation.

OnInit
./lib/actions/Snapshot_Delete.js
OnStartup
-
OnClose
-

Attributes

-

Snapshot_Get

Retrieve information about a snapshot. Snapshot is only accessible to the source subscription who took it, and target subscriptions included in the applyScope in Snapshot - Take.

OnInit
./lib/actions/Snapshot_Get.js
OnStartup
-
OnClose
-

Attributes

-

Snapshot_Update

Update the information of a snapshot. Only the source subscription who took the snapshot can update the snapshot.

OnInit
./lib/actions/Snapshot_Update.js
OnStartup
-
OnClose
-

Attributes

-

Snapshot_Apply

Submit an operation to apply a snapshot to current subscription. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
The snapshot interfaces are for users to backup and restore their face data from one face subscription to another, inside same region or across regions. The workflow contains two phases, user first calls Snapshot - Take to create a copy of the source object and store it as a snapshot, then calls Snapshot - Apply to paste the snapshot to target subscription. The snapshots are stored in a centralized location (per Azure instance), so that they can be applied cross accounts and regions.
Applying snapshot is an asynchronous operation. An operation id can be obtained from the "Operation-Location" field in response header, to be used in OperationStatus - Get for tracking the progress of applying the snapshot. The target object id will be included in the "resourceLocation" field in OperationStatus - Get response when the operation status is "succeeded".
Snapshot applying time depends on the number of person and face entries in the snapshot object. It could be in seconds, or up to 1 hour for 1,000,000 persons with multiple faces.
Snapshots will be automatically expired and cleaned in 48 hours after it is created by Snapshot - Take. So the target subscription is required to apply the snapshot in 48 hours since its creation.
Applying a snapshot will not block any other operations against the target object, however it is not recommended because the correctness cannot be guaranteed during snapshot applying. After snapshot applying is completed, all operations towards the target object can work as normal. Snapshot also includes the training results of the source object, which means target subscription the snapshot applied to does not need re-train the target object before calling Identify/FindSimilar.
One snapshot can be applied multiple times in parallel, while currently only CreateNew apply mode is supported, which means the apply operation will fail if target subscription already contains an object of same type and using the same objectId. Users can specify the "objectId" in request body to avoid such conflicts.
* Free-tier subscription quota: 100 apply operations per month. * S0-tier subscription quota: 100 apply operations per day.

OnInit
./lib/actions/Snapshot_Apply.js
OnStartup
-
OnClose
-

Attributes

-

Face_VerifyFaceToFace

Verify whether two faces belong to a same person or whether one face belongs to a person.

OnInit
./lib/actions/Face_VerifyFaceToFace.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

No data available for environment