Skip to content

[AutoPR cognitiveservices/data-plane/Face] [Cogs Face] Refine the documentation for Face API's new Snapshot features. #994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AutorestCI merged 2 commits into from
Jan 28, 2019
Merged

[AutoPR cognitiveservices/data-plane/Face] [Cogs Face] Refine the documentation for Face API's new Snapshot features. #994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2aa00ac
Generated from 2662c92f89bbd0d23bcd042cb8ee4401d9ec33ff
AutorestCI Jan 25, 2019
3052d40
Generated from c88a6f0cf2096a86ec5e870bd7524d0b01b152ae
AutorestCI Jan 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/@azure/cognitiveservices-face/lib/models/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,7 +570,7 @@ export interface FindSimilarRequest {
* face list, created in Face List - Create a Face List. Face list contains a
* set of persistedFaceIds which are persisted and will never expire.
* Parameter faceListId, largeFaceListId and faceIds should not be provided
* at the same time。
* at the same time.
*/
faceListId?: string;
/**
Expand Down Expand Up @@ -1197,7 +1197,7 @@ export interface FaceFindSimilarOptionalParams extends msRest.RequestOptionsBase
* face list, created in Face List - Create a Face List. Face list contains a
* set of persistedFaceIds which are persisted and will never expire.
* Parameter faceListId, largeFaceListId and faceIds should not be provided
* at the same time。
* at the same time.
*/
faceListId?: string;
/**
Expand Down
30 changes: 17 additions & 13 deletions packages/@azure/cognitiveservices-face/lib/operations/snapshotOperations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,31 +29,33 @@ export class SnapshotOperations {
/**
* 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.
* user data.<br />
* 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.
* cross accounts and regions.<br />
* 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".
* "succeeded".<br />
* 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.
* could be in seconds, or up to several hours for 1,000,000 persons with multiple faces.<br />
* 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.
* expiration.<br />
* 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.
* target object before calling Identify/FindSimilar.<br />
* * Free-tier subscription quota: 100 take operations per month.
* * S0-tier subscription quota: 100 take operations per day.
* @param type User specified type for the source object to take snapshot from. Currently FaceList,
* PersonGroup, LargeFaceList and LargePersonGroup are supported. Possible values include:
* 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
Expand Down Expand Up @@ -214,33 +216,35 @@ export class SnapshotOperations {

/**
* 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.
* subscriptions included in the applyScope of Snapshot - Take can apply it.<br />
* 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.
* cross accounts and regions.<br />
* 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".
* "succeeded".<br />
* 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.
* It could be in seconds, or up to 1 hour for 1,000,000 persons with multiple faces.<br />
* 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.
* creation.<br />
* 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.
* Identify/FindSimilar.<br />
* 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.
* request body to avoid such conflicts.<br />
* * Free-tier subscription quota: 100 apply operations per month.
* * S0-tier subscription quota: 100 apply operations per day.
* @param snapshotId Id referencing a particular snapshot.
* @param objectId User specified target object id to be created from the snapshot.
* @param [options] The optional parameters
Expand Down