Share via

Snapshot interface

  • Reference
Package:
@azure/cognitiveservices-face

Snapshot object.

Properties

account

Azure Cognitive Service Face account id of the subscriber who created the snapshot by Snapshot

  • Take.
applyScope

Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
createdTime

A combined UTC date and time string that describes the created time of the snapshot. E.g. 2018-12-25T11:41:02.2331413Z.
id

Snapshot id.
lastUpdateTime

A combined UTC date and time string that describes the last time when the snapshot was created or updated by Snapshot - Update. E.g. 2018-12-25T11:51:27.8705696Z.
type

Type of the source object in the snapshot, specified by the subscriber who created the snapshot when calling Snapshot - Take. Currently FaceList, PersonGroup, LargeFaceList and LargePersonGroup are supported. Possible values include: 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'
userData

User specified data about the snapshot for any purpose. Length should not exceed 16KB.

Property Details

account

Azure Cognitive Service Face account id of the subscriber who created the snapshot by Snapshot

  • Take.
account: string

Property Value

string

applyScope

Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.

applyScope: string[]

Property Value

string[]

createdTime

A combined UTC date and time string that describes the created time of the snapshot. E.g. 2018-12-25T11:41:02.2331413Z.

createdTime: Date

Property Value

Date

id

Snapshot id.

id: string

Property Value

string

lastUpdateTime

A combined UTC date and time string that describes the last time when the snapshot was created or updated by Snapshot - Update. E.g. 2018-12-25T11:51:27.8705696Z.

lastUpdateTime: Date

Property Value

Date

type

Type of the source object in the snapshot, specified by the subscriber who created the snapshot when calling Snapshot - Take. Currently FaceList, PersonGroup, LargeFaceList and LargePersonGroup are supported. Possible values include: 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'

type: SnapshotObjectType

Property Value

SnapshotObjectType

userData

User specified data about the snapshot for any purpose. Length should not exceed 16KB.

userData?: string

Property Value

string