-
Notifications
You must be signed in to change notification settings - Fork 180
/
FaceModels.SimilarFace.yml
58 lines (55 loc) · 1.71 KB
/
FaceModels.SimilarFace.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
### YamlMime:TSType
name: SimilarFace
uid: '@azure/cognitiveservices-face.FaceModels.SimilarFace'
package: '@azure/cognitiveservices-face'
summary: Response body for find similar face operation.
fullName: SimilarFace
remarks: ''
isDeprecated: false
type: interface
properties:
- name: confidence
uid: '@azure/cognitiveservices-face.FaceModels.SimilarFace.confidence'
package: '@azure/cognitiveservices-face'
summary: >-
Similarity confidence of the candidate face. The higher confidence, the
more similar. Range
between [0,1].
fullName: confidence
remarks: ''
isDeprecated: false
syntax:
content: 'confidence: number'
return:
description: ''
type: number
- name: faceId
uid: '@azure/cognitiveservices-face.FaceModels.SimilarFace.faceId'
package: '@azure/cognitiveservices-face'
summary: >-
FaceId of candidate face when find by faceIds. faceId is created by Face -
Detect and will
expire at the time specified by faceIdTimeToLive after the detection call
fullName: faceId
remarks: ''
isDeprecated: false
syntax:
content: 'faceId?: string'
return:
description: ''
type: string
- name: persistedFaceId
uid: '@azure/cognitiveservices-face.FaceModels.SimilarFace.persistedFaceId'
package: '@azure/cognitiveservices-face'
summary: >-
PersistedFaceId of candidate face when find by faceListId. persistedFaceId
in face list is
persisted and will not expire. As showed in below response
fullName: persistedFaceId
remarks: ''
isDeprecated: false
syntax:
content: 'persistedFaceId?: string'
return:
description: ''
type: string