FaceIdentifyOptionalParams interface

Package:

@azure/cognitiveservices-face

Optional Parameters.

Extends

RequestOptionsBase

Properties

confidenceThreshold	Confidence threshold of identification, used to judge whether one face belong to one person. The range of confidenceThreshold is [0, 1] (default specified by algorithm).
largePersonGroupId	LargePersonGroupId of the target large person group, created by LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.
maxNumOfCandidatesReturned	The range of maxNumOfCandidatesReturned is between 1 and 100 (default is 1). Default value: 1.
personGroupId	PersonGroupId of the target person group, created by PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
timeout	The number of milliseconds a request can take before automatically being terminated.

Property Details

confidenceThreshold

Confidence threshold of identification, used to judge whether one face belong to one person. The range of confidenceThreshold is [0, 1] (default specified by algorithm).

confidenceThreshold?: number

Property Value

number

largePersonGroupId

LargePersonGroupId of the target large person group, created by LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

largePersonGroupId?: string

Property Value

string

maxNumOfCandidatesReturned

The range of maxNumOfCandidatesReturned is between 1 and 100 (default is 1). Default value: 1.

maxNumOfCandidatesReturned?: number

Property Value

number

personGroupId

PersonGroupId of the target person group, created by PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

personGroupId?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

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