SnapshotOperations class
SnapshotOperations를 나타내는 클래스입니다.
생성자
| Snapshot |
SnapshotOperations를 만듭니다. |
메서드
| apply(string, string, Service |
|
| apply(string, string, Snapshot |
현재 구독에 스냅샷을 적용하는 작업을 제출합니다. 각 스냅샷에 대해 스냅샷의 applyScope - Take에 포함된 구독만 적용할 수 있습니다.
|
| apply(string, string, Snapshot |
|
| delete |
snapshotId에 따라 기존 스냅샷을 삭제합니다. 스냅샷의 모든 개체 데이터 및 정보도 삭제됩니다. 스냅샷을 생성한 원본 구독만 스냅샷을 삭제할 수 있습니다. 사용자가 이 API를 사용하여 스냅샷을 삭제하지 않으면 만든 후 48시간 후에도 스냅샷이 자동으로 삭제됩니다. |
| delete |
|
| delete |
|
| get(string, Request |
스냅샷에 대한 정보를 검색합니다. 스냅샷은 스냅샷을 가져온 원본 구독과 스냅샷 - 테이크의 applyScope에 포함된 대상 구독에서만 액세스할 수 있습니다. |
| get(string, Request |
|
| get(string, Service |
|
| get |
스냅샷 만들기/적용 작업의 상태를 검색합니다. |
| get |
|
| get |
|
| list(Service |
|
| list(Snapshot |
사용자가 찍은 스냅샷 또는 사용자에게 적용할 스냅샷을 포함하여 관련 정보가 포함된 액세스 가능한 모든 스냅샷을 나열합니다(구독 ID는 스냅샷의 applyScope에 포함됨 - 가져오기). |
| list(Snapshot |
|
| take(Snapshot |
|
| take(Snapshot |
사용자 지정 스냅샷 유형, 원본 개체 ID, 범위 및 선택적 사용자 데이터를 사용하여 얼굴 목록, 큰 얼굴 목록, 사람 그룹 또는 큰 사람 그룹의 스냅샷을 만드는 작업을 제출합니다.
|
| take(Snapshot |
|
| update(string, Service |
|
| update(string, Snapshot |
스냅샷의 정보를 업데이트합니다. 스냅샷을 생성한 원본 구독만 스냅샷을 업데이트할 수 있습니다. |
| update(string, Snapshot |
생성자 세부 정보
SnapshotOperations(FaceClientContext)
SnapshotOperations를 만듭니다.
new SnapshotOperations(client: FaceClientContext)매개 변수
- client
- FaceClientContext
서비스 클라이언트에 대한 참조입니다.
메서드 세부 정보
apply(string, string, ServiceCallback<void>)
function apply(snapshotId: string, objectId: string, callback: ServiceCallback<void>)매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- objectId
-
string
스냅샷에서 만들 사용자 지정 대상 개체 ID입니다.
- callback
-
ServiceCallback<void>
콜백
apply(string, string, SnapshotApplyOptionalParams)
현재 구독에 스냅샷을 적용하는 작업을 제출합니다. 각 스냅샷에 대해 스냅샷의 applyScope - Take에 포함된 구독만 적용할 수 있습니다.
스냅샷 인터페이스는 사용자가 한 얼굴 구독에서 다른 얼굴 구독, 동일한 지역 내부 또는 지역 간에 얼굴 데이터를 백업하고 복원하는 데 사용됩니다. 워크플로에는 두 단계가 포함되어 있습니다. 사용자는 먼저 Snapshot - Take를 호출하여 원본 개체의 복사본을 만들고 스냅샷으로 저장한 다음 스냅샷 - 적용을 호출하여 대상 구독에 스냅샷을 붙여넣습니다. 스냅샷은 계정 및 지역 간을 적용할 수 있도록 중앙 집중식 위치(Azure 인스턴스당)에 저장됩니다.
스냅샷 적용은 비동기 작업입니다. 작업 ID는 응답 헤더의 "Operation-Location" 필드에서 가져와서 OperationStatus - 스냅샷 적용 진행률을 추적하는 데 사용할 수 있습니다. 대상 개체 ID는 OperationStatus - 작업 상태가 "성공"일 때 응답 가져오기의 "resourceLocation" 필드에 포함됩니다.
스냅샷 적용 시간은 스냅샷 개체의 사람 및 얼굴 항목 수에 따라 달라집니다.
여러 얼굴을 가진 1,000,000명의 사람에게는 초 또는 최대 1시간이 될 수 있습니다.
스냅샷이 만든 후 48시간 후에 스냅샷이 자동으로 만료되고 정리됩니다.
- 가져 가라. 따라서 대상 구독은 만든 후 48시간 후에 스냅샷을 적용해야 합니다.
스냅샷을 적용해도 대상 개체에 대한 다른 작업은 차단되지 않지만 스냅샷을 적용하는 동안 정확성을 보장할 수 없으므로 권장되지 않습니다. 스냅샷 적용이 완료되면 대상 개체에 대한 모든 작업이 정상적으로 작동할 수 있습니다. 스냅샷에는 원본 개체의 학습 결과도 포함됩니다. 즉, 대상 구독에 적용된 스냅샷은 Identify/FindSimilar를 호출하기 전에 대상 개체를 다시 학습할 필요가 없습니다.
하나의 스냅샷을 병렬로 여러 번 적용할 수 있지만 현재 CreateNew 적용 모드만 지원됩니다. 즉, 대상 구독에 동일한 형식의 개체가 이미 있고 동일한 objectId를 사용하는 경우 적용 작업이 실패합니다. 사용자는 이러한 충돌을 방지하기 위해 요청 본문에 "objectId"를 지정할 수 있습니다.
- 무료 계층 구독 할당량: 매월 100개 적용 작업.
- S0 계층 구독 할당량: 하루에 100개 적용 작업.
function apply(snapshotId: string, objectId: string, options?: SnapshotApplyOptionalParams): Promise<SnapshotApplyResponse>매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- objectId
-
string
스냅샷에서 만들 사용자 지정 대상 개체 ID입니다.
- options
- SnapshotApplyOptionalParams
선택적 매개 변수
반환
Promise<SnapshotApplyResponse>
Promise<Models.SnapshotApplyResponse>
apply(string, string, SnapshotApplyOptionalParams, ServiceCallback<void>)
function apply(snapshotId: string, objectId: string, options: SnapshotApplyOptionalParams, callback: ServiceCallback<void>)매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- objectId
-
string
스냅샷에서 만들 사용자 지정 대상 개체 ID입니다.
- options
- SnapshotApplyOptionalParams
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백
deleteMethod(string, RequestOptionsBase)
snapshotId에 따라 기존 스냅샷을 삭제합니다. 스냅샷의 모든 개체 데이터 및 정보도 삭제됩니다. 스냅샷을 생성한 원본 구독만 스냅샷을 삭제할 수 있습니다. 사용자가 이 API를 사용하여 스냅샷을 삭제하지 않으면 만든 후 48시간 후에도 스냅샷이 자동으로 삭제됩니다.
function deleteMethod(snapshotId: string, options?: RequestOptionsBase): Promise<RestResponse>매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- options
- RequestOptionsBase
선택적 매개 변수
반환
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(snapshotId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- options
- RequestOptionsBase
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(snapshotId: string, callback: ServiceCallback<void>)매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- callback
-
ServiceCallback<void>
콜백
get(string, RequestOptionsBase)
스냅샷에 대한 정보를 검색합니다. 스냅샷은 스냅샷을 가져온 원본 구독과 스냅샷 - 테이크의 applyScope에 포함된 대상 구독에서만 액세스할 수 있습니다.
function get(snapshotId: string, options?: RequestOptionsBase): Promise<SnapshotGetResponse>매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- options
- RequestOptionsBase
선택적 매개 변수
반환
Promise<SnapshotGetResponse>
Promise<Models.SnapshotGetResponse>
get(string, RequestOptionsBase, ServiceCallback<Snapshot>)
function get(snapshotId: string, options: RequestOptionsBase, callback: ServiceCallback<Snapshot>)매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- options
- RequestOptionsBase
선택적 매개 변수
- callback
콜백
get(string, ServiceCallback<Snapshot>)
function get(snapshotId: string, callback: ServiceCallback<Snapshot>)매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- callback
콜백
getOperationStatus(string, RequestOptionsBase)
스냅샷 만들기/적용 작업의 상태를 검색합니다.
function getOperationStatus(operationId: string, options?: RequestOptionsBase): Promise<SnapshotGetOperationStatusResponse>매개 변수
- operationId
-
string
특정 스냅샷 만들기/적용 작업을 참조하는 ID입니다.
- options
- RequestOptionsBase
선택적 매개 변수
반환
Promise<SnapshotGetOperationStatusResponse>
Promise<Models.SnapshotGetOperationStatusResponse>
getOperationStatus(string, RequestOptionsBase, ServiceCallback<OperationStatus>)
function getOperationStatus(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<OperationStatus>)매개 변수
- operationId
-
string
특정 스냅샷 만들기/적용 작업을 참조하는 ID입니다.
- options
- RequestOptionsBase
선택적 매개 변수
- callback
콜백
getOperationStatus(string, ServiceCallback<OperationStatus>)
function getOperationStatus(operationId: string, callback: ServiceCallback<OperationStatus>)매개 변수
- operationId
-
string
특정 스냅샷 만들기/적용 작업을 참조하는 ID입니다.
- callback
콜백
list(ServiceCallback<Snapshot[]>)
list(SnapshotListOptionalParams)
사용자가 찍은 스냅샷 또는 사용자에게 적용할 스냅샷을 포함하여 관련 정보가 포함된 액세스 가능한 모든 스냅샷을 나열합니다(구독 ID는 스냅샷의 applyScope에 포함됨 - 가져오기).
function list(options?: SnapshotListOptionalParams): Promise<SnapshotListResponse>매개 변수
- options
- SnapshotListOptionalParams
선택적 매개 변수
반환
Promise<SnapshotListResponse>
Promise<Models.SnapshotListResponse>
list(SnapshotListOptionalParams, ServiceCallback<Snapshot[]>)
function list(options: SnapshotListOptionalParams, callback: ServiceCallback<Snapshot[]>)매개 변수
- options
- SnapshotListOptionalParams
선택적 매개 변수
- callback
콜백
take(SnapshotObjectType, string, string[], ServiceCallback<void>)
function take(type: SnapshotObjectType, objectId: string, applyScope: string[], callback: ServiceCallback<void>)매개 변수
- type
- SnapshotObjectType
스냅샷을 생성할 원본 개체에 대해 사용자가 지정한 형식입니다. 현재 FaceList, PersonGroup, LargeFaceList 및 LargePersonGroup이 지원됩니다. 가능한 값은 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'입니다.
- objectId
-
string
스냅샷을 생성할 사용자가 지정한 원본 개체 ID입니다.
- applyScope
-
string[]
스냅샷에 대해 사용자가 지정한 대상 Face 구독 ID 배열입니다. 각 스냅샷에 대해 스냅샷의 applyScope - Take에 포함된 구독만 적용할 수 있습니다.
- callback
-
ServiceCallback<void>
콜백
take(SnapshotObjectType, string, string[], SnapshotTakeOptionalParams)
사용자 지정 스냅샷 유형, 원본 개체 ID, 범위 및 선택적 사용자 데이터를 사용하여 얼굴 목록, 큰 얼굴 목록, 사람 그룹 또는 큰 사람 그룹의 스냅샷을 만드는 작업을 제출합니다.
스냅샷 인터페이스는 사용자가 한 얼굴 구독에서 다른 얼굴 구독, 동일한 지역 내부 또는 지역 간에 얼굴 데이터를 백업하고 복원하는 데 사용됩니다. 워크플로에는 두 단계가 포함되어 있습니다. 사용자는 먼저 Snapshot - Take를 호출하여 원본 개체의 복사본을 만들고 스냅샷으로 저장한 다음 스냅샷 - 적용을 호출하여 대상 구독에 스냅샷을 붙여넣습니다. 스냅샷은 계정 및 지역 간을 적용할 수 있도록 중앙 집중식 위치(Azure 인스턴스당)에 저장됩니다.
스냅샷 만들기는 비동기 작업입니다. 작업 ID는 응답 헤더의 "Operation-Location" 필드에서 가져와서 OperationStatus - 스냅샷 만들기 진행률을 추적하는 데 사용할 수 있습니다. 스냅샷 ID는 OperationStatus - 작업 상태가 "성공"일 때 응답 가져오기의 "resourceLocation" 필드에 포함됩니다.
스냅샷 생성 시간은 원본 개체의 사람 및 얼굴 항목 수에 따라 달라집니다. 그것은 초, 또는 여러 얼굴을 가진 1,000,000 사람에 대 한 몇 시간까지 수 있습니다.
스냅샷이 만든 후 48시간 후에 스냅샷이 자동으로 만료되고 정리됩니다.
- 가져 가라. 사용자는 만료 전 언제든지 스냅샷 - 삭제를 사용하여 스냅샷을 삭제할 수 있습니다.
특정 개체에 대한 스냅샷을 만들면 개체에 대한 다른 작업이 차단되지 않습니다. 모든 읽기 전용 작업(Get/List 및 Identify/FindSimilar/Verify)은 평소와 같이 수행할 수 있습니다. 원본 개체 또는 사람/얼굴 추가/업데이트/삭제 및 학습을 비롯한 모든 쓰기 가능한 작업의 경우 쓰기 가능한 업데이트가 스냅샷에 반영되지 않을 수 있으므로 차단되지는 않지만 권장되지 않습니다. 스냅샷 만들기가 완료되면 읽기 가능하고 쓰기 가능한 모든 작업이 정상적으로 작동할 수 있습니다. 스냅샷에는 원본 개체의 학습 결과도 포함됩니다. 즉, 대상 구독에 적용된 스냅샷은 Identify/FindSimilar를 호출하기 전에 대상 개체를 다시 학습할 필요가 없습니다.
- 무료 계층 구독 할당량: 매월 100회 작업을 수행합니다.
- S0 계층 구독 할당량: 하루에 100회 작업을 수행합니다.
function take(type: SnapshotObjectType, objectId: string, applyScope: string[], options?: SnapshotTakeOptionalParams): Promise<SnapshotTakeResponse>매개 변수
- type
- SnapshotObjectType
스냅샷을 생성할 원본 개체에 대해 사용자가 지정한 형식입니다. 현재 FaceList, PersonGroup, LargeFaceList 및 LargePersonGroup이 지원됩니다. 가능한 값은 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'입니다.
- objectId
-
string
스냅샷을 생성할 사용자가 지정한 원본 개체 ID입니다.
- applyScope
-
string[]
스냅샷에 대해 사용자가 지정한 대상 Face 구독 ID 배열입니다. 각 스냅샷에 대해 스냅샷의 applyScope - Take에 포함된 구독만 적용할 수 있습니다.
- options
- SnapshotTakeOptionalParams
선택적 매개 변수
반환
Promise<SnapshotTakeResponse>
Promise<Models.SnapshotTakeResponse>
take(SnapshotObjectType, string, string[], SnapshotTakeOptionalParams, ServiceCallback<void>)
function take(type: SnapshotObjectType, objectId: string, applyScope: string[], options: SnapshotTakeOptionalParams, callback: ServiceCallback<void>)매개 변수
- type
- SnapshotObjectType
스냅샷을 생성할 원본 개체에 대해 사용자가 지정한 형식입니다. 현재 FaceList, PersonGroup, LargeFaceList 및 LargePersonGroup이 지원됩니다. 가능한 값은 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'입니다.
- objectId
-
string
스냅샷을 생성할 사용자가 지정한 원본 개체 ID입니다.
- applyScope
-
string[]
스냅샷에 대해 사용자가 지정한 대상 Face 구독 ID 배열입니다. 각 스냅샷에 대해 스냅샷의 applyScope - Take에 포함된 구독만 적용할 수 있습니다.
- options
- SnapshotTakeOptionalParams
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백
update(string, ServiceCallback<void>)
function update(snapshotId: string, callback: ServiceCallback<void>)매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- callback
-
ServiceCallback<void>
콜백
update(string, SnapshotUpdateOptionalParams)
스냅샷의 정보를 업데이트합니다. 스냅샷을 생성한 원본 구독만 스냅샷을 업데이트할 수 있습니다.
function update(snapshotId: string, options?: SnapshotUpdateOptionalParams): Promise<RestResponse>매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- options
- SnapshotUpdateOptionalParams
선택적 매개 변수
반환
Promise<RestResponse>
Promise<msRest.RestResponse>
update(string, SnapshotUpdateOptionalParams, ServiceCallback<void>)
function update(snapshotId: string, options: SnapshotUpdateOptionalParams, callback: ServiceCallback<void>)매개 변수
- snapshotId
-
string
특정 스냅샷을 참조하는 ID입니다.
- options
- SnapshotUpdateOptionalParams
선택적 매개 변수
- callback
-
ServiceCallback<void>
콜백