tccli 3.0.1218.1__py2.py3-none-any.whl → 3.0.1220.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (55) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +3 -0
  3. tccli/services/af/v20200226/api.json +2 -2
  4. tccli/services/autoscaling/v20180419/api.json +1 -1
  5. tccli/services/billing/v20180709/api.json +176 -181
  6. tccli/services/billing/v20180709/examples.json +7 -7
  7. tccli/services/cdwch/cdwch_client.py +53 -0
  8. tccli/services/cdwch/v20200915/api.json +100 -0
  9. tccli/services/cdwch/v20200915/examples.json +8 -0
  10. tccli/services/ckafka/v20190819/api.json +7 -7
  11. tccli/services/clb/v20180317/api.json +12 -12
  12. tccli/services/cwp/v20180228/api.json +1 -1
  13. tccli/services/cynosdb/v20190107/api.json +12 -2
  14. tccli/services/es/v20180416/examples.json +2 -2
  15. tccli/services/ess/v20201111/api.json +19 -1
  16. tccli/services/essbasic/v20210526/api.json +28 -1
  17. tccli/services/faceid/v20180301/api.json +2 -2
  18. tccli/services/iai/v20180301/api.json +17 -13
  19. tccli/services/iai/v20200303/examples.json +200 -200
  20. tccli/services/iap/__init__.py +4 -0
  21. tccli/services/iap/iap_client.py +472 -0
  22. tccli/services/iap/v20240713/api.json +471 -0
  23. tccli/services/iap/v20240713/examples.json +59 -0
  24. tccli/services/lcic/v20220817/api.json +3 -3
  25. tccli/services/live/live_client.py +428 -4
  26. tccli/services/live/v20180801/api.json +1070 -68
  27. tccli/services/live/v20180801/examples.json +64 -0
  28. tccli/services/market/v20191010/api.json +7 -7
  29. tccli/services/market/v20191010/examples.json +2 -2
  30. tccli/services/mps/mps_client.py +53 -0
  31. tccli/services/mps/v20190612/api.json +164 -0
  32. tccli/services/mps/v20190612/examples.json +8 -0
  33. tccli/services/partners/v20180321/api.json +4 -4
  34. tccli/services/pts/v20210728/api.json +3 -0
  35. tccli/services/redis/v20180412/api.json +169 -163
  36. tccli/services/redis/v20180412/examples.json +3 -3
  37. tccli/services/svp/v20240125/api.json +29 -29
  38. tccli/services/svp/v20240125/examples.json +1 -1
  39. tccli/services/tat/v20201028/api.json +5 -5
  40. tccli/services/tdmq/v20200217/api.json +1 -1
  41. tccli/services/tke/v20220501/api.json +2 -2
  42. tccli/services/tse/v20201207/api.json +199 -12
  43. tccli/services/tse/v20201207/examples.json +4 -4
  44. tccli/services/vcg/v20240404/api.json +1 -1
  45. tccli/services/vcg/v20240404/examples.json +4 -4
  46. tccli/services/vpc/v20170312/api.json +492 -66
  47. tccli/services/vpc/v20170312/examples.json +59 -21
  48. tccli/services/vpc/vpc_client.py +212 -0
  49. tccli/services/wedata/v20210820/api.json +47 -2
  50. tccli/services/wedata/v20210820/examples.json +1 -1
  51. {tccli-3.0.1218.1.dist-info → tccli-3.0.1220.1.dist-info}/METADATA +2 -2
  52. {tccli-3.0.1218.1.dist-info → tccli-3.0.1220.1.dist-info}/RECORD +55 -51
  53. {tccli-3.0.1218.1.dist-info → tccli-3.0.1220.1.dist-info}/WHEEL +0 -0
  54. {tccli-3.0.1218.1.dist-info → tccli-3.0.1220.1.dist-info}/entry_points.txt +0 -0
  55. {tccli-3.0.1218.1.dist-info → tccli-3.0.1220.1.dist-info}/license_files/LICENSE +0 -0
