Snapshot - Apply

Tjänst:

Azure AI Services

API-version:

1.0-preview

Skicka en åtgärd för att tillämpa en ögonblicksbild på den aktuella prenumerationen. För varje ögonblicksbild kan endast prenumerationer som ingår i applyScope of Snapshot – Take tillämpa den.
Gränssnitten för ögonblicksbilder är till för användare att säkerhetskopiera och återställa sina ansiktsdata från en ansiktsprenumeration till en annan, i samma region eller mellan regioner. Arbetsflödet innehåller två faser, användaren anropar först Ögonblicksbild – Ta för att skapa en kopia av källobjektet och lagra det som en ögonblicksbild och anropar sedan Ögonblicksbild – Använd för att klistra in ögonblicksbilden i målprenumerationen. Ögonblicksbilderna lagras på en central plats (per Azure-instans), så att de kan tillämpas mellan konton och regioner.
Att tillämpa ögonblicksbilder är en asynkron åtgärd. Ett åtgärds-ID kan hämtas från fältet "Operation-Location" i svarshuvudet som ska användas i OperationStatus – Hämta för att spåra förloppet för att tillämpa ögonblicksbilden. Målobjekt-ID:t inkluderas i fältet "resourceLocation" i OperationStatus – Hämta svar när åtgärdsstatusen är "lyckades".
Användningstiden för ögonblicksbilder beror på antalet person- och ansiktsposter i ögonblicksbildsobjektet. Det kan vara i sekunder, eller upp till 1 timme för 1 000 000 personer med flera ansikten.
Ögonblicksbilder upphör automatiskt att gälla och rensas inom 48 timmar efter att de har skapats av Snapshot – Take. Därför krävs målprenumerationen för att tillämpa ögonblicksbilden inom 48 timmar sedan den skapades.
Om du tillämpar en ögonblicksbild blockeras inga andra åtgärder mot målobjektet, men det rekommenderas inte eftersom korrektheten inte kan garanteras vid användning av ögonblicksbilder. När ögonblicksbilden har tillämpats kan alla åtgärder mot målobjektet fungera som vanligt. Ögonblicksbilden innehåller även träningsresultatet för källobjektet, vilket innebär att målprenumerationen som ögonblicksbilden tillämpas på inte behöver träna målobjektet igen innan det anropar Identifiera/FindSimilar.
En ögonblicksbild kan användas flera gånger parallellt, medan endast CreateNew-användningsläge stöds för närvarande, vilket innebär att åtgärden apply misslyckas om målprenumerationen redan innehåller ett objekt av samma typ och använder samma objectId. Användare kan ange "objectId" i begärandetexten för att undvika sådana konflikter.

• Prenumerationskvot på kostnadsfri nivå: 100 tillämpar åtgärder per månad.
• Prenumerationskvot på S0-nivå: 100 tillämpa åtgärder per dag.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).
snapshotId	path	True	string uuid	ID som refererar till en viss ögonblicksbild.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

Name	Obligatorisk	Typ	Description
objectId	True	string	Användardefinerat målobjekt-ID som ska skapas från ögonblicksbilden.
mode		SnapshotApplyMode	Användningsläge för ögonblicksbilder. För närvarande stöds endast CreateNew, vilket innebär att åtgärden apply misslyckas om målprenumerationen redan innehåller ett objekt av samma typ och använder samma objectId. Användare kan ange "objectId" i begärandetexten för att undvika sådana konflikter.

Svar

Name	Typ	Description
202 Accepted		Den ögonblicksbild som tillämpade uppgiften har placerats i kö. Sidhuvuden Operation-Location: string
Other Status Codes	APIError	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Apply snapshot example

Exempelbegäran

HTTP

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


{
  "objectId": "target-face-list-id",
  "mode": "CreateNew"
}

Exempelsvar

Statuskod:

202

Definitioner

Name	Description
APIError	Felinformation som returneras av API:et
ApplySnapshotRequest	Begärandetext för att tillämpa åtgärd för ögonblicksbilder.
Error	Feltext.
SnapshotApplyMode	Användningsläge för ögonblicksbilder. För närvarande stöds endast CreateNew, vilket innebär att åtgärden apply misslyckas om målprenumerationen redan innehåller ett objekt av samma typ och använder samma objectId. Användare kan ange "objectId" i begärandetexten för att undvika sådana konflikter.

APIError

Felinformation som returneras av API:et

Name	Typ	Description
error	Error	Feltext.

ApplySnapshotRequest

Begärandetext för att tillämpa åtgärd för ögonblicksbilder.

Name	Typ	Standardvärde	Description
mode	SnapshotApplyMode	CreateNew	Användningsläge för ögonblicksbilder. För närvarande stöds endast CreateNew, vilket innebär att åtgärden apply misslyckas om målprenumerationen redan innehåller ett objekt av samma typ och använder samma objectId. Användare kan ange "objectId" i begärandetexten för att undvika sådana konflikter.
objectId	string		Användardefinerat målobjekt-ID som ska skapas från ögonblicksbilden.

Error

Feltext.

Name	Typ	Description
code	string
message	string

SnapshotApplyMode

Användningsläge för ögonblicksbilder. För närvarande stöds endast CreateNew, vilket innebär att åtgärden apply misslyckas om målprenumerationen redan innehåller ett objekt av samma typ och använder samma objectId. Användare kan ange "objectId" i begärandetexten för att undvika sådana konflikter.

Name	Typ	Description
CreateNew	string