diff --git a/services/cognitiveservices/v1.0/face/models.go b/services/cognitiveservices/v1.0/face/models.go index 4323f616fe7a..f1d917fc436e 100644 --- a/services/cognitiveservices/v1.0/face/models.go +++ b/services/cognitiveservices/v1.0/face/models.go @@ -395,7 +395,7 @@ type FacialHair struct { type FindSimilarRequest struct { // FaceID - FaceId of the query face. User needs to call Face - Detect first to get a valid faceId. Note that this faceId is not persisted and will expire 24 hours after the detection call FaceID *uuid.UUID `json:"faceId,omitempty"` - // FaceListID - An existing user-specified unique candidate 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。 + // FaceListID - An existing user-specified unique candidate 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. FaceListID *string `json:"faceListId,omitempty"` // LargeFaceListID - An existing user-specified unique candidate large face list, created in LargeFaceList - Create. Large 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. LargeFaceListID *string `json:"largeFaceListId,omitempty"` diff --git a/services/cognitiveservices/v1.0/face/snapshot.go b/services/cognitiveservices/v1.0/face/snapshot.go index 251ef90883a3..7333fea18cba 100644 --- a/services/cognitiveservices/v1.0/face/snapshot.go +++ b/services/cognitiveservices/v1.0/face/snapshot.go @@ -38,28 +38,30 @@ func NewSnapshotClient(endpoint string) SnapshotClient { } // 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. +// 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. +// 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". +// 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. +// 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. +// 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. +// 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. +// 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. // Parameters: // snapshotID - id referencing a particular snapshot. // body - request body for applying a snapshot. @@ -441,27 +443,29 @@ func (client SnapshotClient) ListResponder(resp *http.Response) (result ListSnap } // 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. +// 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. +// 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". +// 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. +// 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. +// 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. +// target object before calling Identify/FindSimilar.
+// * Free-tier subscription quota: 100 take operations per month. +// * S0-tier subscription quota: 100 take operations per day. // Parameters: // body - request body for taking a snapshot. func (client SnapshotClient) Take(ctx context.Context, body TakeSnapshotRequest) (result autorest.Response, err error) {