TakeSnapshotRequest interface

Package:

@azure/cognitiveservices-face

Request body for taking snapshot operation.

Properties

applyScope	User specified array of target Face subscription ids for the snapshot. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
objectId	User specified source object id to take snapshot from.
type	User specified type for the source object to take snapshot from. 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

applyScope

User specified array of target Face subscription ids for the snapshot. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.

applyScope: string[]

Property Value

string[]

objectId

User specified source object id to take snapshot from.

objectId: string

Property Value

string

type

User specified type for the source object to take snapshot from. 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