Faces.FacesFindSimilarDefinitionStages.WithAllOptions Interface

Package:

com.microsoft.azure.cognitiveservices.vision.faceapi

public interface WithAllOptions

The stage of the definition which allows for any other optional settings to be specified.

Method Summary

Modifier and Type	Method and Description
FacesFindSimilarDefinitionStages.WithExecute	withFaceIds(List<UUID> faceIds) An array of candidate faceIds. All of them are created by Face - Detect and the faceIds will expire 24 hours after the detection call.
FacesFindSimilarDefinitionStages.WithExecute	withFaceListId(String faceListId) An existing user-specified unique candidate face list, created in Face List - Create a Face List. Face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId and faceIds should not be provided at the same time.
FacesFindSimilarDefinitionStages.WithExecute	withMaxNumOfCandidatesReturned(Integer maxNumOfCandidatesReturned) The number of top similar faces returned. The valid range is [1, 1000].
FacesFindSimilarDefinitionStages.WithExecute	withMode(FindSimilarMatchMode mode) Similar face searching mode. It can be "matchPerson" or "matchFace". Possible values include: 'matchPerson', 'matchFace'.

Method Details

withFaceIds

public FacesFindSimilarDefinitionStages.WithExecute withFaceIds(List faceIds)

An array of candidate faceIds. All of them are created by Face - Detect and the faceIds will expire 24 hours after the detection call.

Parameters:

faceIds

Returns:

next definition stage

withFaceListId

public FacesFindSimilarDefinitionStages.WithExecute withFaceListId(String faceListId)

An existing user-specified unique candidate face list, created in Face List - Create a Face List. Face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId and faceIds should not be provided at the same time.

Parameters:

faceListId

Returns:

next definition stage

withMaxNumOfCandidatesReturned

public FacesFindSimilarDefinitionStages.WithExecute withMaxNumOfCandidatesReturned(Integer maxNumOfCandidatesReturned)

The number of top similar faces returned. The valid range is [1, 1000].

Parameters:

maxNumOfCandidatesReturned

Returns:

next definition stage

withMode

public FacesFindSimilarDefinitionStages.WithExecute withMode(FindSimilarMatchMode mode)

Similar face searching mode. It can be "matchPerson" or "matchFace". Possible values include: 'matchPerson', 'matchFace'.

Parameters:

mode

Returns:

next definition stage