-
Notifications
You must be signed in to change notification settings - Fork 255
/
com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions.yml
71 lines (67 loc) · 5.27 KB
/
com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
### YamlMime:JavaType
methods:
- fullName: com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withFaceIds(List<UUID> faceIds)
name: withFaceIds(List<UUID> faceIds)
nameWithType: Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withFaceIds(List<UUID> faceIds)
parameters:
- name: faceIds
type: <xref href="List%3CUUID%3E?alt=List%3CUUID%3E&text=List%3CUUID%3E" data-throw-if-not-resolved="False"/>
returns:
description: <p>next definition stage </p>
type: <xref href="FacesFindSimilarDefinitionStages.WithExecute?alt=FacesFindSimilarDefinitionStages.WithExecute&text=FacesFindSimilarDefinitionStages.WithExecute" data-throw-if-not-resolved="False"/>
summary: >-
<p>An array of candidate faceIds. All of them are created by Face - Detect and the faceIds will expire 24 hours after the detection call.</p>
<p></p>
syntax: public FacesFindSimilarDefinitionStages.WithExecute withFaceIds(List<UUID> faceIds)
uid: com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withFaceIds(List<UUID>)
- fullName: com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withFaceListId(String faceListId)
name: withFaceListId(String faceListId)
nameWithType: Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withFaceListId(String faceListId)
parameters:
- name: faceListId
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
returns:
description: <p>next definition stage </p>
type: <xref href="FacesFindSimilarDefinitionStages.WithExecute?alt=FacesFindSimilarDefinitionStages.WithExecute&text=FacesFindSimilarDefinitionStages.WithExecute" data-throw-if-not-resolved="False"/>
summary: >-
<p>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.</p>
<p></p>
syntax: public FacesFindSimilarDefinitionStages.WithExecute withFaceListId(String faceListId)
uid: com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withFaceListId(String)
- fullName: com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withMaxNumOfCandidatesReturned(Integer maxNumOfCandidatesReturned)
name: withMaxNumOfCandidatesReturned(Integer maxNumOfCandidatesReturned)
nameWithType: Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withMaxNumOfCandidatesReturned(Integer maxNumOfCandidatesReturned)
parameters:
- name: maxNumOfCandidatesReturned
type: <xref href="Integer?alt=Integer&text=Integer" data-throw-if-not-resolved="False"/>
returns:
description: <p>next definition stage </p>
type: <xref href="FacesFindSimilarDefinitionStages.WithExecute?alt=FacesFindSimilarDefinitionStages.WithExecute&text=FacesFindSimilarDefinitionStages.WithExecute" data-throw-if-not-resolved="False"/>
summary: >-
<p>The number of top similar faces returned. The valid range is [1, 1000].</p>
<p></p>
syntax: public FacesFindSimilarDefinitionStages.WithExecute withMaxNumOfCandidatesReturned(Integer maxNumOfCandidatesReturned)
uid: com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withMaxNumOfCandidatesReturned(Integer)
- fullName: com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withMode(FindSimilarMatchMode mode)
name: withMode(FindSimilarMatchMode mode)
nameWithType: Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withMode(FindSimilarMatchMode mode)
parameters:
- name: mode
type: <xref href="com.microsoft.azure.cognitiveservices.vision.faceapi.models.FindSimilarMatchMode?alt=com.microsoft.azure.cognitiveservices.vision.faceapi.models.FindSimilarMatchMode&text=FindSimilarMatchMode" data-throw-if-not-resolved="False"/>
returns:
description: <p>next definition stage </p>
type: <xref href="FacesFindSimilarDefinitionStages.WithExecute?alt=FacesFindSimilarDefinitionStages.WithExecute&text=FacesFindSimilarDefinitionStages.WithExecute" data-throw-if-not-resolved="False"/>
summary: >-
<p>Similar face searching mode. It can be "matchPerson" or "matchFace". Possible values include: 'matchPerson', 'matchFace'.</p>
<p></p>
syntax: public FacesFindSimilarDefinitionStages.WithExecute withMode(FindSimilarMatchMode mode)
uid: com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions.withMode(FindSimilarMatchMode)
nameWithType: Faces.FacesFindSimilarDefinitionStages.WithAllOptions
syntax: public interface WithAllOptions
type: interface
uid: com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions
fullName: com.microsoft.azure.cognitiveservices.vision.faceapi.Faces.FacesFindSimilarDefinitionStages.WithAllOptions
name: Faces.FacesFindSimilarDefinitionStages.WithAllOptions
package: com.microsoft.azure.cognitiveservices.vision.faceapi
summary: <p>The stage of the definition which allows for any other optional settings to be specified. </p>
metadata: {}