tencentcloud-sdk-python-faceid 3.0.1416__py2.py3-none-any.whl → 3.0.1442__py2.py3-none-any.whl

tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1416'
+__version__ = '3.0.1442'

tencentcloud/faceid/v20180301/models.py

@@ -1898,17 +1898,18 @@ class DetectAIFakeFacesRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _FaceInput: 传入需要进行检测的带有人脸的图片或视频（当前仅支持单人脸检测），使用base64编码的形式。
+        :param _FaceInput: 传入需要检测的人脸图片或人脸视频（当前仅支持单人脸检测），使用base64编码的形式，如您的场景视频和图片都有，我们更建议您使用视频进行检测，为了提供更好的检测效果，请您注意以下输入数据的限制与建议：
+
 - 图片的Base64值：
-建议整体图像480x640的分辨率，脸部 大小 100X100 以上。
+建议整体图像480x640的分辨率，脸部大小在 100X100 以上，由手机前置摄像头拍摄。
 Base64编码后的图片数据大小建议不超过3M、最大不可超过10M，仅支持jpg、png格式。
 请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。
 
 - 视频的Base64值：
-Base64编码后的大小建议不超过8M、最大不可超过10M，支持mp4、avi、flv格式。
+Base64编码后的大小建议在8M以内、最大不可超过10M，支持mp4、avi、flv格式，由手机前置摄像头拍摄。
+视频建议时长为2～5s，最大不可超过20s。
+视频分辨率建议为480x640（最大支持720p），帧率在25fps~30fps之间。
 请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。
-视频时长最大支持20s，建议时长2～5s。
-建议视频分辨率为480x640，帧率在25fps~30fps之间。
 
 示例值：/9j/4AAQSkZJRg.....s97n//2Q==
         :type FaceInput: str
@@ -1933,17 +1934,18 @@ Base64编码后的大小建议不超过8M、最大不可超过10M，支持mp4、
 
     @property
     def FaceInput(self):
-        """传入需要进行检测的带有人脸的图片或视频（当前仅支持单人脸检测），使用base64编码的形式。
+        """传入需要检测的人脸图片或人脸视频（当前仅支持单人脸检测），使用base64编码的形式，如您的场景视频和图片都有，我们更建议您使用视频进行检测，为了提供更好的检测效果，请您注意以下输入数据的限制与建议：
+
 - 图片的Base64值：
-建议整体图像480x640的分辨率，脸部 大小 100X100 以上。
+建议整体图像480x640的分辨率，脸部大小在 100X100 以上，由手机前置摄像头拍摄。
 Base64编码后的图片数据大小建议不超过3M、最大不可超过10M，仅支持jpg、png格式。
 请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。
 
 - 视频的Base64值：
-Base64编码后的大小建议不超过8M、最大不可超过10M，支持mp4、avi、flv格式。
+Base64编码后的大小建议在8M以内、最大不可超过10M，支持mp4、avi、flv格式，由手机前置摄像头拍摄。
+视频建议时长为2～5s，最大不可超过20s。
+视频分辨率建议为480x640（最大支持720p），帧率在25fps~30fps之间。
 请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。
-视频时长最大支持20s，建议时长2～5s。
-建议视频分辨率为480x640，帧率在25fps~30fps之间。
 
 示例值：/9j/4AAQSkZJRg.....s97n//2Q==
         :rtype: str
@@ -2019,12 +2021,14 @@ class DetectAIFakeFacesResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _AttackRiskLevel: 检测到的图片是否存在攻击。
-- Low：无攻击风险。
+        :param _AttackRiskLevel: 对于输入图片/视频的检测结果，检测是否存在人脸攻击。
+- Low：低攻击风险。
 - Mid：中度疑似攻击。
 - High：高度疑似攻击。
+
+建议返回值为High时判断为拦截，Mid和Low判断为通过，以更好平衡安全性和通过率。
         :type AttackRiskLevel: str
