Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions src/SDKs/CognitiveServices/dataPlane/Vision/Face/Face.sln
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,7 @@ Global
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {70CBA0E8-8EF3-44B1-BFC8-EC067BE567D4}
EndGlobalSection
EndGlobal
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public FaceOperations(FaceClient client)
/// 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
/// and faceIds should not be provided at the same time.
/// </param>
/// <param name='largeFaceListId'>
/// An existing user-specified unique candidate large face list, created in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public static partial class FaceOperationsExtensions
/// 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
/// and faceIds should not be provided at the same time.
/// </param>
/// <param name='largeFaceListId'>
/// An existing user-specified unique candidate large face list, created in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public partial interface IFaceOperations
/// 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
/// provided at the same time.
/// </param>
/// <param name='largeFaceListId'>
/// An existing user-specified unique candidate large face list,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,28 +26,29 @@ public partial interface ISnapshotOperations
/// 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.
/// data.&lt;br /&gt;
/// 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.
/// applied cross accounts and regions.&lt;br /&gt;
/// 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".
/// operation status is "succeeded".&lt;br /&gt;
/// 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.
/// several hours for 1,000,000 persons with multiple faces.&lt;br
/// /&gt;
/// 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.&lt;br /&gt;
/// 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
Expand All @@ -58,7 +59,9 @@ public partial interface ISnapshotOperations
/// 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.
/// the target object before calling Identify/FindSimilar.&lt;br /&gt;
/// * Free-tier subscription quota: 100 take operations per month.
/// * S0-tier subscription quota: 100 take operations per day.
/// </summary>
/// <param name='type'>
/// User specified type for the source object to take snapshot from.
Expand Down Expand Up @@ -203,40 +206,44 @@ public partial interface ISnapshotOperations
/// <summary>
/// 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.
/// Snapshot - Take can apply it.&lt;br /&gt;
/// 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.
/// applied cross accounts and regions.&lt;br /&gt;
/// 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".&lt;br /&gt;
/// 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.
/// hour for 1,000,000 persons with multiple faces.&lt;br /&gt;
/// 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.
/// is required to apply the snapshot in 48 hours since its
/// creation.&lt;br /&gt;
/// 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.&lt;br /&gt;
/// 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.
/// specify the "objectId" in request body to avoid such
/// conflicts.&lt;br /&gt;
/// * Free-tier subscription quota: 100 apply operations per month.
/// * S0-tier subscription quota: 100 apply operations per day.
/// </summary>
/// <param name='snapshotId'>
/// Id referencing a particular snapshot.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public FindSimilarRequest()
/// 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</param>
/// faceIds should not be provided at the same time.</param>
/// <param name="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
Expand Down Expand Up @@ -85,7 +85,7 @@ public FindSimilarRequest()
/// 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
/// provided at the same time.
/// </summary>
[JsonProperty(PropertyName = "faceListId")]
public string FaceListId { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,25 +53,26 @@ public SnapshotOperations(FaceClient client)
/// <summary>
/// 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.
/// source object id, apply scope and an optional user data.&lt;br /&gt;
/// 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.
/// that they can be applied cross accounts and regions.&lt;br /&gt;
/// 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".
/// in OperationStatus - Get response when the operation status is
/// "succeeded".&lt;br /&gt;
/// 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.
/// 1,000,000 persons with multiple faces.&lt;br /&gt;
/// 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 by themselves any time before expiration.&lt;br /&gt;
/// 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
Expand All @@ -81,7 +82,10 @@ public SnapshotOperations(FaceClient client)
/// 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.
/// not need re-train the target object before calling
/// Identify/FindSimilar.&lt;br /&gt;
/// * Free-tier subscription quota: 100 take operations per month.
/// * S0-tier subscription quota: 100 take operations per day.
/// </summary>
/// <param name='type'>
/// User specified type for the source object to take snapshot from. Currently
Expand Down Expand Up @@ -890,38 +894,40 @@ public SnapshotOperations(FaceClient client)
/// <summary>
/// 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.
/// can apply it.&lt;br /&gt;
/// 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.
/// that they can be applied cross accounts and regions.&lt;br /&gt;
/// 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".&lt;br /&gt;
/// 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.
/// persons with multiple faces.&lt;br /&gt;
/// 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.
/// the snapshot in 48 hours since its creation.&lt;br /&gt;
/// 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.
/// object before calling Identify/FindSimilar.&lt;br /&gt;
/// 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.
/// body to avoid such conflicts.&lt;br /&gt;
/// * Free-tier subscription quota: 100 apply operations per month.
/// * S0-tier subscription quota: 100 apply operations per day.
/// </summary>
/// <param name='snapshotId'>
/// Id referencing a particular snapshot.
Expand Down
Loading