tencentcloud-sdk-nodejs-faceid 4.1.191 → 4.1.203

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-faceid",
3
- "version": "4.1.191",
3
+ "version": "4.1.203",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -838,41 +838,19 @@ export interface DetectInfoVideoData {
838
838
  */
839
839
  export interface DetectAIFakeFacesRequest {
840
840
  /**
841
- * 传入需要检测的人脸图片或人脸视频(当前仅支持单人脸检测),使用base64编码的形式,如您的场景视频和图片都有,我们更建议您使用视频进行检测,为了提供更好的检测效果,请您注意以下输入数据的限制与建议:
842
-
843
- - 图片的Base64值:
844
- 建议整体图像480x640的分辨率,脸部大小在 100X100 以上,由手机前置摄像头拍摄。
845
- Base64编码后的图片数据大小建议不超过3M、最大不可超过10M,仅支持jpg、png格式。
846
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
847
-
848
- - 视频的Base64值:
849
- Base64编码后的大小建议在8M以内、最大不可超过10M,支持mp4、avi、flv格式,由手机前置摄像头拍摄。
850
- 视频建议时长为2~5s,最大不可超过20s。
851
- 视频分辨率建议为480x640(最大支持720p),帧率在25fps~30fps之间。
852
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
853
-
854
- 若您未使用Encryption进行加密传输,则本字段为必填参数。
841
+ * <p>传入需要检测的人脸图片或人脸视频(当前仅支持单人脸检测),使用base64编码的形式,如您的场景视频和图片都有,我们更建议您使用视频进行检测,为了提供更好的检测效果,请您注意以下输入数据的限制与建议:</p><ul><li><p>图片的Base64值:<br>建议整体图像480x640的分辨率,脸部大小在 100X100 以上,由手机前置摄像头拍摄。<br>Base64编码后的图片数据大小建议不超过3M、最大不可超过10M,仅支持jpg、png格式。<br>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</p></li><li><p>视频的Base64值:<br>Base64编码后的大小建议在8M以内、最大不可超过10M,支持mp4、avi、flv格式,由手机前置摄像头拍摄。<br>视频建议时长为2~5s,最大不可超过20s。<br>视频分辨率建议为480x640(最大支持720p),帧率在25fps~30fps之间。<br>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</p></li></ul><p>若您未使用Encryption进行加密传输,则本字段为必填参数。</p>
855
842
  */
856
843
  FaceInput?: string;
857
844
  /**
858
- * 传入的类型。
859
- - 取值范围:
860
- 1:传入的是图片类型。
861
- 2:传入的是视频类型。
862
- 其他:返回错误码InvalidParameter。
863
-
864
- 若您未使用Encryption进行加密传输,则本字段为必填参数。
845
+ * <p>传入的类型。</p><ul><li>取值范围:<br>1:传入的是图片类型。<br>2:传入的是视频类型。<br>其他:返回错误码InvalidParameter。</li></ul><p>若您未使用Encryption进行加密传输,则本字段为必填参数。</p>
865
846
  */
866
847
  FaceInputType?: number;
867
848
  /**
868
- * 是否需要对请求信息进行全包体加密。
869
- - 支持的加密算法:AES-256-CBC、SM4-GCM。
870
- - 有加密需求的用户可使用此参数,详情请点击左侧链接。
849
+ * <p>是否需要对请求信息进行全包体加密。</p><ul><li>支持的加密算法:AES-256-CBC、SM4-GCM。</li><li>有加密需求的用户可使用此参数,详情请点击左侧链接。</li></ul>
871
850
  */
872
851
  Encryption?: Encryption;
873
852
  /**
874
- * 加密后的密文。
875
- - 加密前的数据格式如下:{"FaceInput":"AAAAA","FaceInputType":1}。
853
+ * <p>加密后的密文。</p><ul><li>加密前的数据格式如下:{&quot;FaceInput&quot;:&quot;AAAAA&quot;,&quot;FaceInputType&quot;:1}。</li></ul>
876
854
  */
877
855
  EncryptedBody?: string;
878
856
  }
@@ -1162,22 +1140,15 @@ export interface GetFaceIdResultResponse {
1162
1140
  */
1163
1141
  export interface DetectAIFakeFacesResponse {
1164
1142
  /**
1165
- * 对于输入图片/视频的检测结果,检测是否存在人脸攻击。
1166
- - Low:低攻击风险。
1167
- - Mid:中度疑似攻击。
1168
- - High:高度疑似攻击。
1169
-
1170
- 建议返回值为High时判断为拦截,Mid和Low判断为通过,以更好平衡安全性和通过率。
1143
+ * <p>对于输入图片/视频的检测结果,检测是否存在人脸攻击。</p><ul><li>Low:低攻击风险。</li><li>Mid:中度疑似攻击。</li><li>High:高度疑似攻击。</li></ul><p>建议返回值为High时判断为拦截,Mid和Low判断为通过,以更好平衡安全性和通过率。</p>
1171
1144
  */
1172
1145
  AttackRiskLevel?: string;
1173
1146
  /**
1174
- * 检测到的疑似攻击痕迹列表,仅当AttackRiskLevel为High或Mid时返回。
1175
- - 说明:未检测到攻击痕迹时,返回空数组。
1176
- - 此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。
1147
+ * <p>检测到的疑似攻击痕迹列表,仅当AttackRiskLevel为High或Mid时返回。</p><ul><li>说明:未检测到攻击痕迹时,返回空数组。</li><li>此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。</li></ul>
1177
1148
  */
1178
1149
  AttackRiskDetailList?: Array<AttackRiskDetail>;
1179
1150
  /**
1180
- * 额外信息。
1151
+ * <p>返回额外信息(包括命中模版的详细信息)。</p>
1181
1152
  */
1182
1153
  ExtraInfo?: ExtraInfo;
1183
1154
  /**
@@ -1368,17 +1339,17 @@ export interface VideoDetailData {
1368
1339
  */
1369
1340
  export interface RetrievalLivenessExtraInfo {
1370
1341
  /**
1371
- * 命中的模版类型,其中Common-公共库;Auto-自动聚类库;Owner-自建模版库
1342
+ * <p>命中的模版类型,其中Common-公共库;Auto-自动聚类库;Owner-自建模版库</p>
1372
1343
  注意:此字段可能返回 null,表示取不到有效值。
1373
1344
  */
1374
1345
  HitGroup?: string;
1375
1346
  /**
1376
- * 命中的相似度
1347
+ * <p>请求图像与命中攻击模板的相似度,相似度取值范围[0,2],取值越小表示命中攻击模板的概率越高。默认阈值为0.6,当SimilarityScore≥0.6时判断为正常,SimilarityScore&lt;0.6是判断为攻击。</p>
1377
1348
  注意:此字段可能返回 null,表示取不到有效值。
1378
1349
  */
1379
1350
  SimilarityScore?: number;
1380
1351
  /**
1381
- * 命中的模板id
1352
+ * <p>命中的模板id</p>
1382
1353
  注意:此字段可能返回 null,表示取不到有效值。
1383
1354
  */
1384
1355
  HitTemplate?: string;