-        :param _AttackRiskDetailList: 检测到疑似的攻击痕迹列表。
+        :param _AttackRiskDetailList: 检测到的疑似攻击痕迹列表，仅当AttackRiskLevel为High或Mid时返回。
 - 说明：未检测到攻击痕迹时，返回空数组。
 - 此出参仅作为结果判断的参考，实际应用仍建议使用AttackRiskLevel的结果。
         :type AttackRiskDetailList: list of AttackRiskDetail
@@ -2040,10 +2044,12 @@ class DetectAIFakeFacesResponse(AbstractModel):
 
     @property
     def AttackRiskLevel(self):
-        """检测到的图片是否存在攻击。
-- Low：无攻击风险。
+        """对于输入图片/视频的检测结果，检测是否存在人脸攻击。
+- Low：低攻击风险。
 - Mid：中度疑似攻击。
 - High：高度疑似攻击。
+
+建议返回值为High时判断为拦截，Mid和Low判断为通过，以更好平衡安全性和通过率。
         :rtype: str
         """
         return self._AttackRiskLevel
@@ -2054,7 +2060,7 @@ class DetectAIFakeFacesResponse(AbstractModel):
 
     @property
     def AttackRiskDetailList(self):
-        """检测到疑似的攻击痕迹列表。
+        """检测到的疑似攻击痕迹列表，仅当AttackRiskLevel为High或Mid时返回。
 - 说明：未检测到攻击痕迹时，返回空数组。
 - 此出参仅作为结果判断的参考，实际应用仍建议使用AttackRiskLevel的结果。
         :rtype: list of AttackRiskDetail
@@ -4310,7 +4316,7 @@ class GetDetectInfoEnhancedResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _Text: 文本类信息。
+        :param _Text: 人脸核身识别结果及文本类信息。
 注意：此字段可能返回 null，表示取不到有效值。
         :type Text: :class:`tencentcloud.faceid.v20180301.models.DetectInfoText`
         :param _IdCardData: 身份证照片信息。
@@ -4341,6 +4347,18 @@ class GetDetectInfoEnhancedResponse(AbstractModel):
         :param _EncryptedBody: 加密后的数据。
 注意：此字段可能返回 null，表示取不到有效值。
         :type EncryptedBody: str
+        :param _IsVerifyIntention: 本次请求是否配置开启意愿校验。 
+false：未开启意愿校验 
+true：已开启意愿校验 
+说明：若请求开启了意愿校验，可结合IntentionVerifyType中具体使用的校验模式从对应的出参Result中获取最终的核验结果；若请求没有开启意愿校验，则可在出参Text中获取最终的核验结果。
+        :type IsVerifyIntention: bool
+        :param _IntentionVerifyType: 本次请求意愿校验使用的具体模式。
+0：问答模式
+1：点头确认模式
+2：朗读模式
+若未使用意愿核身功能，该字段返回值可以不处理。
+注意：此字段可能返回 null，表示取不到有效值
+        :type IntentionVerifyType: str
         :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
         """
@@ -4353,11 +4371,13 @@ class GetDetectInfoEnhancedResponse(AbstractModel):
         self._IntentionQuestionResult = None
         self._IntentionActionResult = None
         self._EncryptedBody = None
+        self._IsVerifyIntention = None
+        self._IntentionVerifyType = None
         self._RequestId = None
 
     @property
     def Text(self):
-        """文本类信息。
+        """人脸核身识别结果及文本类信息。
 注意：此字段可能返回 null，表示取不到有效值。
         :rtype: :class:`tencentcloud.faceid.v20180301.models.DetectInfoText`
         """
@@ -4467,6 +4487,36 @@ class GetDetectInfoEnhancedResponse(AbstractModel):
     def EncryptedBody(self, EncryptedBody):
         self._EncryptedBody = EncryptedBody
 
+    @property
+    def IsVerifyIntention(self):
+        """本次请求是否配置开启意愿校验。 
+false：未开启意愿校验 
+true：已开启意愿校验 
+说明：若请求开启了意愿校验，可结合IntentionVerifyType中具体使用的校验模式从对应的出参Result中获取最终的核验结果；若请求没有开启意愿校验，则可在出参Text中获取最终的核验结果。
+        :rtype: bool
+        """
+        return self._IsVerifyIntention
+
+    @IsVerifyIntention.setter
+    def IsVerifyIntention(self, IsVerifyIntention):
+        self._IsVerifyIntention = IsVerifyIntention
+
+    @property
+    def IntentionVerifyType(self):
+        """本次请求意愿校验使用的具体模式。
+0：问答模式
+1：点头确认模式
+2：朗读模式
+若未使用意愿核身功能，该字段返回值可以不处理。
+注意：此字段可能返回 null，表示取不到有效值
+        :rtype: str
+        """
+        return self._IntentionVerifyType
+
+    @IntentionVerifyType.setter
+    def IntentionVerifyType(self, IntentionVerifyType):
+        self._IntentionVerifyType = IntentionVerifyType
+
     @property
     def RequestId(self):
         """唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
