Snapshot - Take

Služba:

Azure AI Services

Verze rozhraní API:

1.0-preview

Odešlete operaci, která pořídí snímek seznamu tváří, velkého seznamu tváří, skupiny osob nebo velké skupiny osob s uživatelem zadaným typem snímku, ID zdrojového objektu, použitím oboru a volitelnými uživatelskými daty.
Rozhraní snímků slouží uživatelům k zálohování a obnovení dat o tvářích z jednoho předplatného pro rozpoznávání tváře do jiného, ve stejné oblasti nebo napříč oblastmi. Pracovní postup obsahuje dvě fáze. Uživatel nejprve zavolá Snímek – Take, aby vytvořil kopii zdrojového objektu a uložil ji jako snímek, a pak zavolá snímek – Použít a vložil snímek do cílového předplatného. Snímky se ukládají v centralizované lokalitě (na instanci Azure), aby je bylo možné použít napříč účty a oblastmi.
Pořízení snímku je asynchronní operace. ID operace je možné získat z pole Operation-Location v hlavičce odpovědi, které se použije ve funkci OperationStatus – Get ke sledování průběhu vytváření snímku. ID snímku se zahrne do pole resourceLocation v části OperationStatus – Get response, pokud je stav operace "úspěch".
Čas pořizování snímků závisí na počtu osob a obličejů ve zdrojovém objektu. U 1 000 000 osob s více tvářemi to může být v řádu sekund nebo až několik hodin.
Platnost snímků automaticky vyprší a vyčistí se během 48 hodin od vytvoření pomocí funkce Snímek – Pořízení. Uživatel může odstranit snímek pomocí příkazu Snapshot – Delete sám kdykoli před vypršením platnosti.
Pořízení snímku určitého objektu neblokuje žádné další operace s objektem. Všechny operace jen pro čtení (Get/List a Identify/FindSimilar/Verify) je možné provádět obvyklým způsobem. U všech zapisovatelných operací, včetně přidání, aktualizace nebo odstranění zdrojového objektu nebo jeho osob nebo tváří a trénování, se tyto operace neblokují, ale nedoporučují se, protože zapisovatelné aktualizace se nemusí během pořizování snímku projevit. Po dokončení pořizování snímků můžou všechny operace pro čtení a zápis fungovat normálně. Snímek bude také obsahovat výsledky trénování zdrojového objektu, což znamená, že cílové předplatné, pro které se snímek použil, nemusí před voláním metody Identify/FindSimilar přetrénovat cílový objekt.

• Kvóta předplatného úrovně Free: 100 operací převzetí za měsíc.
• Kvóta předplatného úrovně S0: 100 operací převzetí za den.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Text požadavku

Name	Vyžadováno	Typ	Description
applyScope	True	string[]	Uživatel zadal pole ID cílových předplatných tváří pro snímek. Pro každý snímek ho můžou použít jenom předplatná zahrnutá v applyScope of Snapshot – Take.
objectId	True	string	Uživatel zadal ID zdrojového objektu, ze které se má pořídit snímek.
type	True	SnapshotObjectType	Uživatel zadal typ zdrojového objektu, ze které se má pořídit snímek. V současné době se podporují FaceList, PersonGroup, LargeFaceList a LargePersonGroup.
userData		string	Uživatel zadal data o snímku pro libovolný účel. Délka by neměla překročit 16 kB.

Odpovědi

Name	Typ	Description
202 Accepted		Úloha pořizování snímků byla úspěšně zařazena do fronty. Hlavičky Operation-Location: string
Other Status Codes	APIError	Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

Take a snapshot example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

202

Definice

Name	Description
APIError	Informace o chybě vrácené rozhraním API
Error	Text chyby.
SnapshotObjectType	Typ zdrojového objektu ve snímku určený odběratelem, který vytvořil snímek při volání příkazu Snímek – Pořízení. V současné době se podporují FaceList, PersonGroup, LargeFaceList a LargePersonGroup.
TakeSnapshotRequest	Text požadavku na operaci pořízení snímku

APIError

Informace o chybě vrácené rozhraním API

Name	Typ	Description
error	Error	Text chyby.

Error

Text chyby.

Name	Typ	Description
code	string
message	string

SnapshotObjectType

Typ zdrojového objektu ve snímku určený odběratelem, který vytvořil snímek při volání příkazu Snímek – Pořízení. V současné době se podporují FaceList, PersonGroup, LargeFaceList a LargePersonGroup.

Name	Typ	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

TakeSnapshotRequest

Text požadavku na operaci pořízení snímku

Name	Typ	Description
applyScope	string[]	Uživatel zadal pole ID cílových předplatných tváří pro snímek. Pro každý snímek ho můžou použít jenom předplatná zahrnutá v applyScope of Snapshot – Take.
objectId	string	Uživatel zadal ID zdrojového objektu, ze které se má pořídit snímek.
type	SnapshotObjectType	Uživatel zadal typ zdrojového objektu, ze které se má pořídit snímek. V současné době se podporují FaceList, PersonGroup, LargeFaceList a LargePersonGroup.
userData	string	Uživatel zadal data o snímku pro libovolný účel. Délka by neměla překročit 16 kB.