Snapshot - Take

Service:

Azure AI Services

Version d'API:

1.0-preview

Envoyez une opération pour prendre une instantané de liste de visages, de grandes listes de visages, de groupes de personnes ou de grands groupes de personnes, avec un type de instantané spécifié par l’utilisateur, un ID d’objet source, une étendue d’application et des données utilisateur facultatives.
Les interfaces instantané permettent aux utilisateurs de sauvegarder et de restaurer leurs données faciales d’un abonnement visage à 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é (selon Azure instance), afin qu’ils puissent être appliqués entre des comptes et des régions.
Prendre 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 la création du instantané. L’ID de instantané sera inclus dans le champ « resourceLocation » dans OperationStatus - Obtenir la réponse lorsque l’opération status est « réussie ».
Le temps de prise d’instantané dépend du nombre d’entrées de personne et de visage dans l’objet source. Il peut s’agir de quelques secondes ou de plusieurs heures pour 1 000 000 personnes à visages multiples.
Les instantanés sont automatiquement expirés et nettoyés dans les 48 heures après leur création par Capture instantanée - Prise. L’utilisateur peut supprimer le instantané à l’aide de Capture instantanée - Supprimer par lui-même à tout moment avant l’expiration.
L’instantané pour un objet donné ne bloque pas d’autres opérations sur l’objet. Toutes les opérations en lecture seule (Get/List et Identifier/FindSimilar/Verify) peuvent être effectuées comme d’habitude. Pour toutes les opérations accessibles en écriture, y compris ajouter/mettre à jour/supprimer l’objet source ou ses personnes/visages et Entraîner, elles ne sont pas bloquées, mais non recommandées, car les mises à jour accessibles en écriture peuvent ne pas être répercutées sur l’instantané lors de leur prise. Une fois instantané prise terminée, toutes les opérations lisibles et accessibles en écriture 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éentraîner l’objet cible avant d’appeler Identifier/FindSimilar.

• Quota d’abonnement de niveau gratuit : 100 opérations de prise par mois.
• Quota d’abonnement de niveau S0 : 100 opérations de prise par jour.

POST {Endpoint}/face/v1.0-preview/snapshots

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).

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Corps de la demande

Nom	Obligatoire	Type	Description
applyScope	True	string[]	Tableau spécifié par l’utilisateur des ID d’abonnement Visage cible pour le instantané. Pour chaque instantané, seuls les abonnements inclus dans le applyScope of Snapshot - Take peuvent l’appliquer.
objectId	True	string	ID d’objet source spécifié par l’utilisateur à partir duquel prendre instantané.
type	True	SnapshotObjectType	Type spécifié par l’utilisateur pour l’objet source à partir duquel prendre instantané. Actuellement, FaceList, PersonGroup, LargeFaceList et LargePersonGroup sont pris en charge.
userData		string	L’utilisateur a spécifié des données sur le instantané à n’importe quelle fin. La longueur ne doit pas dépasser 16 Ko.

Réponses

Nom	Type	Description
202 Accepted		La tâche de prise de instantané a été mise en file d’attente avec succès. En-têtes Operation-Location: string
Other Status Codes	APIError	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

Take a snapshot example

Exemple de requête

HTTP

POST {Endpoint}/face/v1.0-preview/snapshots


{
  "type": "FaceList",
  "objectId": "source-face-list-id",
  "applyScope": [
    "35230F59-AA9C-45E0-AB5E-C859BF1A5429",
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot."
}

Exemple de réponse

Code d’état:

202

Définitions

Nom	Description
APIError	Informations d’erreur retournées par l’API
Error	Corps de l’erreur.
SnapshotObjectType	Type de l’objet source dans le instantané, spécifié par l’abonné qui a créé le instantané lors de l’appel de Capture instantanée - Take. Actuellement, FaceList, PersonGroup, LargeFaceList et LargePersonGroup sont pris en charge.
TakeSnapshotRequest	Corps de la demande pour prendre instantané opération.

APIError

Informations d’erreur retournées par l’API

Nom	Type	Description
error	Error	Corps de l’erreur.

Error

Corps de l’erreur.

Nom	Type	Description
code	string
message	string

SnapshotObjectType

Type de l’objet source dans le instantané, spécifié par l’abonné qui a créé le instantané lors de l’appel de Capture instantanée - Take. Actuellement, FaceList, PersonGroup, LargeFaceList et LargePersonGroup sont pris en charge.

Nom	Type	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

TakeSnapshotRequest

Corps de la demande pour prendre instantané opération.

Nom	Type	Description
applyScope	string[]	Tableau spécifié par l’utilisateur des ID d’abonnement Visage cible pour le instantané. Pour chaque instantané, seuls les abonnements inclus dans le applyScope of Snapshot - Take peuvent l’appliquer.
objectId	string	ID d’objet source spécifié par l’utilisateur à partir duquel prendre instantané.
type	SnapshotObjectType	Type spécifié par l’utilisateur pour l’objet source à partir duquel prendre instantané. Actuellement, FaceList, PersonGroup, LargeFaceList et LargePersonGroup sont pris en charge.
userData	string	L’utilisateur a spécifié des données sur le instantané à n’importe quelle fin. La longueur ne doit pas dépasser 16 Ko.