Snapshot - Apply

Služba:

Azure AI Services

Verze rozhraní API:

1.0-preview

Odešlete operaci, která použije snímek pro aktuální předplatné. Pro každý snímek ho můžou použít jenom předplatná zahrnutá v applyScope of Snapshot – Take.
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.
Použití snímku je asynchronní operace. ID operace lze 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 použití snímku. ID cílového objektu se zahrne do pole resourceLocation v části OperationStatus – Get response, pokud je stav operace "úspěch".
Čas použití snímku závisí na počtu osob a obličejů v objektu snímku. Pro 1 000 000 osob s více tvářemi to může být několik sekund nebo až 1 hodina.
Platnost snímků automaticky vyprší a vyčistí se během 48 hodin od vytvoření pomocí funkce Snímek – Pořízení. Proto je potřeba, aby cílové předplatné použilo snímek do 48 hodin od jeho vytvoření.
Použití snímku neblokuje žádné další operace s cílovým objektem, ale nedoporučuje se to, protože během použití snímku nelze zaručit správnost. Po dokončení použití snímku můžou všechny operace vůči cílovému objektu fungovat normálně. Snímek také zahrnuje 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.
Jeden snímek lze použít několikrát paralelně, zatímco aktuálně se podporuje pouze režim použití CreateNew, což znamená, že operace použití selže, pokud cílové předplatné již obsahuje objekt stejného typu a používá stejné objectId. Uživatelé můžou v textu požadavku zadat objectId, aby se zabránilo takovým konfliktům.

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

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

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).
snapshotId	path	True	string uuid	ID odkazující na konkrétní snímek.

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
objectId	True	string	Uživatel zadal ID cílového objektu, který se má vytvořit ze snímku.
mode		SnapshotApplyMode	Režim použití snímku. V současné době se podporuje pouze createNew, což znamená, že operace použití selže, pokud cílové předplatné již obsahuje objekt stejného typu a používá stejný objectId. Uživatelé můžou v textu požadavku zadat objectId, aby se zabránilo takovým konfliktům.

Odpovědi

Name	Typ	Description
202 Accepted		Úloha použití snímku 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

Apply snapshot example

Ukázkový požadavek

HTTP

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


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

Ukázková odpověď

Stavový kód:

202

Definice

Name	Description
APIError	Informace o chybě vrácené rozhraním API
ApplySnapshotRequest	Text požadavku pro použití operace vytvoření snímku
Error	Text chyby.
SnapshotApplyMode	Režim použití snímku. V současné době se podporuje pouze createNew, což znamená, že operace použití selže, pokud cílové předplatné již obsahuje objekt stejného typu a používá stejný objectId. Uživatelé můžou v textu požadavku zadat objectId, aby se zabránilo takovým konfliktům.

APIError

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

Name	Typ	Description
error	Error	Text chyby.

ApplySnapshotRequest

Text požadavku pro použití operace vytvoření snímku

Name	Typ	Default value	Description
mode	SnapshotApplyMode	CreateNew	Režim použití snímku. V současné době se podporuje pouze createNew, což znamená, že operace použití selže, pokud cílové předplatné již obsahuje objekt stejného typu a používá stejný objectId. Uživatelé můžou v textu požadavku zadat objectId, aby se zabránilo takovým konfliktům.
objectId	string		Uživatel zadal ID cílového objektu, který se má vytvořit ze snímku.

Error

Text chyby.

Name	Typ	Description
code	string
message	string

SnapshotApplyMode

Režim použití snímku. V současné době se podporuje pouze createNew, což znamená, že operace použití selže, pokud cílové předplatné již obsahuje objekt stejného typu a používá stejný objectId. Uživatelé můžou v textu požadavku zadat objectId, aby se zabránilo takovým konfliktům.

Name	Typ	Description
CreateNew	string