Snapshot - Update

服務:

Azure AI Services

API 版本:

1.0-preview

更新快照集的資訊。 只有建立快照集的來源訂用帳戶可以更新快照集。

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

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
applyScope	string[]	快照集的目標臉部訂用帳戶標識碼陣列，由呼叫快照集 - 擷取時建立快照集的使用者所指定。 針對每個快照集，只有包含於 Snapshot 的 applyScope - Take 中的訂用帳戶可以套用它。
userData	string	用戶針對任何用途指定快照集的相關數據。 長度不應超過 16KB。

回應

名稱	類型	Description
200 OK		成功的呼叫會傳回空的回應本文。
Other Status Codes	APIError	錯誤回應。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

Update snapshot example

範例要求

HTTP

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


{
  "applyScope": [
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot."
}

範例回覆

狀態碼:

200

定義

名稱	Description
APIError	API 傳回的錯誤資訊
Error	錯誤本文。
UpdateSnapshotRequest	要求更新快照集的本文，並結合使用者定義套用範圍和使用者指定的數據。

APIError

API 傳回的錯誤資訊

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

Error

錯誤本文。

名稱	類型	Description
code	string
message	string

UpdateSnapshotRequest

要求更新快照集的本文，並結合使用者定義套用範圍和使用者指定的數據。

名稱	類型	Description
applyScope	string[]	快照集的目標臉部訂用帳戶標識碼陣列，由呼叫快照集 - 擷取時建立快照集的使用者所指定。 針對每個快照集，只有包含於 Snapshot 的 applyScope - Take 中的訂用帳戶可以套用它。
userData	string	用戶針對任何用途指定快照集的相關數據。 長度不應超過 16KB。