FaceListAddFaceFromStreamOptionalParams interface
Optional Parameters.
- Extends
Properties
detection |
Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. Possible values include: 'detection_01', 'detection_02', 'detection_03'. Default value: 'detection_01'. |
target |
A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. |
user |
User-specified data about the face for any purpose. The maximum length is 1KB. |
Inherited Properties
abort |
The signal which can be used to abort requests. |
custom |
User defined custom request headers that will be applied before the request is sent. |
on |
Callback which fires upon download progress. |
on |
Callback which fires upon upload progress. |
timeout | The number of milliseconds a request can take before automatically being terminated. |
Property Details
detectionModel
Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. Possible values include: 'detection_01', 'detection_02', 'detection_03'. Default value: 'detection_01'.
detectionModel?: DetectionModel
Property Value
targetFace
A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.
targetFace?: number[]
Property Value
number[]
userData
User-specified data about the face for any purpose. The maximum length is 1KB.
userData?: string
Property Value
string
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From msRest.RequestOptionsBase.abortSignal
customHeaders
User defined custom request headers that will be applied before the request is sent.
customHeaders?: {[key: string]: string}
Property Value
{[key: string]: string}
Inherited From msRest.RequestOptionsBase.customHeaders
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From msRest.RequestOptionsBase.onUploadProgress
timeout
The number of milliseconds a request can take before automatically being terminated.
timeout?: number
Property Value
number
Inherited From msRest.RequestOptionsBase.timeout