Snapshot - Update
스냅샷 정보를 업데이트합니다. 스냅샷 가져온 원본 구독만 스냅샷 업데이트할 수 있습니다.
PATCH {Endpoint}/face/v1.0-preview/snapshots/{snapshotId}
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus.api.cognitive.microsoft.com). |
snapshot
|
path | True |
string uuid |
특정 스냅샷 참조하는 ID입니다. |
요청 헤더
Name | 필수 | 형식 | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
요청 본문
Name | 형식 | Description |
---|---|---|
applyScope |
string[] |
스냅샷 - 테이크를 호출할 때 스냅샷 만든 사용자가 지정한 스냅샷 대상 Face 구독 ID의 배열입니다. 각 스냅샷 대해 스냅샷의 applyScope - Take에 포함된 구독만 적용할 수 있습니다. |
userData |
string |
모든 용도로 스냅샷 대한 사용자가 지정한 데이터입니다. 길이는 16KB를 초과하면 안 됩니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
호출이 성공하면 빈 응답 본문이 반환됩니다. |
|
Other Status Codes |
오류 응답입니다. |
보안
Ocp-Apim-Subscription-Key
형식:
apiKey
In(다음 안에):
header
예제
Update snapshot example
샘플 요청
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."
}
샘플 응답
정의
Name | Description |
---|---|
APIError |
API에서 반환된 오류 정보 |
Error |
오류 본문입니다. |
Update |
사용자 정의 적용 scope 및 사용자 지정 데이터의 조합으로 스냅샷 업데이트하기 위한 요청 본문입니다. |
APIError
API에서 반환된 오류 정보
Name | 형식 | Description |
---|---|---|
error |
오류 본문입니다. |
Error
오류 본문입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
|
message |
string |
UpdateSnapshotRequest
사용자 정의 적용 scope 및 사용자 지정 데이터의 조합으로 스냅샷 업데이트하기 위한 요청 본문입니다.
Name | 형식 | Description |
---|---|---|
applyScope |
string[] |
스냅샷 - 테이크를 호출할 때 스냅샷 만든 사용자가 지정한 스냅샷 대상 Face 구독 ID의 배열입니다. 각 스냅샷 대해 스냅샷의 applyScope - Take에 포함된 구독만 적용할 수 있습니다. |
userData |
string |
모든 용도로 스냅샷 대한 사용자가 지정한 데이터입니다. 길이는 16KB를 초과하면 안 됩니다. |