IdentifyRequest interface

Package:

@azure/cognitiveservices-face

Request body for identify face operation.

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).
faceIds	Array of query faces faceIds, created by the Face - Detect. Each of the faces are identified independently. The valid number of faceIds is between [1, 10].
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.

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

faceIds

Array of query faces faceIds, created by the Face - Detect. Each of the faces are identified independently. The valid number of faceIds is between [1, 10].

faceIds: string[]

Property Value

string[]

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