Skip to content

Commit 241c4f0

Browse files
Han-msftHan Chiangshaoli-msftShawn Linshawnlin711
authored
Migrate existing Azure AI Face service to TypeSpec (#27576)
* Add following operations: - Liveness Session - Person Directory - Person Group - Face List - Face Operations * Restructure and rename operations Omit unreachable types * Change PD to non-LRO * Update example, doc, data decorator and unnecessary sharedRoute * Use union to represent extensible enum Add suppressions Add default value for models Fix age type Rename model in sdk Refine examples and train headers Add uuid type, groupId type and name min length Use our own operation state Change liveness operation to enum Refine group id pattern Use array for csv fields Separate request and response model for collection Flatten interface Flatten parameter for more interface * Mark detect as internal for customization * Add liveness audit response schema * Update documents (add and fix description format and add examples) Co-authored-by: Shawn Lin <[email protected]> * Move path to host template * Move suppression to config Fix format and suppress response code failure Fix breaking changes Switch endpoint to uri Refine liveness session model Move away from standard operation to use our own error code * Set liveness with verify session as internal * Remove 4xx examples for now with some document updates (#4) * Update detection document * Update 4xx examples * Update example parameter and response * Several doc fix for PD * Differenct recognition descriptions for different data structure * Fix bullet points in note and update some PD doc * Update liveness doc * Remove 4xx examples for now to pass validation --------- Co-authored-by: Shawn Lin <[email protected]> Co-authored-by: Shawn Lin <[email protected]> * Add verify image response in create session * Rename API operation name (#5) * Change document to new operation names * Rename * More renaming --------- Co-authored-by: Shawn Lin <[email protected]> Co-authored-by: Shawn Lin <[email protected]> * Refine verify image header description * Add partial update for java * Use shared route for DPG LRO Use original LRO for PD person and face creation * Use resource decorator instead of specify resource in LRO response * Change name for patch to optional * Correct operation status name Correct DPG example * Rename operation status model * Correct operation result example * Add gated attribute * Fix validation * Force public model for internal detect * Correct update DPG model * Disable detect from url convenientAPI for java * Rename dpg write * Fix comment * Rename id and remove customized uuid * Correct access level of landmark and attribute * Correct more models' access * Collect client customization into client.tsp * Correct verify pd parameter type * Correct type * Reorder detect parameters * Rename session model * Refine description for return reco model * Remove detection convenient API * Add link of error code and message (#6) Co-authored-by: Shawn Lin <[email protected]> * Fix validation * Remove unnecessary model * Rename model * Remove redundant line --------- Co-authored-by: Han Chiang <[email protected]> Co-authored-by: shaoli-msft <[email protected]> Co-authored-by: Shawn Lin <[email protected]> Co-authored-by: Shawn Lin <[email protected]>
1 parent b8af2fc commit 241c4f0

File tree

221 files changed

+17091
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

221 files changed

+17091
-4
lines changed

‎cSpell.json‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1241,7 +1241,7 @@
12411241
"WSUS"
12421242
]
12431243
},
1244-
{
1244+
{
12451245
"filename": "**/specification/monitor/resource-manager/Microsoft.Insights/**/actionGroups_API.json",
12461246
"words": [
12471247
"occurringlocation",
@@ -1251,6 +1251,14 @@
12511251
"tsgid",
12521252
"correlationid"
12531253
]
1254+
},
1255+
{
1256+
"filename": "**/specification/ai/data-plane/Face/**/*.json",
1257+
"words": [
1258+
"headwear",
1259+
"realface",
1260+
"spoofface"
1261+
]
12541262
}
12551263
],
12561264
"enableFiletypes": [

‎specification/ai/Face/client.tsp‎

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
import "@azure-tools/typespec-client-generator-core";
2+
import "@typespec/rest";
3+
import "@typespec/http";
4+
import "@typespec/versioning";
5+
import "./main.tsp";
6+
7+
using Azure.ClientGenerator.Core;
8+
using Face;
9+
10+
@TypeSpec.Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_2)
11+
@TypeSpec.Versioning.useDependency(Face.Versions.v1_1_preview_1)
12+
namespace ClientCustomizations;
13+
14+
@@clientName(RecognitionModel, "FaceRecognitionModel");
15+
@@clientName(DetectionModel, "FaceDetectionModel");
16+
@@clientName(OperationStatus, "FaceOperationStatus");
17+
@@clientName(TrainingResult, "FaceCollectionTrainingResult");
18+
@@clientName(IdentificationResult, "FaceIdentificationResult");
19+
@@clientName(IdentificationCandidate, "FaceIdentificationCandidate");
20+
@@clientName(VerificationResult, "FaceVerificationResult");
21+
@@clientName(FindSimilarResult, "FaceFindSimilarResult");
22+
@@clientName(GroupingResult, "FaceGroupingResult");
23+
@@clientName(OperationResult, "FaceOperationResult");
24+
@@clientName(LivenessDecision, "FaceLivenessDecision");
25+
@@clientName(ImageType, "FaceImageType");
26+
27+
@@access(FaceAttributeType, Access.public);
28+
@@access(FaceDetectionResult, Access.public);
29+
@@access(FaceLandmarks, Access.public);
30+
@@access(LandmarkCoordinate, Access.public);
31+
@@access(FaceAttributes, Access.public);
32+
@@access(FacialHair, Access.public);
33+
@@access(GlassesType, Access.public);
34+
@@access(HeadPose, Access.public);
35+
@@access(HairProperties, Access.public);
36+
@@access(HairColor, Access.public);
37+
@@access(HairColorType, Access.public);
38+
@@access(OcclusionProperties, Access.public);
39+
@@access(AccessoryItem, Access.public);
40+
@@access(AccessoryType, Access.public);
41+
@@access(BlurProperties, Access.public);
42+
@@access(BlurLevel, Access.public);
43+
@@access(ExposureProperties, Access.public);
44+
@@access(ExposureLevel, Access.public);
45+
@@access(NoiseProperties, Access.public);
46+
@@access(NoiseLevel, Access.public);
47+
@@access(MaskProperties, Access.public);
48+
@@access(MaskType, Access.public);
49+
@@access(QualityForRecognition, Access.public);
50+
@@access(CreateLivenessWithVerifySessionResult, Access.public);
51+
52+
@client({
53+
name: "FaceClient",
54+
service: Face,
55+
})
56+
interface FaceClient {
57+
@access(Access.internal)
58+
@convenientAPI(false, "java")
59+
@convenientAPI(false, "csharp")
60+
detectFromUrl is FaceDetectionOperations.detectFromUrl;
61+
#suppress "@azure-tools/typespec-azure-core/byos" "It's an RPC call to detect face from an image, it doesn't store anything. There's a BYOS version of this call, but it's not this one."
62+
@access(Access.internal)
63+
@convenientAPI(false, "java")
64+
@convenientAPI(false, "csharp")
65+
detect is FaceDetectionOperations.detect;
66+
67+
findSimilar is FaceRecognitionOperations.findSimilar;
68+
findSimilarFromFaceList is FaceRecognitionOperations.findSimilarFromFaceList;
69+
findSimilarFromLargeFaceList is FaceRecognitionOperations.findSimilarFromLargeFaceList;
70+
identifyFromPersonGroup is FaceRecognitionOperations.identifyFromPersonGroup;
71+
identifyFromLargePersonGroup is FaceRecognitionOperations.identifyFromLargePersonGroup;
72+
identifyFromPersonDirectory is FaceRecognitionOperations.identifyFromPersonDirectory;
73+
identifyFromDynamicPersonGroup is FaceRecognitionOperations.identifyFromDynamicPersonGroup;
74+
verifyFaceToFace is FaceRecognitionOperations.verifyFaceToFace;
75+
verifyFromPersonGroup is FaceRecognitionOperations.verifyFromPersonGroup;
76+
verifyFromLargePersonGroup is FaceRecognitionOperations.verifyFromLargePersonGroup;
77+
verifyFromPersonDirectory is FaceRecognitionOperations.verifyFromPersonDirectory;
78+
group is FaceRecognitionOperations.group;
79+
}
80+
81+
@client({
82+
name: "FaceAdministrationClient",
83+
service: Face,
84+
})
85+
interface FaceAdministrationClient {
86+
createFaceList is FaceListOperations.createFaceList;
87+
deleteFaceList is FaceListOperations.deleteFaceList;
88+
getFaceList is FaceListOperations.getFaceList;
89+
updateFaceList is FaceListOperations.updateFaceList;
90+
getFaceLists is FaceListOperations.getFaceLists;
91+
addFaceListFaceFromUrl is FaceListOperations.addFaceListFaceFromUrl;
92+
#suppress "@azure-tools/typespec-azure-core/byos" "It's an RPC call to detect face from an image, it doesn't store anything. There's a BYOS version of this call, but it's not this one."
93+
addFaceListFace is FaceListOperations.addFaceListFace;
94+
deleteFaceListFace is FaceListOperations.deleteFaceListFace;
95+
96+
createLargeFaceList is FaceListOperations.createLargeFaceList;
97+
deleteLargeFaceList is FaceListOperations.deleteLargeFaceList;
98+
getLargeFaceList is FaceListOperations.getLargeFaceList;
99+
updateLargeFaceList is FaceListOperations.updateLargeFaceList;
100+
getLargeFaceLists is FaceListOperations.getLargeFaceLists;
101+
getLargeFaceListTrainingStatus is FaceListOperations.getLargeFaceListTrainingStatus;
102+
trainLargeFaceList is FaceListOperations.trainLargeFaceList;
103+
addLargeFaceListFaceFromUrl is FaceListOperations.addLargeFaceListFaceFromUrl;
104+
#suppress "@azure-tools/typespec-azure-core/byos" "It's an RPC call to detect face from an image, it doesn't store anything. There's a BYOS version of this call, but it's not this one."
105+
addLargeFaceListFace is FaceListOperations.addLargeFaceListFace;
106+
deleteLargeFaceListFace is FaceListOperations.deleteLargeFaceListFace;
107+
getLargeFaceListFace is FaceListOperations.getLargeFaceListFace;
108+
updateLargeFaceListFace is FaceListOperations.updateLargeFaceListFace;
109+
getLargeFaceListFaces is FaceListOperations.getLargeFaceListFaces;
110+
111+
createPersonGroup is PersonGroupOperations.createPersonGroup;
112+
deletePersonGroup is PersonGroupOperations.deletePersonGroup;
113+
getPersonGroup is PersonGroupOperations.getPersonGroup;
114+
updatePersonGroup is PersonGroupOperations.updatePersonGroup;
115+
getPersonGroups is PersonGroupOperations.getPersonGroups;
116+
getPersonGroupTrainingStatus is PersonGroupOperations.getPersonGroupTrainingStatus;
117+
trainPersonGroup is PersonGroupOperations.trainPersonGroup;
118+
createPersonGroupPerson is PersonGroupOperations.createPersonGroupPerson;
119+
deletePersonGroupPerson is PersonGroupOperations.deletePersonGroupPerson;
120+
getPersonGroupPerson is PersonGroupOperations.getPersonGroupPerson;
121+
updatePersonGroupPerson is PersonGroupOperations.updatePersonGroupPerson;
122+
getPersonGroupPersons is PersonGroupOperations.getPersonGroupPersons;
123+
addPersonGroupPersonFaceFromUrl is PersonGroupOperations.addPersonGroupPersonFaceFromUrl;
124+
#suppress "@azure-tools/typespec-azure-core/byos" "It's an RPC call to detect face from an image, it doesn't store anything. There's a BYOS version of this call, but it's not this one."
125+
addPersonGroupPersonFace is PersonGroupOperations.addPersonGroupPersonFace;
126+
deletePersonGroupPersonFace is PersonGroupOperations.deletePersonGroupPersonFace;
127+
getPersonGroupPersonFace is PersonGroupOperations.getPersonGroupPersonFace;
128+
updatePersonGroupPersonFace is PersonGroupOperations.updatePersonGroupPersonFace;
129+
130+
createLargePersonGroup is PersonGroupOperations.createLargePersonGroup;
131+
deleteLargePersonGroup is PersonGroupOperations.deleteLargePersonGroup;
132+
getLargePersonGroup is PersonGroupOperations.getLargePersonGroup;
133+
updateLargePersonGroup is PersonGroupOperations.updateLargePersonGroup;
134+
getLargePersonGroups is PersonGroupOperations.getLargePersonGroups;
135+
getLargePersonGroupTrainingStatus is PersonGroupOperations.getLargePersonGroupTrainingStatus;
136+
trainLargePersonGroup is PersonGroupOperations.trainLargePersonGroup;
137+
createLargePersonGroupPerson is PersonGroupOperations.createLargePersonGroupPerson;
138+
deleteLargePersonGroupPerson is PersonGroupOperations.deleteLargePersonGroupPerson;
139+
getLargePersonGroupPerson is PersonGroupOperations.getLargePersonGroupPerson;
140+
updateLargePersonGroupPerson is PersonGroupOperations.updateLargePersonGroupPerson;
141+
getLargePersonGroupPersons is PersonGroupOperations.getLargePersonGroupPersons;
142+
addLargePersonGroupPersonFaceFromUrl is PersonGroupOperations.addLargePersonGroupPersonFaceFromUrl;
143+
#suppress "@azure-tools/typespec-azure-core/byos" "It's an RPC call to detect face from an image, it doesn't store anything. There's a BYOS version of this call, but it's not this one."
144+
addLargePersonGroupPersonFace is PersonGroupOperations.addLargePersonGroupPersonFace;
145+
deleteLargePersonGroupPersonFace is PersonGroupOperations.deleteLargePersonGroupPersonFace;
146+
getLargePersonGroupPersonFace is PersonGroupOperations.getLargePersonGroupPersonFace;
147+
updateLargePersonGroupPersonFace is PersonGroupOperations.updateLargePersonGroupPersonFace;
148+
149+
createPerson is PersonDirectoryOperations.createPerson;
150+
deletePerson is PersonDirectoryOperations.deletePerson;
151+
getPerson is PersonDirectoryOperations.getPerson;
152+
updatePerson is PersonDirectoryOperations.updatePerson;
153+
getPersons is PersonDirectoryOperations.getPersons;
154+
getDynamicPersonGroupReferences is PersonDirectoryOperations.getDynamicPersonGroupReferences;
155+
addPersonFaceFromUrl is PersonDirectoryOperations.addPersonFaceFromUrl;
156+
#suppress "@azure-tools/typespec-azure-core/byos" "It's an RPC call to detect face from an image, it doesn't store anything. There's a BYOS version of this call, but it's not this one."
157+
addPersonFace is PersonDirectoryOperations.addPersonFace;
158+
deletePersonFace is PersonDirectoryOperations.deletePersonFace;
159+
getPersonFace is PersonDirectoryOperations.getPersonFace;
160+
updatePersonFace is PersonDirectoryOperations.updatePersonFace;
161+
getPersonFaces is PersonDirectoryOperations.getPersonFaces;
162+
163+
createDynamicPersonGroupWithPerson is PersonDirectoryOperations.createDynamicPersonGroupWithPerson;
164+
createDynamicPersonGroup is PersonDirectoryOperations.createDynamicPersonGroup;
165+
deleteDynamicPersonGroup is PersonDirectoryOperations.deleteDynamicPersonGroup;
166+
getDynamicPersonGroup is PersonDirectoryOperations.getDynamicPersonGroup;
167+
updateDynamicPersonGroupWithPersonChanges is PersonDirectoryOperations.updateDynamicPersonGroupWithPersonChanges;
168+
updateDynamicPersonGroup is PersonDirectoryOperations.updateDynamicPersonGroup;
169+
getDynamicPersonGroups is PersonDirectoryOperations.getDynamicPersonGroups;
170+
getDynamicPersonGroupPersons is PersonDirectoryOperations.getDynamicPersonGroupPersons;
171+
}
172+
173+
@client({
174+
name: "FaceSessionClient",
175+
service: Face,
176+
})
177+
interface FaceSessionClient {
178+
createLivenessSession is LivenessSessionOperations.createLivenessSession;
179+
deleteLivenessSession is LivenessSessionOperations.deleteLivenessSession;
180+
getLivenessSessionResult is LivenessSessionOperations.getLivenessSessionResult;
181+
getLivenessSessions is LivenessSessionOperations.getLivenessSessions;
182+
getLivenessSessionAuditEntries is LivenessSessionOperations.getLivenessSessionAuditEntries;
183+
184+
@access(Access.internal)
185+
createLivenessWithVerifySession is LivenessSessionOperations.createLivenessWithVerifySession;
186+
#suppress "@azure-tools/typespec-azure-core/byos" "It's an RPC call to detect face from an image, it doesn't store anything. There's a BYOS version of this call, but it's not this one."
187+
@access(Access.internal)
188+
createLivenessWithVerifySessionWithVerifyImage is LivenessSessionOperations.createLivenessWithVerifySessionWithVerifyImage;
189+
deleteLivenessWithVerifySession is LivenessSessionOperations.deleteLivenessWithVerifySession;
190+
getLivenessWithVerifySessionResult is LivenessSessionOperations.getLivenessWithVerifySessionResult;
191+
getLivenessWithVerifySessions is LivenessSessionOperations.getLivenessWithVerifySessions;
192+
getLivenessWithVerifySessionAuditEntries is LivenessSessionOperations.getLivenessWithVerifySessionAuditEntries;
193+
}