tccli/services/iai/v20200303/examples.json CHANGED
@@ -2,21 +2,27 @@
2
2
  "actions": {
3
3
  "AnalyzeDenseLandmarks": [
4
4
  {
5
- "document": "获取稠密关键点。",
5
+ "document": "",
6
6
  "input": "https://iai.tencentcloudapi.com/?Action=AnalyzeDenseLandmarks\n&Mode=0\n&Url=http://test.image.myqcloud.com/testA.jpg\n&<公共请求参数>",
7
7
  "output": "{\n \"Response\": {\n \"ImageWidth\": 550,\n \"ImageHeight\": 366,\n \"DenseFaceShapeSet\": [\n {\n \"Chin\": [\n {\n \"X\": 376,\n \"Y\": 66\n }\n ],\n \"LeftEye\": [\n {\n \"X\": 384,\n \"Y\": 66\n }\n ],\n \"RightEye\": [\n {\n \"X\": 422,\n \"Y\": 72\n }\n ],\n \"LeftEyeBrow\": [\n {\n \"X\": 382,\n \"Y\": 61\n }\n ],\n \"RightEyeBrow\": [\n {\n \"X\": 428,\n \"Y\": 68\n }\n ],\n \"Nose\": [\n {\n \"X\": 398,\n \"Y\": 69\n }\n ],\n \"MouthInside\": [\n {\n \"X\": 386,\n \"Y\": 98\n }\n ],\n \"MouthOutside\": [\n {\n \"X\": 386,\n \"Y\": 98\n }\n ],\n \"LeftPupil\": [\n {\n \"X\": 390,\n \"Y\": 65\n }\n ],\n \"RightPupil\": [\n {\n \"X\": 416,\n \"Y\": 70\n }\n ],\n \"LeftEyeBags\": [\n {\n \"X\": 395,\n \"Y\": 69\n }\n ],\n \"RightEyeBags\": [\n {\n \"X\": 410,\n \"Y\": 72\n }\n ],\n \"Forehead\": [\n {\n \"X\": 376,\n \"Y\": 65\n }\n ],\n \"CentralAxis\": [\n {\n \"X\": 405,\n \"Y\": 54\n }\n ],\n \"X\": 375,\n \"Y\": 37,\n \"Width\": 63,\n \"Height\": 82\n }\n ],\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"cebb639a-ec53-4a23-a5a5-fbcc5f0ae2bc\"\n }\n}",
8
- "title": "稠密关键点接口"
8
+ "title": "获取稠密关键点成功示例"
9
+ },
10
+ {
11
+ "document": "",
12
+ "input": "https://iai.tencentcloudapi.com/?Action=AnalyzeDenseLandmarks\n&Mode=0\n&Url=http://test.image.myqcloud.com/testB.jpg\n&<公共请求参数>",
13
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.ImageDecodeFailed\",\n \"Message\": \"图片解码失败。\"\n },\n \"RequestId\": \"b0d281e1-1df9-461d-8ed4-5ce83b29530c\"\n }\n}",
14
+ "title": "获取稠密关键点失败示例"
9
15
  }
10
16
  ],
11
17
  "AnalyzeFace": [
12
18
  {
13
- "document": "对请求图片进行五官定位。",
19
+ "document": "",
14
20
  "input": "https://iai.tencentcloudapi.com/?Action=AnalyzeFace\n&Mode=0\n&Url=http://test.image.myqcloud.com/testA.jpg\n&<公共请求参数>",
15
21
  "output": "{\n \"Response\": {\n \"ImageWidth\": 550,\n \"ImageHeight\": 366,\n \"FaceShapeSet\": [\n {\n \"FaceProfile\": [\n {\n \"X\": 63,\n \"Y\": 335\n },\n {\n \"X\": 63,\n \"Y\": 374\n },\n {\n \"X\": 66,\n \"Y\": 412\n },\n {\n \"X\": 74,\n \"Y\": 450\n },\n {\n \"X\": 85,\n \"Y\": 487\n },\n {\n \"X\": 100,\n \"Y\": 522\n },\n {\n \"X\": 121,\n \"Y\": 554\n },\n {\n \"X\": 147,\n \"Y\": 582\n },\n {\n \"X\": 176,\n \"Y\": 608\n },\n {\n \"X\": 208,\n \"Y\": 627\n },\n {\n \"X\": 245,\n \"Y\": 634\n },\n {\n \"X\": 282,\n \"Y\": 627\n },\n {\n \"X\": 315,\n \"Y\": 607\n },\n {\n \"X\": 344,\n \"Y\": 582\n },\n {\n \"X\": 370,\n \"Y\": 554\n },\n {\n \"X\": 391,\n \"Y\": 522\n },\n {\n \"X\": 405,\n \"Y\": 487\n },\n {\n \"X\": 416,\n \"Y\": 449\n },\n {\n \"X\": 423,\n \"Y\": 411\n },\n {\n \"X\": 427,\n \"Y\": 372\n },\n {\n \"X\": 426,\n \"Y\": 334\n }\n ],\n \"LeftEye\": [\n {\n \"X\": 114,\n \"Y\": 333\n },\n {\n \"X\": 128,\n \"Y\": 345\n },\n {\n \"X\": 146,\n \"Y\": 349\n },\n {\n \"X\": 165,\n \"Y\": 347\n },\n {\n \"X\": 183,\n \"Y\": 341\n },\n {\n \"X\": 169,\n \"Y\": 325\n },\n {\n \"X\": 150,\n \"Y\": 318\n },\n {\n \"X\": 130,\n \"Y\": 321\n }\n ],\n \"RightEye\": [\n {\n \"X\": 378,\n \"Y\": 331\n },\n {\n \"X\": 364,\n \"Y\": 343\n },\n {\n \"X\": 345,\n \"Y\": 348\n },\n {\n \"X\": 327,\n \"Y\": 346\n },\n {\n \"X\": 309,\n \"Y\": 340\n },\n {\n \"X\": 322,\n \"Y\": 323\n },\n {\n \"X\": 341,\n \"Y\": 316\n },\n {\n \"X\": 361,\n \"Y\": 319\n }\n ],\n \"LeftEyeBrow\": [\n {\n \"X\": 79,\n \"Y\": 280\n },\n {\n \"X\": 108,\n \"Y\": 275\n },\n {\n \"X\": 138,\n \"Y\": 274\n },\n {\n \"X\": 168,\n \"Y\": 277\n },\n {\n \"X\": 198,\n \"Y\": 279\n },\n {\n \"X\": 173,\n \"Y\": 256\n },\n {\n \"X\": 139,\n \"Y\": 251\n },\n {\n \"X\": 105,\n \"Y\": 256\n }\n ],\n \"RightEyeBrow\": [\n {\n \"X\": 410,\n \"Y\": 277\n },\n {\n \"X\": 380,\n \"Y\": 273\n },\n {\n \"X\": 350,\n \"Y\": 272\n },\n {\n \"X\": 320,\n \"Y\": 275\n },\n {\n \"X\": 290,\n \"Y\": 277\n },\n {\n \"X\": 315,\n \"Y\": 255\n },\n {\n \"X\": 349,\n \"Y\": 249\n },\n {\n \"X\": 384,\n \"Y\": 254\n }\n ],\n \"Mouth\": [\n {\n \"X\": 173,\n \"Y\": 522\n },\n {\n \"X\": 193,\n \"Y\": 541\n },\n {\n \"X\": 217,\n \"Y\": 554\n },\n {\n \"X\": 244,\n \"Y\": 558\n },\n {\n \"X\": 272,\n \"Y\": 554\n },\n {\n \"X\": 297,\n \"Y\": 541\n },\n {\n \"X\": 317,\n \"Y\": 522\n },\n {\n \"X\": 291,\n \"Y\": 517\n },\n {\n \"X\": 264,\n \"Y\": 512\n },\n {\n \"X\": 245,\n \"Y\": 517\n },\n {\n \"X\": 225,\n \"Y\": 512\n },\n {\n \"X\": 199,\n \"Y\": 517\n },\n {\n \"X\": 196,\n \"Y\": 528\n },\n {\n \"X\": 220,\n \"Y\": 532\n },\n {\n \"X\": 244,\n \"Y\": 535\n },\n {\n \"X\": 269,\n \"Y\": 532\n },\n {\n \"X\": 293,\n \"Y\": 528\n },\n {\n \"X\": 293,\n \"Y\": 525\n },\n {\n \"X\": 269,\n \"Y\": 527\n },\n {\n \"X\": 245,\n \"Y\": 530\n },\n {\n \"X\": 221,\n \"Y\": 528\n },\n {\n \"X\": 197,\n \"Y\": 525\n }\n ],\n \"Nose\": [\n {\n \"X\": 244,\n \"Y\": 428\n },\n {\n \"X\": 245,\n \"Y\": 341\n },\n {\n \"X\": 231,\n \"Y\": 367\n },\n {\n \"X\": 217,\n \"Y\": 392\n },\n {\n \"X\": 203,\n \"Y\": 418\n },\n {\n \"X\": 187,\n \"Y\": 448\n },\n {\n \"X\": 217,\n \"Y\": 464\n },\n {\n \"X\": 245,\n \"Y\": 468\n },\n {\n \"X\": 272,\n \"Y\": 464\n },\n {\n \"X\": 302,\n \"Y\": 448\n },\n {\n \"X\": 287,\n \"Y\": 417\n },\n {\n \"X\": 273,\n \"Y\": 392\n },\n {\n \"X\": 259,\n \"Y\": 366\n }\n ],\n \"LeftPupil\": [\n {\n \"X\": 188,\n \"Y\": 303\n }\n ],\n \"RightPupil\": [\n {\n \"X\": 201,\n \"Y\": 304\n }\n ]\n }\n ],\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"a8eb4545-a154-4f86-9510-57a8be9cae0c\"\n }\n}",
16
22
  "title": "五官定位接口成功示例"
17
23
  },
18
24
  {
19
- "document": "对请求图片进行五官定位，图片中没有人脸。",
25
+ "document": "",
20
26
  "input": "https://iai.tencentcloudapi.com/?Action=AnalyzeFace\n&Mode=0\n&Url=http://test.image.myqcloud.com/testB.jpg\n&<公共请求参数>",
21
27
  "output": "{\n \"Response\": {\n \"RequestId\": \"c964ad35-5476-486e-a03f-311faa6652e6\",\n \"Error\": {\n \"Code\": \"InvalidParameterValue.NoFaceInPhoto\",\n \"Message\": \"图片中没有人脸。\"\n }\n }\n}",
22
28
  "title": "五官定位接口失败示例"
@@ -24,13 +30,13 @@
24
30
  ],
25
31
  "CompareFace": [
26
32
  {
27
- "document": "对两张图片中的人脸进行相似度比对。",
33
+ "document": "",
28
34
  "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CompareFace\n<公共请求参数>\n\n{\n \"UrlA\": \"http://test.image.myqcloud.com/testA.jpg\",\n \"UrlB\": \"http://test.image.myqcloud.com/testB.jpg\"\n}",
29
35
  "output": "{\n \"Response\": {\n \"Score\": 0.999,\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"a8eb4545-a154-4f86-9510-57a8be9cae0c\"\n }\n}",
30
36
  "title": "人脸比对接口成功示例"
31
37
  },
32
38
  {
33
- "document": "传入低质量图片，进行相似度比对。",
39
+ "document": "",
34
40
  "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CompareFace\n<公共请求参数>\n\n{\n \"UrlA\": \"http://test.image.myqcloud.com/testA.jpg\",\n \"UrlB\": \"http://test.image.myqcloud.com/testB.jpg\"\n}",
35
41
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.FaceQualityNotQualified\",\n \"Message\": \"人脸图片质量不符要求。\"\n },\n \"RequestId\": \"788270e8-91b7-4c59-bd00-1af257b1e482\"\n }\n}",
36
42
  "title": "人脸比对接口异常示例"
@@ -38,13 +44,13 @@
38
44
  ],
39
45
  "CompareMaskFace": [
40
46
  {
41
- "document": "对两张图片中的人脸进行相似度比对。",
47
+ "document": "",
42
48
  "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CompareMaskFace\n<公共请求参数>\n\n{\n \"UrlA\": \"http://test.image.myqcloud.com/testA.jpg\",\n \"UrlB\": \"http://test.image.myqcloud.com/testB.jpg\"\n}",
43
49
  "output": "{\n \"Response\": {\n \"Score\": 0.999,\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"a8eb4545-a154-4f86-9510-57a8be9cae0c\"\n }\n}",
44
50
  "title": "人脸比对接口成功示例"
45
51
  },
46
52
  {
47
- "document": "传入质量不佳的图片，进行相似度比较。",
53
+ "document": "",
48
54
  "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CompareMaskFace\n<公共请求参数>\n\n{\n \"UrlA\": \"http://test.image.myqcloud.com/testA.jpg\",\n \"UrlB\": \"http://test.image.myqcloud.com/testB.jpg\"\n}",
49
55
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.FaceQualityNotQualified\",\n \"Message\": \"人脸图片质量不符要求。\"\n },\n \"RequestId\": \"788270e8-91b7-4c59-bd00-1af257b1e481\"\n }\n}",
50
56
  "title": "人脸比对接口异常示例"
@@ -52,30 +58,30 @@
52
58
  ],
53
59
  "CopyPerson": [
54
60
  {
55
- "document": "组中已包含对应的人员Id。",
56
- "input": "https://iai.tencentcloudapi.com/?Action=CopyPerson\r\n&PersonId=1001\r\n&GroupIds.0=TencentShenZhenEmployee\r\n&GroupIds.1=ZhuYuanDormitoryNo1\r\n&<公共请求参数>",
57
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.GroupPersonMapExist\",\n \"Message\": \"组中已包含对应的人员Id。\"\n },\n \"RequestId\": \"8ecfa566-68a9-4eb5-a6da-95ba9be26947\"\n }\n}",
58
- "title": "错误示例"
59
- },
60
- {
61
- "document": "复制人员。",
61
+ "document": "",
62
62
  "input": "https://iai.tencentcloudapi.com/?Action=CopyPerson\r\n&PersonId=2001\r\n&GroupIds.0=TencentShenZhenEmployee\r\n&GroupIds.1=ShenZhenCitizen\r\n&<公共请求参数>",
63
63
  "output": "{\n \"Response\": {\n \"SucGroupNum\": 2,\n \"SucGroupIds\": [\n \"ShenZhenCitizen\",\n \"TencentShenZhenEmployee\"\n ],\n \"RequestId\": \"9841c008-e597-4356-a8d5-c47a246abd8d\"\n }\n}",
64
- "title": "复制人员接口"
64
+ "title": "复制人员成功示例"
65
+ },
66
+ {
67
+ "document": "",
68
+ "input": "https://iai.tencentcloudapi.com/?Action=CopyPerson\r\n&PersonId=1001\r\n&GroupIds.0=TencentShenZhenEmployee\r\n&GroupIds.1=ZhuYuanDormitoryNo1\r\n&<公共请求参数>",
69
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.GroupPersonMapExist\",\n \"Message\": \"组中已包含对应的人员Id。\"\n },\n \"RequestId\": \"8ecfa566-68a9-4eb5-a6da-95ba9be26947\"\n }\n}",
70
+ "title": "复制人员失败示例"
65
71
  }
66
72
  ],
67
73
  "CreateFace": [
68
74
  {
69
- "document": "已有人员最多再新增4张人脸图片。",
70
- "input": "https://iai.tencentcloudapi.com/?Action=CreateFace\n&PersonId=1001\n&Urls.0=http://test.image.myqcloud.com/testB.jpg\n&Urls.1=http://test.image.myqcloud.com/testC.jpg\n&Urls.2=http://test.image.myqcloud.com/testD.jpg\n&Urls.3=http://test.image.myqcloud.com/testE.jpg\n&Urls.4=http://test.image.myqcloud.com/testF.jpg\n&<公共请求参数>",
71
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.UploadFaceNumExceed\",\n \"Message\": \"一次最多上传四张人脸。\"\n },\n \"RequestId\": \"44506f79-2191-49bc-997b-748a566d781c\"\n }\n}",
72
- "title": "错误示例"
73
- },
74
- {
75
- "document": "将一组人脸图片添加到一个人员中。",
75
+ "document": "",
76
76
  "input": "https://iai.tencentcloudapi.com/?Action=CreateFace\n&PersonId=1001\n&Urls.0=http://test.image.myqcloud.com/testA.jpg\n&<公共请求参数>",
77
77
  "output": "{\n \"Response\": {\n \"SucFaceNum\": 1,\n \"SucFaceIds\": [\n \"2875186538564559728\"\n ],\n \"RetCode\": [\n 0\n ],\n \"SucIndexes\": [\n 0\n ],\n \"SucFaceRects\": [\n {\n \"X\": 135,\n \"Y\": 42,\n \"Width\": 98,\n \"Height\": 136\n }\n ],\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"07d63403-a199-4bbe-b9e0-692356ac738d\"\n }\n}",
78
- "title": "增加人脸接口"
78
+ "title": "增加人脸成功示例"
79
+ },
80
+ {
81
+ "document": "",
82
+ "input": "https://iai.tencentcloudapi.com/?Action=CreateFace\n&PersonId=1001\n&Urls.0=http://test.image.myqcloud.com/testB.jpg\n&Urls.1=http://test.image.myqcloud.com/testC.jpg\n&Urls.2=http://test.image.myqcloud.com/testD.jpg\n&Urls.3=http://test.image.myqcloud.com/testE.jpg\n&Urls.4=http://test.image.myqcloud.com/testF.jpg\n&<公共请求参数>",
83
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.UploadFaceNumExceed\",\n \"Message\": \"一次最多上传四张人脸。\"\n },\n \"RequestId\": \"44506f79-2191-49bc-997b-748a566d781c\"\n }\n}",
84
+ "title": "增加人脸失败示例"
79
85
  }
80
86
  ],
81
87
  "CreateGroup": [
@@ -83,124 +89,112 @@
83
89
  "document": "创建人员库。",
84
90
  "input": "https://iai.tencentcloudapi.com/?Action=CreateGroup\n&GroupName=腾讯深圳员工库\n&FaceModelVersion=3.0\n&GroupId=TencentShenZhenEmployee\n&Tag=不含实习生\n&GroupExDescriptions.0=事业群\n&GroupExDescriptions.1=部门名\n&GroupExDescriptions.2=组名\n&<公共请求参数>",
85
91
  "output": "{\n \"Response\": {\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"e53ee4ec-9099-4b35-a129-21dd4820ff85\"\n }\n}",
86
- "title": "创建人员库接口"
92
+ "title": "创建人员库成功示例"
87
93
  },
88
94
  {
89
- "document": "创建人员库。",
90
- "input": "https://iai.tencentcloudapi.com/?Action=CreateGroup\n&GroupName=某某大学竹园宿舍楼1号楼\n&GroupId=ZhuYuanDormitoryNo1\n&FaceModelVersion=3.0\n&Tag=全是女生哦\n&GroupExDescriptions.0=学院名\n&GroupExDescriptions.1=专业\n&GroupExDescriptions.2=年级\n&GroupExDescriptions.3=学号\n&<公共请求参数>",
91
- "output": "{\n \"Response\": {\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"1695f3dd-b668-479e-8b87-f37de371a8ec\"\n }\n}",
92
- "title": "创建人员库接口-2"
93
- },
94
- {
95
- "document": "人员库ID不支持中文。",
95
+ "document": "",
96
96
  "input": "https://iai.tencentcloudapi.com/?Action=CreateGroup\n&GroupName=腾讯深圳员工库\n&GroupId=腾讯深圳员工库\n&<公共请求参数>",
97
97
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdIllegal\",\n \"Message\": \"人员库ID包含非法字符。人员库ID只支持英文、数字、-%@#&_。\"\n },\n \"RequestId\": \"8125dda4-2905-4e02-88bd-79a93a660ad2\"\n }\n}",
98
- "title": "错误示例-人员库ID不支持中文"
98
+ "title": "创建人员库错误示例"
99
99
  },
100
100
  {
101
- "document": "人员库ID不可重复",
101
+ "document": "",
102
102
  "input": "https://iai.tencentcloudapi.com/?Action=CreateGroup\n&GroupName=腾讯深圳员工库\n&GroupId=TencentShenZhenEmployee\n&<公共请求参数>",
103
103
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdAlreadyExist\",\n \"Message\": \"人员库ID已经存在。人员库ID不可重复。\"\n },\n \"RequestId\": \"76ec6e41-37d6-4ab9-abef-48ef0c6ab175\"\n }\n}",
104
- "title": "错误示例-人员库ID不可重复"
104
+ "title": "创建人员库ID重复错误示例"
105
105
  }
106
106
  ],
107
107
  "CreatePerson": [
108
108
  {
109
- "document": "人员ID不可重复。",
109
+ "document": "",
110
+ "input": "https://iai.tencentcloudapi.com/?Action=CreatePerson\n&GroupId=ZhuYuanDormitoryNo1\n&PersonName=Junly\n&PersonId=2001\n&Gender=1\n&Url=http://test.image.myqcloud.com/testB.jpg\n&PersonExDescriptionInfos.0.PersonExDescriptionIndex=0\n&PersonExDescriptionInfos.0.PersonExDescription=计算机学院\n&PersonExDescriptionInfos.1.PersonExDescriptionIndex=1\n&PersonExDescriptionInfos.1.PersonExDescription=软件工程\n&PersonExDescriptionInfos.2.PersonExDescriptionIndex=2\n&PersonExDescriptionInfos.2.PersonExDescription=15级\n&PersonExDescriptionInfos.3.PersonExDescriptionIndex=3\n&PersonExDescriptionInfos.3.PersonExDescription=3150808\n&<公共请求参数>",
111
+ "output": "{\n \"Response\": {\n \"FaceId\": \"3454816969590585885\",\n \"SimilarPersonId\": \"\",\n \"FaceRect\": {\n \"X\": 172,\n \"Y\": 122,\n \"Width\": 178,\n \"Height\": 228\n },\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"738a2fb0-bd4b-4cf6-9c91-18d50978d76b\"\n }\n}",
112
+ "title": "创建人员成功示例"
113
+ },
114
+ {
115
+ "document": "",
110
116
  "input": "https://iai.tencentcloudapi.com/?Action=CreatePerson\n&GroupId=ZhuYuanDormitoryNo1\n&PersonName=Cheng\n&PersonId=1001\n&Gender=2\n&Url=http://test.image.myqcloud.com/testD.jpg\n&<公共请求参数>",
111
117
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.PersonIdAlreadyExist\",\n \"Message\": \"人员ID已经存在。人员ID不可重复。\"\n },\n \"RequestId\": \"76dedef7-af27-4a20-9064-c5ef3133926d\"\n }\n}",
112
- "title": "错误示例"
118
+ "title": "创建人员时ID重复错误示例"
113
119
  },
114
120
  {
115
- "document": "人员库ID不存在。",
121
+ "document": "",
116
122
  "input": "https://iai.tencentcloudapi.com/?Action=CreatePerson\n&GroupId=ShenZhenCitizen\n&PersonName=Siccy\n&PersonId=3001\n&Gender=2\n&Url=http://test.image.myqcloud.com/testC.jpg\n&<公共请求参数>",
117
123
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdNotExist\",\n \"Message\": \"人员库ID不存在。\"\n },\n \"RequestId\": \"dfa512fc-fd07-4bf1-a292-cb497b620857\"\n }\n}",
118
- "title": "错误示例-2"
119
- },
120
- {
121
- "document": "创建人员。",
122
- "input": "https://iai.tencentcloudapi.com/?Action=CreatePerson\n&GroupId=ZhuYuanDormitoryNo1\n&PersonName=Junly\n&PersonId=2001\n&Gender=1\n&Url=http://test.image.myqcloud.com/testB.jpg\n&PersonExDescriptionInfos.0.PersonExDescriptionIndex=0\n&PersonExDescriptionInfos.0.PersonExDescription=计算机学院\n&PersonExDescriptionInfos.1.PersonExDescriptionIndex=1\n&PersonExDescriptionInfos.1.PersonExDescription=软件工程\n&PersonExDescriptionInfos.2.PersonExDescriptionIndex=2\n&PersonExDescriptionInfos.2.PersonExDescription=15级\n&PersonExDescriptionInfos.3.PersonExDescriptionIndex=3\n&PersonExDescriptionInfos.3.PersonExDescription=3150808\n&<公共请求参数>",
123
- "output": "{\n \"Response\": {\n \"FaceId\": \"3454816969590585885\",\n \"SimilarPersonId\": \"\",\n \"FaceRect\": {\n \"X\": 172,\n \"Y\": 122,\n \"Width\": 178,\n \"Height\": 228\n },\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"738a2fb0-bd4b-4cf6-9c91-18d50978d76b\"\n }\n}",
124
- "title": "创建人员接口"
125
- },
126
- {
127
- "document": "创建人员。",
128
- "input": "https://iai.tencentcloudapi.com/?Action=CreatePerson\n&GroupId=TencentShenZhenEmployee\n&PersonName=evanliao\n&PersonId=1001\n&Gender=1\n&Url=http://test.image.myqcloud.com/testA.jpg\n&PersonExDescriptionInfos.0.PersonExDescriptionIndex=0\n&PersonExDescriptionInfos.0.PersonExDescription=云与智慧产业事业群\n&PersonExDescriptionInfos.1.PersonExDescriptionIndex=1\n&PersonExDescriptionInfos.1.PersonExDescription=人工智能产品中心\n&PersonExDescriptionInfos.2.PersonExDescriptionIndex=2\n&PersonExDescriptionInfos.2.PersonExDescription=人脸识别产品组\n&<公共请求参数>",
129
- "output": "{\n \"Response\": {\n \"FaceId\": \"3454816969590585881\",\n \"SimilarPersonId\": \"\",\n \"FaceRect\": {\n \"X\": 172,\n \"Y\": 122,\n \"Width\": 178,\n \"Height\": 228\n },\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"269a6bc0-0016-47e8-a63d-517ce4052b0e\"\n }\n}",
130
- "title": "创建人员接口-2"
124
+ "title": "创建人员时库ID不存在错误示例"
131
125
  }
132
126
  ],
133
127
  "DeleteFace": [
134
128
  {
135
- "document": "人员ID不存在。",
136
- "input": "https://iai.tencentcloudapi.com/?Action=DeleteFace\r\n&PersonId=5001\r\n&FaceIds.0=2875186538564559728\r\n&<公共请求参数>",
137
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"ResourceNotFound.ErrorPersonNotExisted\",\n \"Message\": \"个体不存在。\"\n },\n \"RequestId\": \"e2b603e5-51d0-4a8a-8319-2df026ae7518\"\n }\n}",
138
- "title": "错误示例"
139
- },
140
- {
141
- "document": "删除一个人员下的人脸图片。",
129
+ "document": "",
142
130
  "input": "https://iai.tencentcloudapi.com/?Action=DeleteFace\r\n&PersonId=1001\r\n&FaceIds.0=2875186538564559728\r\n&<公共请求参数>",
143
131
  "output": "{\n \"Response\": {\n \"SucDeletedNum\": 1,\n \"SucFaceIds\": [\n \"2875186538564559728\"\n ],\n \"RequestId\": \"38f96439-d5ea-48ea-899b-44a284708f6b\"\n }\n}",
144
- "title": "删除人脸接口"
132
+ "title": "删除人脸成功示例"
133
+ },
134
+ {
135
+ "document": "",
136
+ "input": "https://iai.tencentcloudapi.com/?Action=DeleteFace\r\n&PersonId=5001\r\n&FaceIds.0=2875186538564559728\r\n&<公共请求参数>",
137
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"ResourceNotFound.ErrorPersonNotExisted\",\n \"Message\": \"个体不存在。\"\n },\n \"RequestId\": \"e2b603e5-51d0-4a8a-8319-2df026ae7518\"\n }\n}",
138
+ "title": "删除人脸失败示例"
145
139
  }
146
140
  ],
147
141
  "DeleteGroup": [
148
142
  {
149
- "document": "删除指定人员库及包含的所有的人员。",
143
+ "document": "",
150
144
  "input": "https://iai.tencentcloudapi.com/?Action=DeleteGroup\n&GroupId=ZhuYuanDormitoryNo1\n&<公共请求参数>",
151
145
  "output": "{\n \"Response\": {\n \"RequestId\": \"2ff7181c-ef20-4f02-b4ed-13924b381368\"\n }\n}",
152
- "title": "删除人员库接口"
146
+ "title": "删除人员库成功示例"
153
147
  },
154
148
  {
155
- "document": "人员库ID不存在",
149
+ "document": "",
156
150
  "input": "https://iai.tencentcloudapi.com/?Action=DeleteGroup\n&GroupId=ZhuYuanDormitory\n&<公共请求参数>",
157
151
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdNotExist\",\n \"Message\": \"人员库ID不存在。\"\n },\n \"RequestId\": \"878b225f-d3a4-4aa0-a849-3df415ac61a9\"\n }\n}",
158
- "title": "错误示例"
152
+ "title": "删除人员库失败示例"
159
153
  }
160
154
  ],
161
155
  "DeletePerson": [
162
156
  {
163
- "document": "人员ID不存在。",
164
- "input": "https://iai.tencentcloudapi.com/?Action=DeletePerson\r\n&PersonId=3001\r\n&<公共请求参数>",
165
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"ResourceNotFound.ErrorPersonNotExisted\",\n \"Message\": \"个体不存在。\"\n },\n \"RequestId\": \"4b9c1bdc-86eb-413f-8c74-15bcf4466cd5\"\n }\n}",
166
- "title": "错误示例"
167
- },
168
- {
169
- "document": "删除指定人员信息。",
157
+ "document": "",
170
158
  "input": "https://iai.tencentcloudapi.com/?Action=DeletePerson\r\n&PersonId=2001\r\n&<公共请求参数>",
171
159
  "output": "{\n \"Response\": {\n \"RequestId\": \"4b609b7c-7a9a-4ea0-be8b-1fb638c2ceca\"\n }\n}",
172
- "title": "删除人员接口"
160
+ "title": "删除人员信息成功示例"
161
+ },
162
+ {
163
+ "document": "",
164
+ "input": "https://iai.tencentcloudapi.com/?Action=DeletePerson\r\n&PersonId=3001\r\n&<公共请求参数>",
165
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"ResourceNotFound.ErrorPersonNotExisted\",\n \"Message\": \"个体不存在。\"\n },\n \"RequestId\": \"4b9c1bdc-86eb-413f-8c74-15bcf4466cd5\"\n }\n}",
166
+ "title": "删除人员信息失败示例"
173
167
  }
174
168
  ],
175
169
  "DeletePersonFromGroup": [
176
170
  {
177
- "document": "人员库中不包含指定人员。",
178
- "input": "https://iai.tencentcloudapi.com/?Action=DeletePersonFromGroup\r\n&PersonId=3001\r\n&GroupId=ZhuYuanDormitoryNo1\r\n&<公共请求参数>",
179
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.GroupPersonMapNotExist\",\n \"Message\": \"组中不包含对应的人员Id。\"\n },\n \"RequestId\": \"b9d9641d-3de2-4a6f-a728-36a3b66e7bd0\"\n }\n}",
180
- "title": "错误示例"
181
- },
182
- {
183
- "document": "从某人员库中删除人员，此操作仅影响该人员库。",
171
+ "document": "",
184
172
  "input": "https://iai.tencentcloudapi.com/?Action=DeletePersonFromGroup\r\n&PersonId=1001\r\n&GroupId=TencentShenZhenEmployee\r\n&<公共请求参数>",
185
173
  "output": "{\n \"Response\": {\n \"RequestId\": \"f9b22bbc-c94d-4287-a2ab-fa68f7bbbaf3\"\n }\n}",
186
- "title": "人员库删除人员接口"
174
+ "title": "人员库删除人员成功示例"
175
+ },
176
+ {
177
+ "document": "",
178
+ "input": "https://iai.tencentcloudapi.com/?Action=DeletePersonFromGroup\r\n&PersonId=3001\r\n&GroupId=ZhuYuanDormitoryNo1\r\n&<公共请求参数>",
179
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.GroupPersonMapNotExist\",\n \"Message\": \"组中不包含对应的人员Id。\"\n },\n \"RequestId\": \"b9d9641d-3de2-4a6f-a728-36a3b66e7bd0\"\n }\n}",
180
+ "title": "人员库删除人员失败示例"
187
181
  }
188
182
  ],
189
183
  "DetectFace": [
190
184
  {
191
- "document": "检测给定图片中的人脸的位置、相应的面部属性和人脸质量信息。",
185
+ "document": "",
192
186
  "input": "https://iai.tencentcloudapi.com/?Action=DetectFace\n&MaxFaceNum=1\n&MinFaceSize=40\n&Url=http://test.image.myqcloud.com/testB.jpg\n&NeedFaceAttributes=0\n&NeedQualityDetection=0\n&<公共请求参数>",
193
187
  "output": "{\n \"Response\": {\n \"ImageWidth\": 640,\n \"ImageHeight\": 440,\n \"FaceInfos\": [\n {\n \"X\": 156,\n \"Y\": 129,\n \"Width\": 196,\n \"Height\": 196,\n \"FaceAttributesInfo\": {\n \"Gender\": 0,\n \"Age\": 0,\n \"Expression\": 0,\n \"Hat\": false,\n \"Glass\": false,\n \"EyeOpen\": true,\n \"Mask\": false,\n \"Hair\": {\n \"Length\": 0,\n \"Bang\": 0,\n \"Color\": 0\n },\n \"Pitch\": 0,\n \"Yaw\": 0,\n \"Roll\": 0,\n \"Beauty\": 0\n },\n \"FaceQualityInfo\": {\n \"Score\": 0,\n \"Sharpness\": 0,\n \"Brightness\": 0,\n \"Completeness\": {\n \"Eyebrow\": 0,\n \"Eye\": 0,\n \"Nose\": 0,\n \"Cheek\": 0,\n \"Mouth\": 0,\n \"Chin\": 0\n }\n }\n }\n ],\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"a574102d-1b86-48a7-a08b-6a741a8fedb6\"\n }\n}",
194
- "title": "人脸检测与分析接口成功"
188
+ "title": "人脸检测与分析接口成功示例"
195
189
  },
196
190
  {
197
- "document": "检测给定图片中的人脸的位置、相应的面部属性和人脸质量信息。",
191
+ "document": "",
198
192
  "input": "https://iai.tencentcloudapi.com/?Action=DetectFace\n&MaxFaceNum=1\n&MinFaceSize=40\n&Url=http://test.image.myqcloud.com/testA.jpg\n&NeedFaceAttributes=1\n&NeedQualityDetection=1\n&<公共请求参数>",
199
193
  "output": "{\n \"Response\": {\n \"ImageWidth\": 640,\n \"ImageHeight\": 440,\n \"FaceInfos\": [\n {\n \"X\": 156,\n \"Y\": 129,\n \"Width\": 196,\n \"Height\": 196,\n \"FaceAttributesInfo\": {\n \"Gender\": 99,\n \"Age\": 51,\n \"Expression\": 99,\n \"Hat\": false,\n \"Glass\": false,\n \"EyeOpen\": true,\n \"Mask\": true,\n \"Hair\": {\n \"Length\": 1,\n \"Bang\": 1,\n \"Color\": 0\n },\n \"Pitch\": 17,\n \"Yaw\": 5,\n \"Roll\": -2,\n \"Beauty\": 71\n },\n \"FaceQualityInfo\": {\n \"Score\": 63,\n \"Sharpness\": 73,\n \"Brightness\": 47,\n \"Completeness\": {\n \"Eyebrow\": 99,\n \"Eye\": 99,\n \"Nose\": 99,\n \"Cheek\": 52,\n \"Mouth\": 99,\n \"Chin\": 47\n }\n }\n }\n ],\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"bcde47b5-e6d8-446e-a538-bcecffbe306a\"\n }\n}",
200
- "title": "人脸检测与分析接口成功示例"
194
+ "title": "人脸检测与分析接口开启质量检测成功示例"
201
195
  },
202
196
  {
203
- "document": "传入无人脸图片，检测人脸的位置、相应的面部属性和人脸质量信息。",
197
+ "document": "",
204
198
  "input": "https://iai.tencentcloudapi.com/?Action=DetectFace\n&MaxFaceNum=1\n&MinFaceSize=40\n&Url=http://test.image.myqcloud.com/testA.jpg\n&NeedFaceAttributes=1\n&NeedQualityDetection=1\n&<公共请求参数>",
205
199
  "output": "{\n \"Response\": {\n \"RequestId\": \"54eedbca-8704-4388-9b1c-4bdf1a4308a4\",\n \"Error\": {\n \"Code\": \"InvalidParameterValue.NoFaceInPhoto\",\n \"Message\": \"图片中没有人脸。\"\n }\n }\n}",
206
200
  "title": "人脸检测与分析接口失败示例"
@@ -208,13 +202,13 @@
208
202
  ],
209
203
  "DetectFaceAttributes": [
210
204
  {
211
- "document": "人脸检测与属性分析成功。",
205
+ "document": "",
212
206
  "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DetectFaceAttributes\n<公共请求参数>\n\n{\n \"Url\": \"http://test.image.myqcloud.com/testA.jpg\",\n \"FaceAttributesType\": \"eye\"\n}",
213
207
  "output": "{\n \"Response\": {\n \"ImageWidth\": 550,\n \"ImageHeight\": 366,\n \"FaceModelVersion\": \"3.0\",\n \"FaceDetailInfos\": [\n {\n \"FaceRect\": {\n \"X\": 375,\n \"Y\": 37,\n \"Width\": 63,\n \"Height\": 82\n },\n \"FaceDetailAttributesInfo\": {\n \"Age\": 0,\n \"Beauty\": 0,\n \"Emotion\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"Eye\": {\n \"Glass\": {\n \"Type\": 0,\n \"Probability\": 0.99936753511429\n },\n \"EyeOpen\": {\n \"Type\": 0,\n \"Probability\": 0.99949336051941\n },\n \"EyelidType\": {\n \"Type\": 1,\n \"Probability\": 0.75467920303345\n },\n \"EyeSize\": {\n \"Type\": 2,\n \"Probability\": 0.59152442216873\n }\n },\n \"Eyebrow\": {\n \"EyebrowDensity\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"EyebrowCurve\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"EyebrowLength\": {\n \"Type\": 0,\n \"Probability\": 0\n }\n },\n \"Gender\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"Hair\": {\n \"Length\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"Bang\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"Color\": {\n \"Type\": 0,\n \"Probability\": 0\n }\n },\n \"Hat\": {\n \"Style\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"Color\": {\n \"Type\": 0,\n \"Probability\": 0\n }\n },\n \"HeadPose\": {\n \"Pitch\": 0,\n \"Yaw\": 0,\n \"Roll\": 0\n },\n \"Mask\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"Mouth\": {\n \"MouthOpen\": {\n \"Type\": 0,\n \"Probability\": 0\n }\n },\n \"Moustache\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"Nose\": {\n \"Type\": 2,\n \"Probability\": 0.75233882665634\n },\n \"Shape\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"Skin\": {\n \"Type\": 0,\n \"Probability\": 0\n },\n \"Smile\": 0\n }\n }\n ],\n \"RequestId\": \"b2c154b9-4620-4d37-8fd1-f6af3748f998\"\n }\n}",
214
208
  "title": "人脸检测与属性分析成功示例"
215
209
  },
216
210
  {
217
- "document": "人脸检测与属性分析失败。",
211
+ "document": "",
218
212
  "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DetectFaceAttributes\n<公共请求参数>\n\n{\n \"Url\": \"http://test.image.myqcloud.com/testB.jpg\",\n \"FaceAttributesType\": \"eye\"\n}",
219
213
  "output": "{\n \"Response\": {\n \"RequestId\": \"ab0ebc1d-7a0e-4327-808b-3d24322a97dd\",\n \"Error\": {\n \"Code\": \"InvalidParameterValue.NoFaceInPhoto\",\n \"Message\": \"图片中没有人脸。\"\n }\n }\n}",
220
214
  "title": "人脸检测与属性分析失败示例"
@@ -230,18 +224,30 @@
230
224
  ],
231
225
  "DetectLiveFaceAccurate": [
232
226
  {
233
- "document": "判断是否是翻拍图片。",
227
+ "document": "",
234
228
  "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DetectLiveFaceAccurate\n<公共请求参数>\n\n{\n \"Url\": \"http://test.image.myqcloud.com/testA.jpg\"\n}",
235
229
  "output": "{\n \"Response\": {\n \"Score\": 99,\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"048a5eb3-f7a9-4c1f-a982-00e90b6b892c\"\n }\n}",
236
- "title": "人脸静态活体检测（高精度版）接口"
230
+ "title": "人脸静态活体检测（高精度版）成功示例"
231
+ },
232
+ {
233
+ "document": "",
234
+ "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DetectLiveFaceAccurate\n<公共请求参数>\n\n{\n \"Url\": \"http://test.image.myqcloud.com/testB.jpg\"\n}",
235
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.ImageDecodeFailed\",\n \"Message\": \"图片解码失败。\"\n },\n \"RequestId\": \"0e77ad29-ad65-4901-9efc-b49a6e0a357b\"\n }\n}",
236
+ "title": "人脸静态活体检测（高精度版）失败示例"
237
237
  }
238
238
  ],
239
239
  "GetGroupInfo": [
240
240
  {
241
- "document": "获取人员库信息。",
242
- "input": "https://iai.tencentcloudapi.com/?Action=GetGroupInfo\r\n&GroupId=aaa\r\n&<公共请求参数>",
241
+ "document": "",
242
+ "input": "https://iai.tencentcloudapi.com/?Action=GetGroupInfo\n&GroupId=31\n&<公共请求参数>",
243
243
  "output": "{\n \"Response\": {\n \"GroupName\": \"人员库\",\n \"GroupId\": \"31\",\n \"GroupExDescriptions\": [\n \"年龄\"\n ],\n \"Tag\": \"不含实习生\",\n \"FaceModelVersion\": \"3.0\",\n \"CreationTimestamp\": 1559530931613,\n \"RequestId\": \"6faa05d0-287b-464e-8755-cf3e8d0c703d\"\n }\n}",
244
- "title": "获取人员库信息"
244
+ "title": "获取人员库信息成功示例"
245
+ },
246
+ {
247
+ "document": "",
248
+ "input": "https://iai.tencentcloudapi.com/?Action=GetGroupInfo\n&GroupId=200\n&<公共请求参数>",
249
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdNotExist\",\n \"Message\": \"人员库ID不存在。\"\n },\n \"RequestId\": \"0e77ad29-ad65-4901-9efc-b49a6e0a357b\"\n }\n}",
250
+ "title": "获取人员库信息失败示例"
245
251
  }
246
252
  ],
247
253
  "GetGroupList": [
@@ -260,70 +266,58 @@
260
266
  ],
261
267
  "GetPersonBaseInfo": [
262
268
  {
263
- "document": "人员ID不存在。",
264
- "input": "https://iai.tencentcloudapi.com/?Action=GetPersonBaseInfo\r\n&PersonId=1002\r\n&<公共请求参数>",
265
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.PersonIdNotExist\",\n \"Message\": \"人员ID不存在。\"\n },\n \"RequestId\": \"98b4a0bc-802b-4764-9701-bc0c6c544395\"\n }\n}",
266
- "title": "错误示例"
267
- },
268
- {
269
- "document": "获取指定人员的信息，包括姓名、性别、人脸等。",
269
+ "document": "",
270
270
  "input": "https://iai.tencentcloudapi.com/?Action=GetPersonBaseInfo\r\n&PersonId=1001\r\n&<公共请求参数>",
271
271
  "output": "{\n \"Response\": {\n \"PersonName\": \"EvanLiao\",\n \"Gender\": 1,\n \"FaceIds\": [\n \"2873640802022644880\",\n \"2875186538564559728\"\n ],\n \"RequestId\": \"9568a077-0710-40d2-9d6a-b9483d3f2051\"\n }\n}",
272
- "title": "获取人员基础信息接口"
272
+ "title": "获取人员基础信息成功示例"
273
+ },
274
+ {
275
+ "document": "",
276
+ "input": "https://iai.tencentcloudapi.com/?Action=GetPersonBaseInfo\r\n&PersonId=1002\r\n&<公共请求参数>",
277
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.PersonIdNotExist\",\n \"Message\": \"人员ID不存在。\"\n },\n \"RequestId\": \"98b4a0bc-802b-4764-9701-bc0c6c544395\"\n }\n}",
278
+ "title": "获取人员基础信息失败示例"
273
279
  }
274
280
  ],
275
281
  "GetPersonGroupInfo": [
276
282
  {
277
- "document": "人员ID不存在。",
278
- "input": "https://iai.tencentcloudapi.com/?Action=GetPersonGroupInfo\r\n&PersonId=1002\r\n&Offset=0\r\n&Limit=10\r\n&<公共请求参数>",
279
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.PersonIdNotExist\",\n \"Message\": \"人员ID不存在。\"\n },\n \"RequestId\": \"98330f25-eb2e-432a-a30c-3830774210c1\"\n }\n}",
280
- "title": "错误示例"
281
- },
282
- {
283
- "document": "获取人员归属信息。",
283
+ "document": "",
284
284
  "input": "https://iai.tencentcloudapi.com/?Action=GetPersonGroupInfo\r\n&PersonId=2001\r\n&Offset=0\r\n&Limit=10\r\n&<公共请求参数>",
285
285
  "output": "{\n \"Response\": {\n \"GroupNum\": \"1\",\n \"PersonGroupInfos\": [\n {\n \"GroupId\": \"ZhuYuanDormitoryNo1\",\n \"PersonExDescriptions\": [\n \"计算机学院\",\n \"软件工程\",\n \"15级\",\n \"3150108080\"\n ]\n }\n ],\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"671f0a1d-2b35-47c4-b9d1-b18053f71a04\"\n }\n}",
286
- "title": "获取人员归属信息接口"
286
+ "title": "获取人员归属信息成功示例"
287
287
  },
288
288
  {
289
- "document": "获取人员归属信息。",
290
- "input": "https://iai.tencentcloudapi.com/?Action=GetPersonGroupInfo\r\n&PersonId=1001\r\n&Offset=0\r\n&Limit=10\r\n&<公共请求参数>",
291
- "output": "{\n \"Response\": {\n \"GroupNum\": \"1\",\n \"PersonGroupInfos\": [\n {\n \"GroupId\": \"TencentShenZhenEmployee\",\n \"PersonExDescriptions\": [\n \"云与智慧产业事业群\",\n \"大数据及人工智能产品中心\",\n \"人脸识别产品组\"\n ]\n }\n ],\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"b7a505ad-4a85-42da-97b3-886c7999fb76\"\n }\n}",
292
- "title": "获取人员归属信息接口-2"
289
+ "document": "",
290
+ "input": "https://iai.tencentcloudapi.com/?Action=GetPersonGroupInfo\r\n&PersonId=1002\r\n&Offset=0\r\n&Limit=10\r\n&<公共请求参数>",
291
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.PersonIdNotExist\",\n \"Message\": \"人员ID不存在。\"\n },\n \"RequestId\": \"98330f25-eb2e-432a-a30c-3830774210c1\"\n }\n}",
292
+ "title": "获取人员归属信息失败示例"
293
293
  }
294
294
  ],
295
295
  "GetPersonList": [
296
296
  {
297
- "document": "输入不存在的人员库ID。",
298
- "input": "https://iai.tencentcloudapi.com/?Action=GetPersonList\r\n&GroupId=ZhuYuanDormitory\r\n&Offset=0\r\n&Limit=10\r\n&<公共请求参数>",
299
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdNotExist\",\n \"Message\": \"人员库ID不存在。\"\n },\n \"RequestId\": \"b7c0cd81-d621-465f-8fd6-86a6b49e67be\"\n }\n}",
300
- "title": "错误示例"
301
- },
302
- {
303
- "document": "获取人员列表。",
297
+ "document": "",
304
298
  "input": "https://iai.tencentcloudapi.com/?Action=GetPersonList\r\n&GroupId=ZhuYuanDormitoryNo1\r\n&Offset=0\r\n&Limit=10\r\n&<公共请求参数>",
305
299
  "output": "{\n \"Response\": {\n \"PersonInfos\": [\n {\n \"PersonName\": \"Junly\",\n \"PersonId\": \"2001\",\n \"Gender\": 1,\n \"PersonExDescriptions\": [\n \"计算机学院\",\n \"软件工程\",\n \"15级\",\n \"3150108080\"\n ],\n \"FaceIds\": [\n \"2877244861637985315\"\n ],\n \"CreationTimestamp\": 1594642823572\n }\n ],\n \"PersonNum\": 1,\n \"FaceNum\": 1,\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"337d1bb5-3f88-4681-9291-5194f478f0d1\"\n }\n}",
306
- "title": "获取人员列表接口"
300
+ "title": "获取人员列表成功示例"
307
301
  },
308
302
  {
309
- "document": "获取人员列表。",
310
- "input": "https://iai.tencentcloudapi.com/?Action=GetPersonList\r\n&GroupId=TencentShenZhenEmployee\r\n&Offset=0\r\n&Limit=10\r\n&<公共请求参数>",
311
- "output": "{\n \"Response\": {\n \"PersonInfos\": [\n {\n \"PersonName\": \"evanliao\",\n \"PersonId\": \"1001\",\n \"Gender\": 1,\n \"PersonExDescriptions\": [\n \"云与智慧产业事业群\",\n \"大数据及人工智能产品中心\",\n \"人脸识别产品组\"\n ],\n \"FaceIds\": [\n \"2877242150180891493\"\n ],\n \"CreationTimestamp\": 1594642823572\n }\n ],\n \"PersonNum\": 1,\n \"FaceNum\": 1,\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"aa292f16-27d9-423b-9048-cdd43f6e4156\"\n }\n}",
312
- "title": "获取人员列表接口-2"
303
+ "document": "",
304
+ "input": "https://iai.tencentcloudapi.com/?Action=GetPersonList\r\n&GroupId=ZhuYuanDormitory\r\n&Offset=0\r\n&Limit=10\r\n&<公共请求参数>",
305
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdNotExist\",\n \"Message\": \"人员库ID不存在。\"\n },\n \"RequestId\": \"b7c0cd81-d621-465f-8fd6-86a6b49e67be\"\n }\n}",
306
+ "title": "获取人员列表失败示例"
313
307
  }
314
308
  ],
315
309
  "GetPersonListNum": [
316
310
  {
317
- "document": "人员库ID不存在。",
318
- "input": "https://iai.tencentcloudapi.com/?Action=GetPersonListNum\n&GroupId=Tencent\n&<公共请求参数>",
319
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdNotExist\",\n \"Message\": \"人员库ID不存在。\"\n },\n \"RequestId\": \"2865a458-4db1-46bd-ae52-b7507c9f4e62\"\n }\n}",
320
- "title": "错误示例"
321
- },
322
- {
323
- "document": "获取指定人员库中人员数量。",
311
+ "document": "",
324
312
  "input": "https://iai.tencentcloudapi.com/?Action=GetPersonListNum\n&GroupId=TencentShenZhenEmployee\n&<公共请求参数>",
325
313
  "output": "{\n \"Response\": {\n \"PersonNum\": 2,\n \"FaceNum\": 2,\n \"RequestId\": \"18fb1e31-0d33-4371-9f41-b1fd59e0c781\"\n }\n}",
326
- "title": "获取人员列表长度接口"
314
+ "title": "获取人员库中人员数量成功示例"
315
+ },
316
+ {
317
+ "document": "",
318
+ "input": "https://iai.tencentcloudapi.com/?Action=GetPersonListNum\n&GroupId=Tencent\n&<公共请求参数>",
319
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdNotExist\",\n \"Message\": \"人员库ID不存在。\"\n },\n \"RequestId\": \"2865a458-4db1-46bd-ae52-b7507c9f4e62\"\n }\n}",
320
+ "title": "获取人员库中人员数量失败示例"
327
321
  }
328
322
  ],
329
323
  "GetUpgradeGroupFaceModelVersionJobList": [
@@ -356,62 +350,56 @@
356
350
  ],
357
351
  "ModifyGroup": [
358
352
  {
359
- "document": "同一人员库中自定义描述字段不可重复。",
360
- "input": "https://iai.tencentcloudapi.com/?Action=ModifyGroup\r\n&GroupId=TencentShenZhenEmployee\r\n&GroupExDescriptionInfos.0.GroupExDescriptionIndex=0\r\n&GroupExDescriptionInfos.0.GroupExDescription=部门\r\n&<公共请求参数>",
361
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.DuplicatedGroupDescription\",\n \"Message\": \"同一人员库中自定义描述字段不可重复。\"\n },\n \"RequestId\": \"4b483679-3f08-4a7c-b827-4a6332dc030f\"\n }\n}",
362
- "title": "错误示例"
363
- },
364
- {
365
- "document": "人员库名称不可重复",
366
- "input": "https://iai.tencentcloudapi.com/?Action=ModifyGroup\r\n&GroupId=TencentShenZhenEmployee\r\n&GroupName=某某大学竹园1号宿舍楼\r\n&<公共请求参数>",
367
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupNameAlreadyExist\",\n \"Message\": \"人员库名称已经存在。人员库名称不可重复。\"\n },\n \"RequestId\": \"2dcce170-30cf-4078-9b3c-309362fbad21\"\n }\n}",
368
- "title": "错误示例-人员库名称不可重复"
369
- },
370
- {
371
- "document": "修改人员库。",
353
+ "document": "",
372
354
  "input": "https://iai.tencentcloudapi.com/?Action=ModifyGroup\r\n&GroupId=ZhuYuanDormitoryNo1\r\n&GroupName=某某大学竹园1号宿舍楼\r\n&Tag=研究生入住\r\n&GroupExDescriptionInfos.0.GroupExDescriptionIndex=0\r\n&GroupExDescriptionInfos.0.GroupExDescription=学院\r\n&<公共请求参数>",
373
355
  "output": "{\n \"Response\": {\n \"RequestId\": \"da051f16-0400-49d4-9832-2cfd3b51866f\"\n }\n}",
374
356
  "title": "修改人员库成功示例"
375
357
  },
376
358
  {
377
- "document": "修改人员库名称、备注、自定义描述字段名称。",
359
+ "document": "",
378
360
  "input": "https://iai.tencentcloudapi.com/?Action=ModifyGroup\r\n&GroupId=TencentShenZhenEmployee\r\n&GroupName=腾讯深圳在职人员库\r\n&Tag=包含实习生\r\n&GroupExDescriptionInfos.0.GroupExDescriptionIndex=1\r\n&GroupExDescriptionInfos.0.GroupExDescription=部门\r\n&GroupExDescriptionInfos.1.GroupExDescriptionIndex=2\r\n&GroupExDescriptionInfos.1.GroupExDescription=项目组\r\n&<公共请求参数>",
379
361
  "output": "{\n \"Response\": {\n \"RequestId\": \"98381738-509f-4749-8a66-dbf54247333d\"\n }\n}",
380
- "title": "修改人员库名称、备注、自定义描述字段名称示例"
362
+ "title": "修改人员库名称、备注等信息的成功示例"
363
+ },
364
+ {
365
+ "document": "",
366
+ "input": "https://iai.tencentcloudapi.com/?Action=ModifyGroup\r\n&GroupId=TencentShenZhenEmployee\r\n&GroupExDescriptionInfos.0.GroupExDescriptionIndex=0\r\n&GroupExDescriptionInfos.0.GroupExDescription=部门\r\n&<公共请求参数>",
367
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.DuplicatedGroupDescription\",\n \"Message\": \"同一人员库中自定义描述字段不可重复。\"\n },\n \"RequestId\": \"4b483679-3f08-4a7c-b827-4a6332dc030f\"\n }\n}",
368
+ "title": "修改人员库字段重复错误示例"
369
+ },
370
+ {
371
+ "document": "",
372
+ "input": "https://iai.tencentcloudapi.com/?Action=ModifyGroup\r\n&GroupId=TencentShenZhenEmployee\r\n&GroupName=某某大学竹园1号宿舍楼\r\n&<公共请求参数>",
373
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupNameAlreadyExist\",\n \"Message\": \"人员库名称已经存在。人员库名称不可重复。\"\n },\n \"RequestId\": \"2dcce170-30cf-4078-9b3c-309362fbad21\"\n }\n}",
374
+ "title": "修改人员库名称重复错误示例"
381
375
  }
382
376
  ],
383
377
  "ModifyPersonBaseInfo": [
384
378
  {
385
- "document": "修改人员基础信息。",
379
+ "document": "",
386
380
  "input": "https://iai.tencentcloudapi.com/?Action=ModifyPersonBaseInfo\n&PersonId=2001\n&PersonName=JunlyWang\n&Gender=1\n&<公共请求参数>",
387
381
  "output": "{\n \"Response\": {\n \"RequestId\": \"6e2a0fb7-7c9e-45c7-abf1-338457d1def7\"\n }\n}",
388
- "title": "修改人员基础信息接口"
382
+ "title": "修改人员基础信息成功示例"
389
383
  },
390
384
  {
391
- "document": "修改人员基础信息。",
392
- "input": "https://iai.tencentcloudapi.com/?Action=ModifyPersonBaseInfo\n&PersonId=1001\n&PersonName=EvanLiao\n&Gender=1\n&<公共请求参数>",
393
- "output": "{\n \"Response\": {\n \"RequestId\": \"6e2a0fb7-7c9e-45c7-abf1-338457d1def7\"\n }\n}",
394
- "title": "修改人员基础信息接口-2"
385
+ "document": "",
386
+ "input": "https://iai.tencentcloudapi.com/?Action=ModifyPersonBaseInfo\n&PersonId=9001\n&PersonName=EvanLiao\n&Gender=1\n&<公共请求参数>",
387
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.GroupPersonMapExist\",\n \"Message\": \"组中已包含对应的人员Id。\"\n },\n \"RequestId\": \"f944657d-6260-4a2e-a4d8-9c1845f39e56\"\n }\n}",
388
+ "title": "修改人员基础信息失败示例"
395
389
  }
396
390
  ],
397
391
  "ModifyPersonGroupInfo": [
398
392
  {
399
- "document": "人员库ID不存在。",
400
- "input": "https://iai.tencentcloudapi.com/?Action=ModifyPersonGroupInfo\n&GroupId=TencentShenZhenEmployee\n&PersonId=1001\n&PersonExDescriptionInfos.0.PersonExDescriptionIndex=1\n&PersonExDescriptionInfos.0.PersonExDescription=人工智能实验室\n&<公共请求参数>",
401
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdNotExist\",\n \"Message\": \"人员库ID不存在。\"\n },\n \"RequestId\": \"f944657d-6260-4a2e-a4d8-9c1845f39e56\"\n }\n}",
402
- "title": "错误示例"
403
- },
404
- {
405
- "document": "修改人员描述信息。",
393
+ "document": "",
406
394
  "input": "https://iai.tencentcloudapi.com/?Action=ModifyPersonGroupInfo\r\n&GroupId=ZhuYuanDormitoryNo1\r\n&PersonId=2001\r\n&PersonExDescriptionInfos.0.PersonExDescriptionIndex=3\r\n&PersonExDescriptionInfos.0.PersonExDescription=3150108080\r\n&<公共请求参数>",
407
395
  "output": "{\n \"Response\": {\n \"RequestId\": \"77e11a2d-0fc0-4fba-ab25-016e998221c3\"\n }\n}",
408
- "title": "修改人员描述信息接口"
396
+ "title": "修改人员描述信息成功示例"
409
397
  },
410
398
  {
411
- "document": "修改人员描述信息。",
412
- "input": "https://iai.tencentcloudapi.com/?Action=ModifyPersonGroupInfo\r\n&GroupId=TencentShenZhenEmployee\r\n&PersonId=1001\r\n&PersonExDescriptionInfos.0.PersonExDescriptionIndex=1\r\n&PersonExDescriptionInfos.0.PersonExDescription=大数据及人工智能产品中心\r\n&<公共请求参数>",
413
- "output": "{\n \"Response\": {\n \"RequestId\": \"77e11a2d-0fc0-4fba-ab25-016e998221c3\"\n }\n}",
414
- "title": "修改人员描述信息接口-2"
399
+ "document": "",
400
+ "input": "https://iai.tencentcloudapi.com/?Action=ModifyPersonGroupInfo\n&GroupId=TencentShenZhenEmployee\n&PersonId=1001\n&PersonExDescriptionInfos.0.PersonExDescriptionIndex=1\n&PersonExDescriptionInfos.0.PersonExDescription=人工智能实验室\n&<公共请求参数>",
401
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameterValue.GroupIdNotExist\",\n \"Message\": \"人员库ID不存在。\"\n },\n \"RequestId\": \"f944657d-6260-4a2e-a4d8-9c1845f39e56\"\n }\n}",
402
+ "title": "修改人员描述信息失败示例"
415
403
  }
416
404
  ],
417
405
  "RevertGroupFaceModelVersion": [
@@ -424,58 +412,58 @@
424
412
  ],
425
413
  "SearchFaces": [
426
414
  {
427
- "document": "MaxFaceNum不能大于10。",
428
- "input": "https://iai.tencentcloudapi.com/?Action=SearchFaces\n&Url=http://test.image.myqcloud.com/testA.jpg\n&MaxFaceNum=11\n&GroupIds.0=TencentShenZhenEmployee\n&<公共请求参数>",
429
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.SearchFacesExceed\",\n \"Message\": \"检索人脸个数超过限制。\"\n },\n \"RequestId\": \"f04ba2f3-532c-4207-9caa-6e818ded7fb9\"\n }\n}",
430
- "title": "错误示例"
431
- },
432
- {
433
- "document": "图片URL错误。",
434
- "input": "https://iai.tencentcloudapi.com/?Action=SearchFaces\n&Url=http://test.image.myqcloud.com/testA\n&GroupIds.0=TencentShenZhenEmployee\n&<公共请求参数>",
435
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.ImageDownloadError\",\n \"Message\": \"图片下载错误。\"\n },\n \"RequestId\": \"527ecffe-4c6a-47c9-8217-4dd2e3f018da\"\n }\n}",
436
- "title": "错误示例-2"
437
- },
438
- {
439
- "document": "人脸搜索。",
415
+ "document": "",
440
416
  "input": "https://iai.tencentcloudapi.com/?Action=SearchFaces\n&Url=http://test.image.myqcloud.com/testA.jpg\n&MaxFaceNum=1\n&MinFaceSize=40\n&MaxPersonNum=5\n&GroupIds.0=TencentShenZhenEmployee\n&<公共请求参数>",
441
417
  "output": "{\n \"Response\": {\n \"Results\": [\n {\n \"RetCode\": 0,\n \"Candidates\": [\n {\n \"PersonId\": \"1001\",\n \"FaceId\": \"2875093635484912302\",\n \"PersonName\": \"Jerry\",\n \"Gender\": 0,\n \"Score\": 100,\n \"PersonGroupInfos\": [\n {\n \"GroupId\": \"abc\",\n \"PersonExDescriptions\": [\n \"description1\",\n \"description2\"\n ]\n }\n ]\n }\n ],\n \"FaceRect\": {\n \"X\": 370,\n \"Y\": 46,\n \"Width\": 75,\n \"Height\": 75\n }\n }\n ],\n \"FaceNum\": 1,\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"57b42b73-b978-45b9-8095-8f50e9642d35\"\n }\n}",
442
- "title": "人脸搜索接口"
418
+ "title": "人脸搜索成功示例"
419
+ },
420
+ {
421
+ "document": "",
422
+ "input": "https://iai.tencentcloudapi.com/?Action=SearchFaces\n&Url=http://test.image.myqcloud.com/testA.jpg\n&MaxFaceNum=11\n&GroupIds.0=TencentShenZhenEmployee\n&<公共请求参数>",
423
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.SearchFacesExceed\",\n \"Message\": \"检索人脸个数超过限制。\"\n },\n \"RequestId\": \"f04ba2f3-532c-4207-9caa-6e818ded7fb9\"\n }\n}",
424
+ "title": "人脸搜索失败示例"
443
425
  }
444
426
  ],
445
427
  "SearchFacesReturnsByGroup": [
446
428
  {
447
- "document": "输入图片，在人员库中识别出最相似的人员。",
429
+ "document": "",
448
430
  "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SearchFacesReturnsByGroup\n<公共请求参数>\n\n{\n \"Url\": \"http://test.image.myqcloud.com/testA.jpg\",\n \"MaxPersonNumPerGroup\": \"5\",\n \"GroupIds\": [\n \"TencentShenZhenEmployee\"\n ],\n \"MaxFaceNum\": \"1\",\n \"MinFaceSize\": \"40\"\n}",
449
431
  "output": "{\n \"Response\": {\n \"FaceNum\": 1,\n \"ResultsReturnsByGroup\": [\n {\n \"GroupCandidates\": [\n {\n \"Candidates\": [\n {\n \"PersonGroupInfos\": [\n {\n \"GroupId\": \"1002\",\n \"PersonExDescriptions\": [\n \"年龄\",\n \"性别\"\n ]\n }\n ],\n \"PersonId\": \"1002\",\n \"Gender\": 0,\n \"PersonName\": \"韦小宝\",\n \"Score\": 100,\n \"FaceId\": \"2875093635484912302\"\n }\n ],\n \"GroupId\": \"Group1\"\n }\n ],\n \"FaceRect\": {\n \"Y\": 46,\n \"X\": 370,\n \"Height\": 1,\n \"Width\": 1\n },\n \"RetCode\": 0\n }\n ],\n \"RequestId\": \"57b42b73-b978-45b9-8095-8f50e9642d35\",\n \"FaceModelVersion\": \"3.0\"\n }\n}",
450
- "title": "人脸搜索分库返回接口"
432
+ "title": "人脸搜索分库返回成功示例"
433
+ },
434
+ {
435
+ "document": "",
436
+ "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SearchFacesReturnsByGroup\n<公共请求参数>\n\n{\n \"Url\": \"http://test.image.myqcloud.com/testB.jpg\",\n \"MaxPersonNumPerGroup\": \"5\",\n \"GroupIds\": [\n \"TencentShenZhenEmployee\"\n ],\n \"MaxFaceNum\": \"1\",\n \"MinFaceSize\": \"40\"\n}",
437
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.ImageDecodeFailed\",\n \"Message\": \"图片解码失败。\"\n },\n \"RequestId\": \"0e77ad29-ad65-4901-9efc-b49a6e0a357b\"\n }\n}",
438
+ "title": "人脸搜索分库返回失败示例"
451
439
  }
452
440
  ],
453
441
  "SearchPersons": [
454
442
  {
455
- "document": "图片URL错误。",
456
- "input": "https://iai.tencentcloudapi.com/?Action=SearchPersons\n&Url=http://test.image.myqcloud.com/testA\n&GroupIds.0=TencentShenZhenEmployee\n&<公共请求参数>",
457
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.ImageDownloadError\",\n \"Message\": \"图片下载错误。\"\n },\n \"RequestId\": \"527ecffe-4c6a-47c9-8217-4dd2e3f018da\"\n }\n}",
458
- "title": "错误示例"
459
- },
460
- {
461
- "document": "输入人脸图片，在人员库中识别出最相似的 TopK 人员。",
443
+ "document": "",
462
444
  "input": "https://iai.tencentcloudapi.com/?Action=SearchPersons\n&Url=http://test.image.myqcloud.com/testA.jpg\n&MaxFaceNum=2\n&MinFaceSize=40\n&MaxPersonNum=3\n&GroupIds.0=TencentShenZhenEmployee\n&<公共请求参数>",
463
445
  "output": "{\n \"Response\": {\n \"Results\": [\n {\n \"RetCode\": 0,\n \"Candidates\": [\n {\n \"PersonId\": \"person1\",\n \"FaceId\": \"\",\n \"Score\": 100,\n \"PersonName\": null,\n \"Gender\": null,\n \"PersonGroupInfos\": null\n },\n {\n \"PersonId\": \"person2\",\n \"FaceId\": \"\",\n \"Score\": 60,\n \"PersonName\": null,\n \"Gender\": null,\n \"PersonGroupInfos\": null\n },\n {\n \"PersonId\": \"person3\",\n \"FaceId\": \"\",\n \"Score\": 50,\n \"PersonName\": null,\n \"Gender\": null,\n \"PersonGroupInfos\": null\n }\n ],\n \"FaceRect\": {\n \"X\": 139,\n \"Y\": 59,\n \"Width\": 124,\n \"Height\": 162\n }\n },\n {\n \"RetCode\": 0,\n \"Candidates\": [\n {\n \"PersonId\": \"person2\",\n \"FaceId\": \"\",\n \"Score\": 100,\n \"PersonName\": null,\n \"Gender\": null,\n \"PersonGroupInfos\": null\n },\n {\n \"PersonId\": \"person1\",\n \"FaceId\": \"\",\n \"Score\": 60,\n \"PersonName\": null,\n \"Gender\": null,\n \"PersonGroupInfos\": null\n },\n {\n \"PersonId\": \"person3\",\n \"FaceId\": \"\",\n \"Score\": 20,\n \"PersonName\": null,\n \"Gender\": null,\n \"PersonGroupInfos\": null\n }\n ],\n \"FaceRect\": {\n \"X\": 328,\n \"Y\": 70,\n \"Width\": 119,\n \"Height\": 162\n }\n }\n ],\n \"PersonNum\": 5,\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"c4608852-ff60-4a01-8dc3-367f6046baaf\"\n }\n}",
464
- "title": "人员搜索接口"
446
+ "title": "人员搜索成功示例"
447
+ },
448
+ {
449
+ "document": "",
450
+ "input": "https://iai.tencentcloudapi.com/?Action=SearchPersons\n&Url=http://test.image.myqcloud.com/testA\n&GroupIds.0=TencentShenZhenEmployee\n&<公共请求参数>",
451
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.ImageDownloadError\",\n \"Message\": \"图片下载错误。\"\n },\n \"RequestId\": \"527ecffe-4c6a-47c9-8217-4dd2e3f018da\"\n }\n}",
452
+ "title": "人员搜索失败示例"
465
453
  }
466
454
  ],
467
455
  "SearchPersonsReturnsByGroup": [
468
456
  {
469
- "document": "图片下载错误。",
470
- "input": "https://iai.tencentcloudapi.com/?Action=SearchPersonsReturnsByGroup\r\n&Url=http://test.image.myqcloud.com/testB.jpg\r\n&MaxFaceNum=1\r\n&MinFaceSize=40\r\n&MaxPersonNumPerGroup=5\r\n&GroupIds.0=TencentShenZhenEmployee\r\n&<公共请求参数>",
471
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.ImageDownloadError\",\n \"Message\": \"图片下载错误。\"\n },\n \"RequestId\": \"527ecffe-4c6a-47c9-8217-4dd2e3f018da\"\n }\n}",
472
- "title": "错误示例"
473
- },
474
- {
475
- "document": "输入人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员。",
457
+ "document": "",
476
458
  "input": "https://iai.tencentcloudapi.com/?Action=SearchPersonsReturnsByGroup\r\n&Url=http://test.image.myqcloud.com/testA.jpg\r\n&MaxFaceNum=1\r\n&MinFaceSize=40\r\n&MaxPersonNumPerGroup=5\r\n&GroupIds.0=TencentShenZhenEmployee\r\n&<公共请求参数>",
477
459
  "output": "{\n \"Response\": {\n \"ResultsReturnsByGroup\": [\n {\n \"RetCode\": 0,\n \"FaceRect\": {\n \"X\": 375,\n \"Y\": 37,\n \"Width\": 63,\n \"Height\": 82\n },\n \"GroupCandidates\": [\n {\n \"GroupId\": \"TencentShenZhenEmployee\",\n \"Candidates\": [\n {\n \"PersonId\": \"testtest3\",\n \"FaceId\": \"\",\n \"Score\": 100,\n \"PersonName\": null,\n \"Gender\": null,\n \"PersonGroupInfos\": null\n }\n ]\n }\n ]\n }\n ],\n \"PersonNum\": 1,\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"c8a06ec5-ecb4-4dd7-a8c8-ce5e675495c2\"\n }\n}",
478
- "title": "人员搜索分库返回接口"
460
+ "title": "人员搜索按库返回成功示例"
461
+ },
462
+ {
463
+ "document": "",
464
+ "input": "https://iai.tencentcloudapi.com/?Action=SearchPersonsReturnsByGroup\r\n&Url=http://test.image.myqcloud.com/testB.jpg\r\n&MaxFaceNum=1\r\n&MinFaceSize=40\r\n&MaxPersonNumPerGroup=5\r\n&GroupIds.0=TencentShenZhenEmployee\r\n&<公共请求参数>",
465
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.ImageDownloadError\",\n \"Message\": \"图片下载错误。\"\n },\n \"RequestId\": \"527ecffe-4c6a-47c9-8217-4dd2e3f018da\"\n }\n}",
466
+ "title": "人员搜索按库返回失败示例"
479
467
  }
480
468
  ],
481
469
  "UpgradeGroupFaceModelVersion": [
@@ -494,18 +482,30 @@
494
482
  ],
495
483
  "VerifyFace": [
496
484
  {
497
- "document": "判断图片中的人和 PersonId 对应的人是否为同一人。",
485
+ "document": "",
498
486
  "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VerifyFace\n<公共请求参数>\n\n{\n \"Url\": \"http://test.image.myqcloud.com/testA.jpg\",\n \"PersonId\": \"1001\"\n}",
499
487
  "output": "{\n \"Response\": {\n \"Score\": 100,\n \"IsMatch\": true,\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"a8eb4545-a154-4f86-9510-57a8be9cae0c\"\n }\n}",
500
- "title": "人脸验证接口"
488
+ "title": "人脸验证成功示例"
489
+ },
490
+ {
491
+ "document": "",
492
+ "input": "POST / HTTP/1.1\nHost: iai.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: VerifyFace\n<公共请求参数>\n\n{\n \"Url\": \"http://test.image.myqcloud.com/testB.jpg\",\n \"PersonId\": \"1001\"\n}",
493
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.ImageDecodeFailed\",\n \"Message\": \"图片解码失败。\"\n },\n \"RequestId\": \"0e77ad29-ad65-4901-9efc-b49a6e0a357b\"\n }\n}",
494
+ "title": "人脸验证失败示例"
501
495
  }
502
496
  ],
503
497
  "VerifyPerson": [
504
498
  {
505
- "document": "判断图片中的人和 PersonId 对应的人是否为同一人。",
499
+ "document": "",
506
500
  "input": "https://iai.tencentcloudapi.com/?Action=VerifyPerson\n&Url=http://test.image.myqcloud.com/testA.jpg\n&PersonId=1001\n&<公共请求参数>",
507
501
  "output": "{\n \"Response\": {\n \"Score\": 100,\n \"IsMatch\": true,\n \"FaceModelVersion\": \"3.0\",\n \"RequestId\": \"a8eb4545-a154-4f86-9510-57a8be9cae0c\"\n }\n}",
508
- "title": "人脸验证接口"
502
+ "title": "人脸验证成功示例"
503
+ },
504
+ {
505
+ "document": "",
506
+ "input": "https://iai.tencentcloudapi.com/?Action=VerifyPerson\n&Url=http://test.image.myqcloud.com/testB.jpg\n&PersonId=1001\n&<公共请求参数>",
507
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation.ImageDecodeFailed\",\n \"Message\": \"图片解码失败。\"\n },\n \"RequestId\": \"0e77ad29-ad65-4901-9efc-b49a6e0a357b\"\n }\n}",
508
+ "title": "人脸验证失败示例"
509
509
  }
510
510
  ]
511
511
  },