FindSimilarRequest Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| 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. |
FindSimilarRequest()
- Source:
- FindSimilarRequest.cs
Initializes a new instance of the FindSimilarRequest class.
public FindSimilarRequest ();Public Sub New ()Applies to
FindSimilarRequest(Guid, String, String, IList<Nullable<Guid>>, Nullable<Int32>, FindSimilarMatchMode)
- Source:
- FindSimilarRequest.cs
Initializes a new instance of the FindSimilarRequest class.
public FindSimilarRequest (Guid faceId, string faceListId = default, string largeFaceListId = default, System.Collections.Generic.IList<Guid?> faceIds = default, int? maxNumOfCandidatesReturned = default, Microsoft.Azure.CognitiveServices.Vision.Face.Models.FindSimilarMatchMode mode = Microsoft.Azure.CognitiveServices.Vision.Face.Models.FindSimilarMatchMode.MatchPerson);new Microsoft.Azure.CognitiveServices.Vision.Face.Models.FindSimilarRequest : Guid * string * string * System.Collections.Generic.IList<Nullable<Guid>> * Nullable<int> * Microsoft.Azure.CognitiveServices.Vision.Face.Models.FindSimilarMatchMode -> Microsoft.Azure.CognitiveServices.Vision.Face.Models.FindSimilarRequestPublic Sub New (faceId As Guid, Optional faceListId As String = Nothing, Optional largeFaceListId As String = Nothing, Optional faceIds As IList(Of Nullable(Of Guid)) = Nothing, Optional maxNumOfCandidatesReturned As Nullable(Of Integer) = Nothing, Optional mode As FindSimilarMatchMode = Microsoft.Azure.CognitiveServices.Vision.Face.Models.FindSimilarMatchMode.MatchPerson)Parameters
- faceId
- Guid
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
- faceListId
- String
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
- String
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.
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.
The number of top similar faces returned. The valid range is [1, 1000].
- mode
- FindSimilarMatchMode
Similar face searching mode. It can be "matchPerson" or "matchFace". Possible values include: 'matchPerson', 'matchFace'
