Snapshot - Apply

服務:

Azure AI Services

API 版本:

1.0-preview

提交作業以將快照集套用至目前的訂用帳戶。 對於每個快照集，只有套用快照集範圍中包含的訂用帳戶 - 擷取可以套用它。
快照集介面可讓使用者從一個臉部訂用帳戶備份並還原其臉部數據，並還原到另一個臉部訂用帳戶、位於相同區域或跨區域。 工作流程包含兩個階段，使用者會先呼叫 Snapshot - Take 來建立來源對象的複本，並將其儲存為快照集，然後呼叫 Snapshot - Apply 將快照集貼到目標訂用帳戶。 快照集會儲存在每個 Azure 實例) 集中位置 (，以便跨帳戶和區域套用快照集。
套用快照集是異步操作。 作業標識碼可以從響應標頭中的 [作業位置] 欄位取得，以用於 OperationStatus - 取得以追蹤套用快照集的進度。 當作業狀態為「成功」時，目標對象標識碼將會包含在 OperationStatus - 取得回應的 「resourceLocation」 字段中。
快照集套用時間取決於快照集物件中的人員和臉部項目數目。 其可能為秒數，或最多 1 小時，1,000,000 人具有多個臉部。
快照集會在快照集 - 擷取建立快照集之後，於 48 小時內自動過期並清除。 因此，必須在建立后 48 小時內套用快照集的目標訂用帳戶。
套用快照集不會封鎖目標物件的任何其他作業，但不建議這麼做，因為在套用快照集期間無法保證正確性。 完成快照集套用之後，目標物件的所有作業都可以正常運作。 快照集也包含來源物件的定型結果，這表示在呼叫Identify/FindSimilar之前，套用快照集的目標訂用帳戶不需要重新定型目標物件。
一個快照集可以平行套用多次，而目前僅支援 CreateNew 套用模式，這表示如果目標訂用帳戶已經包含相同類型的物件並使用相同的 objectId，則套用作業將會失敗。 用戶可以在要求本文中指定 「objectId」，以避免這類衝突。

• 免費層訂用帳戶配額：每月 100 個套用作業。
• S0 層訂用帳戶配額：每天套用 100 個作業。

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

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus.api.cognitive.microsoft.com) 。
snapshotId	path	True	string uuid	參考特定快照集的標識碼。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

要求本文

名稱	必要	類型	Description
objectId	True	string	要從快照集建立的使用者指定目標物件標識碼。
mode		SnapshotApplyMode	快照集套用模式。 目前僅支援 CreateNew，這表示如果目標訂用帳戶已經包含相同類型的物件，且使用相同的 objectId，則套用作業將會失敗。 用戶可以在要求本文中指定 「objectId」，以避免這類衝突。

回應

名稱	類型	Description
202 Accepted		套用工作的快照集已成功排入佇列。 標題 Operation-Location: string
Other Status Codes	APIError	錯誤回應。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

Apply snapshot example

範例要求

HTTP

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


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

範例回覆

狀態碼:

202

定義

名稱	Description
APIError	API 傳回的錯誤資訊
ApplySnapshotRequest	套用快照集作業的要求本文。
Error	錯誤本文。
SnapshotApplyMode	快照集套用模式。 目前僅支援 CreateNew，這表示如果目標訂用帳戶已經包含相同類型的物件，且使用相同的 objectId，則套用作業將會失敗。 用戶可以在要求本文中指定 「objectId」，以避免這類衝突。

APIError

API 傳回的錯誤資訊

名稱	類型	Description
error	Error	錯誤本文。

ApplySnapshotRequest

套用快照集作業的要求本文。

名稱	類型	預設值	Description
mode	SnapshotApplyMode	CreateNew	快照集套用模式。 目前僅支援 CreateNew，這表示如果目標訂用帳戶已經包含相同類型的物件，且使用相同的 objectId，則套用作業將會失敗。 用戶可以在要求本文中指定 「objectId」，以避免這類衝突。
objectId	string		要從快照集建立的使用者指定目標物件標識碼。

Error

錯誤本文。

名稱	類型	Description
code	string
message	string

SnapshotApplyMode

快照集套用模式。 目前僅支援 CreateNew，這表示如果目標訂用帳戶已經包含相同類型的物件，且使用相同的 objectId，則套用作業將會失敗。 用戶可以在要求本文中指定 「objectId」，以避免這類衝突。

名稱	類型	Description
CreateNew	string