@@ -4505,6 +4555,8 @@ class GetDetectInfoEnhancedResponse(AbstractModel):
             self._IntentionActionResult = IntentionActionResult()
             self._IntentionActionResult._deserialize(params.get("IntentionActionResult"))
         self._EncryptedBody = params.get("EncryptedBody")
+        self._IsVerifyIntention = params.get("IsVerifyIntention")
+        self._IntentionVerifyType = params.get("IntentionVerifyType")
         self._RequestId = params.get("RequestId")
 
 
@@ -4850,7 +4902,7 @@ class GetEidResultResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _Text: 文本类信息。
+        :param _Text: 人脸核身识别结果及文本类信息。
 - 基于对敏感信息的保护，验证使用的姓名和身份证号统一通过加密后从EidInfo参数中返回。
 - 如需获取请在控制台申请返回身份信息，详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)。
 注意：此字段可能返回 null，表示取不到有效值。
@@ -4880,6 +4932,18 @@ class GetEidResultResponse(AbstractModel):
 - 若未使用该意愿核身功能，该字段返回值可以不处理。
 注意：此字段可能返回 null，表示取不到有效值。
         :type IntentionActionResult: :class:`tencentcloud.faceid.v20180301.models.IntentionActionResult`
+        :param _IsVerifyIntention: 本次请求是否配置开启意愿校验。 
+false：未开启意愿校验 
+true：已开启意愿校验 
+说明：若请求开启了意愿校验，可结合IntentionVerifyType中具体使用的校验模式从对应的出参Result中获取最终的核验结果；若请求没有开启意愿校验，则可在出参Text中获取最终的核验结果。
+        :type IsVerifyIntention: bool
+        :param _IntentionVerifyType: 本次请求意愿校验使用的具体模式。 
+0：问答模式 
+1：点头确认模式 
+2：朗读模式 
+若未使用意愿核身功能，该字段返回值可以不处理。 
+注意：此字段可能返回 null，表示取不到有效值
+        :type IntentionVerifyType: str
         :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
         """
@@ -4890,11 +4954,13 @@ class GetEidResultResponse(AbstractModel):
         self._IntentionVerifyData = None
         self._IntentionQuestionResult = None
         self._IntentionActionResult = None
+        self._IsVerifyIntention = None
+        self._IntentionVerifyType = None
         self._RequestId = None
 
     @property
     def Text(self):
-        """文本类信息。
+        """人脸核身识别结果及文本类信息。
 - 基于对敏感信息的保护，验证使用的姓名和身份证号统一通过加密后从EidInfo参数中返回。
 - 如需获取请在控制台申请返回身份信息，详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)。
 注意：此字段可能返回 null，表示取不到有效值。
@@ -4985,6 +5051,36 @@ class GetEidResultResponse(AbstractModel):
     def IntentionActionResult(self, IntentionActionResult):
         self._IntentionActionResult = IntentionActionResult
 
+    @property
+    def IsVerifyIntention(self):
+        """本次请求是否配置开启意愿校验。 
+false：未开启意愿校验 
+true：已开启意愿校验 
+说明：若请求开启了意愿校验，可结合IntentionVerifyType中具体使用的校验模式从对应的出参Result中获取最终的核验结果；若请求没有开启意愿校验，则可在出参Text中获取最终的核验结果。
+        :rtype: bool
+        """
+        return self._IsVerifyIntention
+
+    @IsVerifyIntention.setter
+    def IsVerifyIntention(self, IsVerifyIntention):
+        self._IsVerifyIntention = IsVerifyIntention
+
+    @property
+    def IntentionVerifyType(self):
+        """本次请求意愿校验使用的具体模式。 
+0：问答模式 
+1：点头确认模式 
+2：朗读模式 
+若未使用意愿核身功能，该字段返回值可以不处理。 
+注意：此字段可能返回 null，表示取不到有效值
+        :rtype: str
+        """
+        return self._IntentionVerifyType
+
+    @IntentionVerifyType.setter
+    def IntentionVerifyType(self, IntentionVerifyType):
+        self._IntentionVerifyType = IntentionVerifyType
+
     @property
     def RequestId(self):
         """唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
