Snapshot - Take

Tjänst:

Azure AI Services

API-version:

1.0-preview

Skicka en åtgärd för att ta en ögonblicksbild av ansiktslista, stor ansiktslista, persongrupp eller stor persongrupp, med användardefinerad typ av ögonblicksbild, källobjekt-ID, tillämpa omfattning och valfria användardata.
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 Snapshot – Ta för att skapa en kopia av källobjektet och lagra det som en ögonblicksbild och anropar sedan Snapshot – Tillämpa 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 ta ö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 skapa ögonblicksbilden. Ögonblicksbilds-ID:t tas med i fältet "resourceLocation" i OperationStatus – Hämta svar när åtgärdsstatusen är "lyckades".
Ögonblicksbildens tid beror på antalet person- och ansiktsposter i källobjektet. Det kan vara i sekunder, eller upp till flera timmar för 1 000 000 personer med flera ansikten.
Ögonblicksbilder upphör att gälla automatiskt och rensas inom 48 timmar efter att de har skapats av Snapshot – Take. Användaren kan ta bort ögonblicksbilden med hjälp av Ögonblicksbild – Ta bort själva när som helst innan den upphör att gälla.
Om du tar ögonblicksbilder för ett visst objekt blockeras inte andra åtgärder mot objektet. Alla skrivskyddade åtgärder (Get/List och Identify/FindSimilar/Verify) kan utföras som vanligt. För alla skrivbara åtgärder, inklusive Lägg till/uppdatera/ta bort källobjektet eller dess personer/ansikten och Träna, blockeras de inte, men rekommenderas inte eftersom skrivbara uppdateringar kanske inte återspeglas i ögonblicksbilden under tagning. När ögonblicksbilden har tagits kan alla läsbara och skrivbara åtgärder 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.

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

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

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

Begärandehuvud

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

Begärandetext

Name	Obligatorisk	Typ	Description
applyScope	True	string[]	Användardefinerad matris med målprenumerations-ID:t för ögonblicksbilden. För varje ögonblicksbild kan endast prenumerationer som ingår i applyScope of Snapshot – Take tillämpa den.
objectId	True	string	Användardefinerat källobjekt-ID som ögonblicksbilden ska tas från.
type	True	SnapshotObjectType	Användarens angivna typ för källobjektet som ska ta ögonblicksbilden från. För närvarande stöds FaceList, PersonGroup, LargeFaceList och LargePersonGroup.
userData		string	Användardefinierade data om ögonblicksbilden för valfritt ändamål. Längden får inte överstiga 16 kB.

Svar

Name	Typ	Description
202 Accepted		Uppgiften för att ta ögonblicksbilder har placerats i kö. Sidhuvuden Operation-Location: string
Other Status Codes	APIError	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Take a snapshot example

Exempelbegäran

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."
}

Exempelsvar

Statuskod:

202

Definitioner

Name	Description
APIError	Felinformation som returneras av API:et
Error	Feltext.
SnapshotObjectType	Typ av källobjekt i ögonblicksbilden, som anges av prenumeranten som skapade ögonblicksbilden när ögonblicksbilden anropades – Ta. För närvarande stöds FaceList, PersonGroup, LargeFaceList och LargePersonGroup.
TakeSnapshotRequest	Begärandetext för att ta en åtgärd för ögonblicksbild.

APIError

Felinformation som returneras av API:et

Name	Typ	Description
error	Error	Feltext.

Error

Feltext.

Name	Typ	Description
code	string
message	string

SnapshotObjectType

Typ av källobjekt i ögonblicksbilden, som anges av prenumeranten som skapade ögonblicksbilden när ögonblicksbilden anropades – Ta. För närvarande stöds FaceList, PersonGroup, LargeFaceList och LargePersonGroup.

Name	Typ	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

TakeSnapshotRequest

Begärandetext för att ta en åtgärd för ögonblicksbild.

Name	Typ	Description
applyScope	string[]	Användardefinerad matris med målprenumerations-ID:t för ögonblicksbilden. För varje ögonblicksbild kan endast prenumerationer som ingår i applyScope of Snapshot – Take tillämpa den.
objectId	string	Användardefinerat källobjekt-ID som ögonblicksbilden ska tas från.
type	SnapshotObjectType	Användarens angivna typ för källobjektet som ska ta ögonblicksbilden från. För närvarande stöds FaceList, PersonGroup, LargeFaceList och LargePersonGroup.
userData	string	Användardefinierade data om ögonblicksbilden för valfritt ändamål. Längden får inte överstiga 16 kB.