FindSimilarRequest Class

Definition

Namespace:

Microsoft.Azure.CognitiveServices.Vision.Face.Models

Assembly:

Microsoft.Azure.CognitiveServices.Vision.Face.dll

Package:

Microsoft.Azure.CognitiveServices.Vision.Face v2.8.0-preview.3

Source:

FindSimilarRequest.cs

Request body for find similar operation.

public class FindSimilarRequest

type FindSimilarRequest = class

Public Class FindSimilarRequest

Inheritance

Object

FindSimilarRequest

Constructors

FindSimilarRequest()	Initializes a new instance of the FindSimilarRequest class.
FindSimilarRequest(Guid, String, String, IList<Nullable<Guid>>, Nullable<Int32>, FindSimilarMatchMode)	Initializes a new instance of the FindSimilarRequest class.

Properties

FaceId	Gets or sets faceId of the query face. User needs to call Face - Detect first to get a valid faceId. Note that this faceId is not persisted and will expire 24 hours after the detection call
FaceIds	Gets or sets an array of candidate faceIds. All of them are created by Face - Detect and the faceIds will expire 24 hours after the detection call. The number of faceIds is limited to 1000. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.
FaceListId	Gets or sets 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, largeFaceListId and faceIds should not be provided at the same time.
LargeFaceListId	Gets or sets an existing user-specified unique candidate large face list, created in LargeFaceList - Create. Large face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.
MaxNumOfCandidatesReturned	Gets or sets the number of top similar faces returned. The valid range is [1, 1000].
Mode	Gets or sets similar face searching mode. It can be "matchPerson" or "matchFace". Possible values include: 'matchPerson', 'matchFace'

Methods

Validate()

Validate the object.