Snapshot - Update

Référence

Service:: Azure AI Services

Version d'API:: 1.0-preview

Mettez à jour les informations d’un instantané. Seul l’abonnement source qui a pris le instantané peut mettre à jour le instantané.

PATCH {Endpoint}/face/v1.0-preview/snapshots/{snapshotId}

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).
snapshotId	path	True	string uuid	ID référençant un instantané particulier.

En-tête de la demande

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

Corps de la demande

Nom	Type	Description
applyScope	string[]	Tableau des ID d’abonnement Visage cible pour le instantané, spécifié par l’utilisateur qui a créé le instantané lors de l’appel de Capture instantanée - Take. Pour chaque instantané, seuls les abonnements inclus dans le applyScope of Snapshot - Take peuvent l’appliquer.
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
200 OK		Un appel réussi retourne un corps de réponse vide.
Other Status Codes	APIError	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

Update snapshot example

Exemple de requête

HTTP

PATCH {Endpoint}/face/v1.0-preview/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc


{
  "applyScope": [
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot."
}

Exemple de réponse

Code d’état:: 200

Définitions

Nom	Description
APIError	Informations d’erreur retournées par l’API
Error	Corps de l’erreur.
UpdateSnapshotRequest	Corps de la demande pour la mise à jour d’un instantané, avec une combinaison d’étendue d’application définie par l’utilisateur et de données spécifiées par l’utilisateur.

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

UpdateSnapshotRequest

Corps de la demande pour la mise à jour d’un instantané, avec une combinaison d’étendue d’application définie par l’utilisateur et de données spécifiées par l’utilisateur.

Nom	Type	Description
applyScope	string[]	Tableau des ID d’abonnement Visage cible pour le instantané, spécifié par l’utilisateur qui a créé le instantané lors de l’appel de Capture instantanée - Take. Pour chaque instantané, seuls les abonnements inclus dans le applyScope of Snapshot - Take peuvent l’appliquer.
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.

Partager via