@@ -5019,6 +5115,8 @@ class GetEidResultResponse(AbstractModel):
         if params.get("IntentionActionResult") is not None:
             self._IntentionActionResult = IntentionActionResult()
             self._IntentionActionResult._deserialize(params.get("IntentionActionResult"))
+        self._IsVerifyIntention = params.get("IsVerifyIntention")
+        self._IntentionVerifyType = params.get("IntentionVerifyType")
         self._RequestId = params.get("RequestId")
 
 

{tencentcloud_sdk_python_faceid-3.0.1416.dist-info → tencentcloud_sdk_python_faceid-3.0.1442.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-faceid
-Version: 3.0.1416
+Version: 3.0.1442
 Summary: Tencent Cloud Faceid SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
-Requires-Dist: tencentcloud-sdk-python-common (==3.0.1416)
+Requires-Dist: tencentcloud-sdk-python-common (<4.0.0,>=3.0.1442)
 
 ============================
 Tencent Cloud SDK for Python

{tencentcloud_sdk_python_faceid-3.0.1416.dist-info → tencentcloud_sdk_python_faceid-3.0.1442.dist-info}/RECORD

@@ -1,10 +1,10 @@
-tencentcloud/__init__.py,sha256=-3wPg6USRRdvHHmZ1D-kvX873GrUeYC1aT5yHZA0Mk0,631
+tencentcloud/__init__.py,sha256=g9QUEEZyYAV6eH8z1fOAbblbhgYwhArPV6JqbI9m1rI,631
 tencentcloud/faceid/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/faceid/v20180301/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/faceid/v20180301/errorcodes.py,sha256=W8GgEB6jhgpjXQRWlc0-Q1BfUVGHFmj_Rr0wggUr-8Y,10531
 tencentcloud/faceid/v20180301/faceid_client.py,sha256=5-9fHoOc31BZdIOJ1d6TK_p10C3KNE4HiK2AvXQbZIQ,38436
-tencentcloud/faceid/v20180301/models.py,sha256=AZKaBZ40l9Jpzs-OQ-VBsKbXwQ7HexVu2j07_AlqSwE,365630
-tencentcloud_sdk_python_faceid-3.0.1416.dist-info/METADATA,sha256=RRru6sY-TmaA3-e_0gCKfJr2j7rSNsuqfwMZlgKL8Lk,1511
-tencentcloud_sdk_python_faceid-3.0.1416.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
-tencentcloud_sdk_python_faceid-3.0.1416.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
-tencentcloud_sdk_python_faceid-3.0.1416.dist-info/RECORD,,
+tencentcloud/faceid/v20180301/models.py,sha256=_WLLaMMnmHm3syC26FqIkTkqOWBfZzRHPPtqA2UB7xM,370840
+tencentcloud_sdk_python_faceid-3.0.1442.dist-info/METADATA,sha256=OL640dzFXDKj0k-4Ktqf43JwrgthWtYPmaUjJm94-1w,1518
+tencentcloud_sdk_python_faceid-3.0.1442.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
+tencentcloud_sdk_python_faceid-3.0.1442.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
+tencentcloud_sdk_python_faceid-3.0.1442.dist-info/RECORD,,