‎specification/ai/Face/examples/v1.1-preview.1/Detect.json‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
{
2+
"title": "Detect with Image",
3+
"operationId": "FaceDetectionOperations_Detect",
4+
"parameters": {
5+
"apiVersion": "v1.1-preview.1",
6+
"returnFaceId": true,
7+
"returnFaceLandmarks": true,
8+
"returnFaceAttributes": "glasses,headPose,occlusion,accessories,blur,exposure,noise,qualityForRecognition",
9+
"recognitionModel": "recognition_03",
10+
"returnRecognitionModel": true,
11+
"detectionModel": "detection_01",
12+
"faceIdTimeToLive": 60,
13+
"imageContent": "<your-image-bytes-here>"
14+
},
15+
"responses": {
16+
"200": {
17+
"body": [
18+
{
19+
"faceId": "c5c24a82-6845-4031-9d5d-978df9175426",
20+
"recognitionModel": "recognition_03",
21+
"faceRectangle": {
22+
"width": 78,
23+
"height": 78,
24+
"left": 394,
25+
"top": 54
26+
},
27+
"faceLandmarks": {
28+
"pupilLeft": {
29+
"x": 412.7,
30+
"y": 78.4
31+
},
32+
"pupilRight": {
33+
"x": 446.8,
34+
"y": 74.2
35+
},
36+
"noseTip": {
37+
"x": 437.7,
38+
"y": 92.4
39+
},
40+
"mouthLeft": {
41+
"x": 417.8,
42+
"y": 114.4
43+
},
44+
"mouthRight": {
45+
"x": 451.3,
46+
"y": 109.3
47+
},
48+
"eyebrowLeftOuter": {
49+
"x": 397.9,
50+
"y": 78.5
51+
},
52+
"eyebrowLeftInner": {
53+
"x": 425.4,
54+
"y": 70.5
55+
},
56+
"eyeLeftOuter": {
57+
"x": 406.7,
58+
"y": 80.6
59+
},
60+
"eyeLeftTop": {
61+
"x": 412.2,
62+
"y": 76.2
63+
},
64+
"eyeLeftBottom": {
65+
"x": 413.0,
66+
"y": 80.1
67+
},
68+
"eyeLeftInner": {
69+
"x": 418.9,
70+
"y": 78.0
71+
},
72+
"eyebrowRightInner": {
73+
"x": 4.8,
74+
"y": 69.7
75+
},
76+
"eyebrowRightOuter": {
77+
"x": 5.5,
78+
"y": 68.5
79+
},
80+
"eyeRightInner": {
81+
"x": 441.5,
82+
"y": 75.0
83+
},
84+
"eyeRightTop": {
85+
"x": 446.4,
86+
"y": 71.7
87+
},
88+
"eyeRightBottom": {
89+
"x": 447.0,
90+
"y": 75.3
91+
},
92+
"eyeRightOuter": {
93+
"x": 451.7,
94+
"y": 73.4
95+
},
96+
"noseRootLeft": {
97+
"x": 428.0,
98+
"y": 77.1
99+
},
100+
"noseRootRight": {
101+
"x": 435.8,
102+
"y": 75.6
103+
},
104+
"noseLeftAlarTop": {
105+
"x": 428.3,
106+
"y": 89.7
107+
},
108+
"noseRightAlarTop": {
109+
"x": 442.2,
110+
"y": 87.0
111+
},
112+
"noseLeftAlarOutTip": {
113+
"x": 424.3,
114+
"y": 96.4
115+
},
116+
"noseRightAlarOutTip": {
117+
"x": 446.6,
118+
"y": 92.5
119+
},
120+
"upperLipTop": {
121+
"x": 437.6,
122+
"y": 105.9
123+
},
124+
"upperLipBottom": {
125+
"x": 437.6,
126+
"y": 108.2
127+
},
128+
"underLipTop": {
129+
"x": 436.8,
130+
"y": 111.4
131+
},
132+
"underLipBottom": {
133+
"x": 437.3,
134+
"y": 114.5
135+
}
136+
},
137+
"faceAttributes": {
138+
"glasses": "sunglasses",
139+
"headPose": {
140+
"roll": 2.1,
141+
"yaw": 3,
142+
"pitch": 1.6
143+
},
144+
"occlusion": {
145+
"foreheadOccluded": false,
146+
"eyeOccluded": false,
147+
"mouthOccluded": false
148+
},
149+
"accessories": [
150+
{
151+
"type": "headwear",
152+
"confidence": 0.99
153+
},
154+
{
155+
"type": "glasses",
156+
"confidence": 1.0
157+
},
158+
{
159+
"type": "mask",
160+
"confidence": 0.87
161+
}
162+
],
163+
"blur": {
164+
"blurLevel": "medium",
165+
"value": 0.51
166+
},
167+
"exposure": {
168+
"exposureLevel": "goodExposure",
169+
"value": 0.55
170+
},
171+
"noise": {
172+
"noiseLevel": "low",
173+
"value": 0.12
174+
},
175+
"qualityForRecognition": "high"
176+
}
177+
}
178+
]
179+
}
180+
}
181+
}

0 commit comments

Comments
 (0)