Snapshot - Apply
Envoyez une opération pour appliquer une instantané à l’abonnement actuel. Pour chaque instantané, seuls les abonnements inclus dans le applyScope d’instantané - Take peuvent l’appliquer.
Les interfaces instantané permettent aux utilisateurs de sauvegarder et de restaurer leurs données faciales d’un abonnement face à un autre, à l’intérieur d’une même région ou d’une région à l’autre. Le flux de travail contient deux phases : l’utilisateur appelle d’abord Instantané - Prendre pour créer une copie de l’objet source et le stocker en tant que instantané, puis appelle Instantané - Appliquer pour coller le instantané à l’abonnement cible. Les instantanés sont stockés dans un emplacement centralisé (par azure instance), afin qu’ils puissent être appliqués entre les comptes et les régions.
L’application de instantané est une opération asynchrone. Un ID d’opération peut être obtenu à partir du champ « Operation-Location » dans l’en-tête de réponse, à utiliser dans OperationStatus - Get pour suivre la progression de l’application de la instantané. L’ID d’objet cible est inclus dans le champ « resourceLocation » dans OperationStatus - Obtenir la réponse lorsque l’opération status est « réussie ».
L’heure d’application de l’instantané dépend du nombre d’entrées de personne et de visage dans l’objet instantané. Il peut être en secondes, ou jusqu’à 1 heure pour 1 000 000 personnes avec plusieurs visages.
Les instantanés sont automatiquement expirés et nettoyés dans les 48 heures après leur création par Capture instantanée - Prendre. L’abonnement cible est donc requis pour appliquer le instantané dans les 48 heures depuis sa création.
L’application d’une instantané ne bloque pas d’autres opérations sur l’objet cible, mais elle n’est pas recommandée, car l’exactitude ne peut pas être garantie pendant instantané l’application. Une fois instantané application terminée, toutes les opérations vers l’objet cible peuvent fonctionner normalement. L’instantané inclut également les résultats d’apprentissage de l’objet source, ce qui signifie que l’abonnement cible auquel le instantané appliqué n’a pas besoin de réentreîner l’objet cible avant d’appeler Identifier/FindSimilar.
Une instantané peut être appliquée plusieurs fois en parallèle, alors qu’actuellement, seul le mode CreateNew apply est pris en charge, ce qui signifie que l’opération d’application échoue si l’abonnement cible contient déjà un objet du même type et utilisant le même objectId. Les utilisateurs peuvent spécifier l'« objectId » dans le corps de la demande pour éviter de tels conflits.
- Quota d’abonnement de niveau gratuit : 100 opérations d’application par mois.
- Quota d’abonnement de niveau S0 : 100 opérations d’application par jour.
POST {Endpoint}/face/v1.0-preview/snapshots/{snapshotId}/apply
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com). |
snapshot
|
path | True |
string uuid |
ID faisant référence à un instantané particulier. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
objectId | True |
string |
L’utilisateur a spécifié l’ID d’objet cible à créer à partir du instantané. |
mode |
Mode d’application d’instantané. Actuellement, seul CreateNew est pris en charge, ce qui signifie que l’opération d’application échoue si l’abonnement cible contient déjà un objet du même type et utilise le même objectId. Les utilisateurs peuvent spécifier l'« objectId » dans le corps de la demande pour éviter de tels conflits. |
Réponses
Nom | Type | Description |
---|---|---|
202 Accepted |
La instantané tâche d’application a été correctement mise en file d’attente. En-têtes Operation-Location: string |
|
Other Status Codes |
Réponse d’erreur. |
Sécurité
Ocp-Apim-Subscription-Key
Type:
apiKey
Dans:
header
Exemples
Apply snapshot example
Exemple de requête
POST {Endpoint}/face/v1.0-preview/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc/apply
{
"objectId": "target-face-list-id",
"mode": "CreateNew"
}
Exemple de réponse
Définitions
Nom | Description |
---|---|
APIError |
Informations d’erreur retournées par l’API |
Apply |
Corps de la demande pour l’application de instantané opération. |
Error |
Corps de l’erreur. |
Snapshot |
Mode d’application d’instantané. Actuellement, seul CreateNew est pris en charge, ce qui signifie que l’opération d’application échoue si l’abonnement cible contient déjà un objet du même type et utilise le même objectId. Les utilisateurs peuvent spécifier l'« objectId » dans le corps de la demande pour éviter de tels conflits. |
APIError
Informations d’erreur retournées par l’API
Nom | Type | Description |
---|---|---|
error |
Corps de l’erreur. |
ApplySnapshotRequest
Corps de la demande pour l’application de instantané opération.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
mode | CreateNew |
Mode d’application d’instantané. Actuellement, seul CreateNew est pris en charge, ce qui signifie que l’opération d’application échoue si l’abonnement cible contient déjà un objet du même type et utilise le même objectId. Les utilisateurs peuvent spécifier l'« objectId » dans le corps de la demande pour éviter de tels conflits. |
|
objectId |
string |
L’utilisateur a spécifié l’ID d’objet cible à créer à partir du instantané. |
Error
Corps de l’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
|
message |
string |
SnapshotApplyMode
Mode d’application d’instantané. Actuellement, seul CreateNew est pris en charge, ce qui signifie que l’opération d’application échoue si l’abonnement cible contient déjà un objet du même type et utilise le même objectId. Les utilisateurs peuvent spécifier l'« objectId » dans le corps de la demande pour éviter de tels conflits.
Nom | Type | Description |
---|---|---|
CreateNew |
string |