tencentcloud-sdk-python-faceid 3.1.134__tar.gz → 3.1.161__tar.gz

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.
Files changed (17) hide show
  1. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/PKG-INFO +2 -2
  2. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/setup.py +1 -1
  3. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/v20180301/models.py +141 -272
  5. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud_sdk_python_faceid.egg-info/PKG-INFO +2 -2
  6. tencentcloud_sdk_python_faceid-3.1.161/tencentcloud_sdk_python_faceid.egg-info/requires.txt +1 -0
  7. tencentcloud_sdk_python_faceid-3.1.134/tencentcloud_sdk_python_faceid.egg-info/requires.txt +0 -1
  8. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/README.rst +0 -0
  9. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/setup.cfg +0 -0
  10. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/__init__.py +0 -0
  11. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/v20180301/__init__.py +0 -0
  12. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/v20180301/errorcodes.py +0 -0
  13. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/v20180301/faceid_client.py +0 -0
  14. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/v20180301/faceid_client_async.py +0 -0
  15. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud_sdk_python_faceid.egg-info/SOURCES.txt +0 -0
  16. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud_sdk_python_faceid.egg-info/dependency_links.txt +0 -0
  17. {tencentcloud_sdk_python_faceid-3.1.134 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud_sdk_python_faceid.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-faceid
3
- Version: 3.1.134
3
+ Version: 3.1.161
4
4
  Summary: Tencent Cloud Faceid SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.134
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.161
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-faceid',
11
- install_requires=["tencentcloud-sdk-python-common>=3.1.134,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.1.161,<4.0.0"],
12
12
 
13
13
  version=tencentcloud.__version__,
14
14
  description='Tencent Cloud Faceid SDK for Python',
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.1.134'
17
+ __version__ = '3.1.161'
@@ -1658,12 +1658,11 @@ class CheckPhoneAndNameRequest(AbstractModel):
1658
1658
 
1659
1659
  def __init__(self):
1660
1660
  r"""
1661
- :param _Mobile: ⼿机号。
1661
+ :param _Mobile: <p>⼿机号。</p>
1662
1662
  :type Mobile: str
1663
- :param _Name: 姓名。
1663
+ :param _Name: <p>姓名。</p>
1664
1664
  :type Name: str
1665
- :param _Encryption: 敏感数据加密信息。
1666
- - 对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1665
+ :param _Encryption: <p>敏感数据加密信息。</p><ul><li>对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。</li></ul>
1667
1666
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
1668
1667
  """
1669
1668
  self._Mobile = None
@@ -1672,7 +1671,7 @@ class CheckPhoneAndNameRequest(AbstractModel):
1672
1671
 
1673
1672
  @property
1674
1673
  def Mobile(self):
1675
- r"""⼿机号。
1674
+ r"""<p>⼿机号。</p>
1676
1675
  :rtype: str
1677
1676
  """
1678
1677
  return self._Mobile
@@ -1683,7 +1682,7 @@ class CheckPhoneAndNameRequest(AbstractModel):
1683
1682
 
1684
1683
  @property
1685
1684
  def Name(self):
1686
- r"""姓名。
1685
+ r"""<p>姓名。</p>
1687
1686
  :rtype: str
1688
1687
  """
1689
1688
  return self._Name
@@ -1694,8 +1693,7 @@ class CheckPhoneAndNameRequest(AbstractModel):
1694
1693
 
1695
1694
  @property
1696
1695
  def Encryption(self):
1697
- r"""敏感数据加密信息。
1698
- - 对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1696
+ r"""<p>敏感数据加密信息。</p><ul><li>对传入信息(姓名、手机号)有加密需求的用户可使用此参数,详情请点击左侧链接。</li></ul>
1699
1697
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
1700
1698
  """
1701
1699
  return self._Encryption
@@ -1728,20 +1726,9 @@ class CheckPhoneAndNameResponse(AbstractModel):
1728
1726
 
1729
1727
  def __init__(self):
1730
1728
  r"""
1731
- :param _Result: 认证结果码,收费情况如下。
1732
- - 收费结果码:
1733
- 0: 验证结果一致。
1734
- 1: 验证结果不一致。
1735
-
1736
- - 不收费结果码:
1737
- -1:查无记录。
1738
- -2:引擎未知错误。
1739
- -3:引擎服务异常。
1740
- -4:姓名校验不通过。
1741
- -5:手机号码不合法。
1742
- -6: 认证次数超过当日限制,请次日重试。
1729
+ :param _Result: <p>认证结果码,收费情况如下。</p><ul><li><p>收费结果码:<br>0: 验证结果一致。<br>1: 验证结果不一致。</p></li><li><p>不收费结果码:<br>-1:查无记录。<br>-2:引擎未知错误。<br>-3:引擎服务异常。<br>-4:姓名校验不通过。<br>-5:手机号码不合法。<br>-6: 认证次数超过当日限制,请次日重试。<br>-13:该号段不支持验证</p></li></ul>
1743
1730
  :type Result: str
1744
- :param _Description: 业务结果描述。
1731
+ :param _Description: <p>业务结果描述。</p>
1745
1732
  :type Description: str
1746
1733
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1747
1734
  :type RequestId: str
@@ -1752,18 +1739,7 @@ class CheckPhoneAndNameResponse(AbstractModel):
1752
1739
 
1753
1740
  @property
1754
1741
  def Result(self):
1755
- r"""认证结果码,收费情况如下。
1756
- - 收费结果码:
1757
- 0: 验证结果一致。
1758
- 1: 验证结果不一致。
1759
-
1760
- - 不收费结果码:
1761
- -1:查无记录。
1762
- -2:引擎未知错误。
1763
- -3:引擎服务异常。
1764
- -4:姓名校验不通过。
1765
- -5:手机号码不合法。
1766
- -6: 认证次数超过当日限制,请次日重试。
1742
+ r"""<p>认证结果码,收费情况如下。</p><ul><li><p>收费结果码:<br>0: 验证结果一致。<br>1: 验证结果不一致。</p></li><li><p>不收费结果码:<br>-1:查无记录。<br>-2:引擎未知错误。<br>-3:引擎服务异常。<br>-4:姓名校验不通过。<br>-5:手机号码不合法。<br>-6: 认证次数超过当日限制,请次日重试。<br>-13:该号段不支持验证</p></li></ul>
1767
1743
  :rtype: str
1768
1744
  """
1769
1745
  return self._Result
@@ -1774,7 +1750,7 @@ class CheckPhoneAndNameResponse(AbstractModel):
1774
1750
 
1775
1751
  @property
1776
1752
  def Description(self):
1777
- r"""业务结果描述。
1753
+ r"""<p>业务结果描述。</p>
1778
1754
  :rtype: str
1779
1755
  """
1780
1756
  return self._Description
@@ -1971,49 +1947,29 @@ class DetectAuthRequest(AbstractModel):
1971
1947
 
1972
1948
  def __init__(self):
1973
1949
  r"""
1974
- :param _RuleId: 业务流程ID
1975
- - 用于细分客户使用场景, 可为业务配置不同的业务流程。
1976
- - 申请开通服务后,登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建,审核通过后即可调用。
1977
- - 如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
1950
+ :param _RuleId: <p>业务流程ID。</p><ul><li>用于细分客户使用场景, 可为业务配置不同的业务流程。</li><li>申请开通服务后,登录腾讯云<a href="https://console.cloud.tencent.com/faceid">慧眼人脸核身控制</a>进行创建,审核通过后即可调用。</li><li>如有疑问,请添加<a href="https://cloud.tencent.com/document/product/1007/56130">腾讯云人脸核身小助手</a>进行咨询。</li></ul>
1978
1951
  :type RuleId: str
1979
- :param _TerminalType: 本接口不需要传递此参数。
1952
+ :param _TerminalType: <p>本接口不需要传递此参数。</p>
1980
1953
  :type TerminalType: str
1981
- :param _IdCard: 验证人的身份证号码。
1982
- - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
1983
-
1954
+ :param _IdCard: <p>验证人的身份证号码。</p><ul><li>调用 detectAuth 时,该字段是否必传,以在<a href="https://console.cloud.tencent.com/faceid/access">控制台</a>申请 ruleId 时的配置提示为准,具体必填字段请参阅控制台界面。</li><li>若身份证号包含字母,该字母必须为大写 X,小写 x 将无法通过校验。</li></ul>
1984
1955
  :type IdCard: str
1985
- :param _Name: 验证人的姓名。
1986
- - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
1987
- - 最长长度32位。中文请使用UTF-8编码。
1956
+ :param _Name: <p>验证人的姓名。</p><ul><li>调用 detectAuth 时,该字段是否必传,以在<a href="https://console.cloud.tencent.com/faceid/access">控制台</a>申请 ruleId 时的配置提示为准,具体必填字段请参阅控制台界面。</li><li>最长长度32位。中文请使用UTF-8编码。</li></ul>
1988
1957
  :type Name: str
1989
- :param _RedirectUrl: 认证结束后重定向的回调链接地址,仅微信H5场景使用。
1990
- - 最长长度1024位。
1991
- - 默认值:[腾讯云人脸核身产品介绍页](URL Here)https://cloud.tencent.com/product/faceid?Is=sdk-topnav
1992
-
1958
+ :param _RedirectUrl: <p>认证结束后重定向的回调链接地址,仅微信H5场景使用。</p><ul><li>最长长度1024位。</li><li>默认值:[腾讯云人脸核身产品介绍页](URL Here)https://cloud.tencent.com/product/faceid?Is=sdk-topnav</li></ul>
1993
1959
  :type RedirectUrl: str
1994
- :param _Extra: 透传字段,在获取验证结果时返回。
1995
- - 最长长度1024位。
1960
+ :param _Extra: <p>透传字段,在获取验证结果时返回。</p><ul><li>最长长度1024位。</li></ul>
1996
1961
  :type Extra: str
1997
- :param _ImageBase64: 用于人脸比对的图像数据,使用base64编码。
1998
- - Base64编码后的图片数据大小不超过3M。
1999
- - 仅支持jpg、png格式。
2000
- - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1962
+ :param _ImageBase64: <p>用于人脸比对的图像数据,使用base64编码。</p><ul><li>Base64编码后的图片数据大小不超过3M。</li><li>仅支持jpg、png格式。</li><li>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</li></ul>
2001
1963
  :type ImageBase64: str
2002
- :param _Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1964
+ :param _Encryption: <p>敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。</p>
2003
1965
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
2004
- :param _IntentionVerifyText: 意愿核身(朗读模式)使用的文案。
2005
- - 若未使用意愿核身(朗读模式),则该字段无需传入。
2006
- - 最长可接受120的字符串长度。
1966
+ :param _IntentionVerifyText: <p>意愿核身(朗读模式)使用的文案。</p><ul><li>若未使用意愿核身(朗读模式),则该字段无需传入。</li><li>最长可接受120的字符串长度。</li></ul>
2007
1967
  :type IntentionVerifyText: str
2008
- :param _IntentionQuestions: 意愿核身(语音播报+语音回答模式)使用的文案。
2009
- - 包括:系统语音播报的文本、需要核验的标准文本。
2010
- - 问答模式支持1-10轮(不超过10轮)的意愿确认。
1968
+ :param _IntentionQuestions: <p>意愿核身(语音播报+语音回答模式)使用的文案。</p><ul><li>包括:系统语音播报的文本、需要核验的标准文本。</li><li>问答模式支持1-10轮(不超过10轮)的意愿确认。</li></ul>
2011
1969
  :type IntentionQuestions: list of IntentionQuestion
2012
- :param _IntentionActions: 意愿核身(点头确认模式)使用的文案。
2013
- - 若未使用意愿核身(点头确认模式),则该字段无需传入。
2014
- - 点头确认模式支持1-10轮(不超过10轮)的意愿确认。
1970
+ :param _IntentionActions: <p>意愿核身(点头确认模式)使用的文案。</p><ul><li>若未使用意愿核身(点头确认模式),则该字段无需传入。</li><li>点头确认模式支持1-10轮(不超过10轮)的意愿确认。</li></ul>
2015
1971
  :type IntentionActions: list of IntentionActionConfig
2016
- :param _Config: 意愿核身流程配置。
1972
+ :param _Config: <p>意愿核身流程配置。</p>
2017
1973
  :type Config: :class:`tencentcloud.faceid.v20180301.models.RuleIdConfig`
2018
1974
  """
2019
1975
  self._RuleId = None
@@ -2031,10 +1987,7 @@ class DetectAuthRequest(AbstractModel):
2031
1987
 
2032
1988
  @property
2033
1989
  def RuleId(self):
2034
- r"""业务流程ID
2035
- - 用于细分客户使用场景, 可为业务配置不同的业务流程。
2036
- - 申请开通服务后,登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建,审核通过后即可调用。
2037
- - 如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
1990
+ r"""<p>业务流程ID。</p><ul><li>用于细分客户使用场景, 可为业务配置不同的业务流程。</li><li>申请开通服务后,登录腾讯云<a href="https://console.cloud.tencent.com/faceid">慧眼人脸核身控制</a>进行创建,审核通过后即可调用。</li><li>如有疑问,请添加<a href="https://cloud.tencent.com/document/product/1007/56130">腾讯云人脸核身小助手</a>进行咨询。</li></ul>
2038
1991
  :rtype: str
2039
1992
  """
2040
1993
  return self._RuleId
@@ -2045,7 +1998,7 @@ class DetectAuthRequest(AbstractModel):
2045
1998
 
2046
1999
  @property
2047
2000
  def TerminalType(self):
2048
- r"""本接口不需要传递此参数。
2001
+ r"""<p>本接口不需要传递此参数。</p>
2049
2002
  :rtype: str
2050
2003
  """
2051
2004
  return self._TerminalType
@@ -2056,9 +2009,7 @@ class DetectAuthRequest(AbstractModel):
2056
2009
 
2057
2010
  @property
2058
2011
  def IdCard(self):
2059
- r"""验证人的身份证号码。
2060
- - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
2061
-
2012
+ r"""<p>验证人的身份证号码。</p><ul><li>调用 detectAuth 时,该字段是否必传,以在<a href="https://console.cloud.tencent.com/faceid/access">控制台</a>申请 ruleId 时的配置提示为准,具体必填字段请参阅控制台界面。</li><li>若身份证号包含字母,该字母必须为大写 X,小写 x 将无法通过校验。</li></ul>
2062
2013
  :rtype: str
2063
2014
  """
2064
2015
  return self._IdCard
@@ -2069,9 +2020,7 @@ class DetectAuthRequest(AbstractModel):
2069
2020
 
2070
2021
  @property
2071
2022
  def Name(self):
2072
- r"""验证人的姓名。
2073
- - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
2074
- - 最长长度32位。中文请使用UTF-8编码。
2023
+ r"""<p>验证人的姓名。</p><ul><li>调用 detectAuth 时,该字段是否必传,以在<a href="https://console.cloud.tencent.com/faceid/access">控制台</a>申请 ruleId 时的配置提示为准,具体必填字段请参阅控制台界面。</li><li>最长长度32位。中文请使用UTF-8编码。</li></ul>
2075
2024
  :rtype: str
2076
2025
  """
2077
2026
  return self._Name
@@ -2082,10 +2031,7 @@ class DetectAuthRequest(AbstractModel):
2082
2031
 
2083
2032
  @property
2084
2033
  def RedirectUrl(self):
2085
- r"""认证结束后重定向的回调链接地址,仅微信H5场景使用。
2086
- - 最长长度1024位。
2087
- - 默认值:[腾讯云人脸核身产品介绍页](URL Here)https://cloud.tencent.com/product/faceid?Is=sdk-topnav
2088
-
2034
+ r"""<p>认证结束后重定向的回调链接地址,仅微信H5场景使用。</p><ul><li>最长长度1024位。</li><li>默认值:[腾讯云人脸核身产品介绍页](URL Here)https://cloud.tencent.com/product/faceid?Is=sdk-topnav</li></ul>
2089
2035
  :rtype: str
2090
2036
  """
2091
2037
  return self._RedirectUrl
@@ -2096,8 +2042,7 @@ class DetectAuthRequest(AbstractModel):
2096
2042
 
2097
2043
  @property
2098
2044
  def Extra(self):
2099
- r"""透传字段,在获取验证结果时返回。
2100
- - 最长长度1024位。
2045
+ r"""<p>透传字段,在获取验证结果时返回。</p><ul><li>最长长度1024位。</li></ul>
2101
2046
  :rtype: str
2102
2047
  """
2103
2048
  return self._Extra
@@ -2108,10 +2053,7 @@ class DetectAuthRequest(AbstractModel):
2108
2053
 
2109
2054
  @property
2110
2055
  def ImageBase64(self):
2111
- r"""用于人脸比对的图像数据,使用base64编码。
2112
- - Base64编码后的图片数据大小不超过3M。
2113
- - 仅支持jpg、png格式。
2114
- - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2056
+ r"""<p>用于人脸比对的图像数据,使用base64编码。</p><ul><li>Base64编码后的图片数据大小不超过3M。</li><li>仅支持jpg、png格式。</li><li>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</li></ul>
2115
2057
  :rtype: str
2116
2058
  """
2117
2059
  return self._ImageBase64
@@ -2122,7 +2064,7 @@ class DetectAuthRequest(AbstractModel):
2122
2064
 
2123
2065
  @property
2124
2066
  def Encryption(self):
2125
- r"""敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2067
+ r"""<p>敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。</p>
2126
2068
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
2127
2069
  """
2128
2070
  return self._Encryption
@@ -2133,9 +2075,7 @@ class DetectAuthRequest(AbstractModel):
2133
2075
 
2134
2076
  @property
2135
2077
  def IntentionVerifyText(self):
2136
- r"""意愿核身(朗读模式)使用的文案。
2137
- - 若未使用意愿核身(朗读模式),则该字段无需传入。
2138
- - 最长可接受120的字符串长度。
2078
+ r"""<p>意愿核身(朗读模式)使用的文案。</p><ul><li>若未使用意愿核身(朗读模式),则该字段无需传入。</li><li>最长可接受120的字符串长度。</li></ul>
2139
2079
  :rtype: str
2140
2080
  """
2141
2081
  return self._IntentionVerifyText
@@ -2146,9 +2086,7 @@ class DetectAuthRequest(AbstractModel):
2146
2086
 
2147
2087
  @property
2148
2088
  def IntentionQuestions(self):
2149
- r"""意愿核身(语音播报+语音回答模式)使用的文案。
2150
- - 包括:系统语音播报的文本、需要核验的标准文本。
2151
- - 问答模式支持1-10轮(不超过10轮)的意愿确认。
2089
+ r"""<p>意愿核身(语音播报+语音回答模式)使用的文案。</p><ul><li>包括:系统语音播报的文本、需要核验的标准文本。</li><li>问答模式支持1-10轮(不超过10轮)的意愿确认。</li></ul>
2152
2090
  :rtype: list of IntentionQuestion
2153
2091
  """
2154
2092
  return self._IntentionQuestions
@@ -2159,9 +2097,7 @@ class DetectAuthRequest(AbstractModel):
2159
2097
 
2160
2098
  @property
2161
2099
  def IntentionActions(self):
2162
- r"""意愿核身(点头确认模式)使用的文案。
2163
- - 若未使用意愿核身(点头确认模式),则该字段无需传入。
2164
- - 点头确认模式支持1-10轮(不超过10轮)的意愿确认。
2100
+ r"""<p>意愿核身(点头确认模式)使用的文案。</p><ul><li>若未使用意愿核身(点头确认模式),则该字段无需传入。</li><li>点头确认模式支持1-10轮(不超过10轮)的意愿确认。</li></ul>
2165
2101
  :rtype: list of IntentionActionConfig
2166
2102
  """
2167
2103
  return self._IntentionActions
@@ -2172,7 +2108,7 @@ class DetectAuthRequest(AbstractModel):
2172
2108
 
2173
2109
  @property
2174
2110
  def Config(self):
2175
- r"""意愿核身流程配置。
2111
+ r"""<p>意愿核身流程配置。</p>
2176
2112
  :rtype: :class:`tencentcloud.faceid.v20180301.models.RuleIdConfig`
2177
2113
  """
2178
2114
  return self._Config
@@ -2226,11 +2162,9 @@ class DetectAuthResponse(AbstractModel):
2226
2162
 
2227
2163
  def __init__(self):
2228
2164
  r"""
2229
- :param _Url: 用于发起核身流程的URL,仅微信H5场景使用。
2165
+ :param _Url: <p>用于发起核身流程的URL,仅微信H5场景使用。</p>
2230
2166
  :type Url: str
2231
- :param _BizToken: 一次核验流程的唯一标识。
2232
- - 有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。
2233
- - 完成人脸核验后,需根据此标识调用[获取实名核身结果信息增强版](https://cloud.tencent.com/document/api/1007/41957)获取用户最终验证结果信息。
2167
+ :param _BizToken: <p>一次核验流程的唯一标识。</p><ul><li>有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。</li><li>完成人脸核验后,需根据此标识调用<a href="https://cloud.tencent.com/document/api/1007/41957">获取实名核身结果信息增强版</a>获取用户最终验证结果信息。</li></ul>
2234
2168
  :type BizToken: str
2235
2169
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2236
2170
  :type RequestId: str
@@ -2241,7 +2175,7 @@ class DetectAuthResponse(AbstractModel):
2241
2175
 
2242
2176
  @property
2243
2177
  def Url(self):
2244
- r"""用于发起核身流程的URL,仅微信H5场景使用。
2178
+ r"""<p>用于发起核身流程的URL,仅微信H5场景使用。</p>
2245
2179
  :rtype: str
2246
2180
  """
2247
2181
  return self._Url
@@ -2252,9 +2186,7 @@ class DetectAuthResponse(AbstractModel):
2252
2186
 
2253
2187
  @property
2254
2188
  def BizToken(self):
2255
- r"""一次核验流程的唯一标识。
2256
- - 有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。
2257
- - 完成人脸核验后,需根据此标识调用[获取实名核身结果信息增强版](https://cloud.tencent.com/document/api/1007/41957)获取用户最终验证结果信息。
2189
+ r"""<p>一次核验流程的唯一标识。</p><ul><li>有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。</li><li>完成人脸核验后,需根据此标识调用<a href="https://cloud.tencent.com/document/api/1007/41957">获取实名核身结果信息增强版</a>获取用户最终验证结果信息。</li></ul>
2258
2190
  :rtype: str
2259
2191
  """
2260
2192
  return self._BizToken
@@ -5329,19 +5261,15 @@ class GetFaceIdResultRequest(AbstractModel):
5329
5261
 
5330
5262
  def __init__(self):
5331
5263
  r"""
5332
- :param _FaceIdToken: SDK人脸核身流程的标识。
5333
- - 调用[GetFaceIdToken](https://cloud.tencent.com/document/product/1007/49198)接口时生成。
5264
+ :param _FaceIdToken: <p>SDK人脸核身流程的标识。</p><ul><li>调用<a href="https://cloud.tencent.com/document/product/1007/49198">GetFaceIdToken</a>接口时生成。</li></ul>
5334
5265
  :type FaceIdToken: str
5335
- :param _IsNeedVideo: 是否需要拉取视频。
5336
- - 默认false:不需要。
5266
+ :param _IsNeedVideo: <p>是否需要拉取视频。</p><ul><li>默认false:不需要。</li></ul>
5337
5267
  :type IsNeedVideo: bool
5338
- :param _IsNeedBestFrame: 是否需要拉取截帧。
5339
- - 默认false:不需要。
5268
+ :param _IsNeedBestFrame: <p>是否需要拉取截帧。</p><ul><li>默认false:不需要。</li></ul>
5340
5269
  :type IsNeedBestFrame: bool
5341
- :param _IsEncryptResponse: 是否对回包整体进行加密。
5270
+ :param _IsEncryptResponse: <p>是否对回包整体进行加密。</p>
5342
5271
  :type IsEncryptResponse: bool
5343
- :param _Encryption: 是否需要对返回中的敏感信息进行加密。
5344
- 只需指定加密算法Algorithm即可,其余字段传入默认值。
5272
+ :param _Encryption: <p>是否需要对返回中的敏感信息进行加密。<br>只需指定加密算法Algorithm即可,其余字段传入默认值。</p>
5345
5273
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5346
5274
  """
5347
5275
  self._FaceIdToken = None
@@ -5352,8 +5280,7 @@ class GetFaceIdResultRequest(AbstractModel):
5352
5280
 
5353
5281
  @property
5354
5282
  def FaceIdToken(self):
5355
- r"""SDK人脸核身流程的标识。
5356
- - 调用[GetFaceIdToken](https://cloud.tencent.com/document/product/1007/49198)接口时生成。
5283
+ r"""<p>SDK人脸核身流程的标识。</p><ul><li>调用<a href="https://cloud.tencent.com/document/product/1007/49198">GetFaceIdToken</a>接口时生成。</li></ul>
5357
5284
  :rtype: str
5358
5285
  """
5359
5286
  return self._FaceIdToken
@@ -5364,8 +5291,7 @@ class GetFaceIdResultRequest(AbstractModel):
5364
5291
 
5365
5292
  @property
5366
5293
  def IsNeedVideo(self):
5367
- r"""是否需要拉取视频。
5368
- - 默认false:不需要。
5294
+ r"""<p>是否需要拉取视频。</p><ul><li>默认false:不需要。</li></ul>
5369
5295
  :rtype: bool
5370
5296
  """
5371
5297
  return self._IsNeedVideo
@@ -5376,8 +5302,7 @@ class GetFaceIdResultRequest(AbstractModel):
5376
5302
 
5377
5303
  @property
5378
5304
  def IsNeedBestFrame(self):
5379
- r"""是否需要拉取截帧。
5380
- - 默认false:不需要。
5305
+ r"""<p>是否需要拉取截帧。</p><ul><li>默认false:不需要。</li></ul>
5381
5306
  :rtype: bool
5382
5307
  """
5383
5308
  return self._IsNeedBestFrame
@@ -5388,7 +5313,7 @@ class GetFaceIdResultRequest(AbstractModel):
5388
5313
 
5389
5314
  @property
5390
5315
  def IsEncryptResponse(self):
5391
- r"""是否对回包整体进行加密。
5316
+ r"""<p>是否对回包整体进行加密。</p>
5392
5317
  :rtype: bool
5393
5318
  """
5394
5319
  return self._IsEncryptResponse
@@ -5399,8 +5324,7 @@ class GetFaceIdResultRequest(AbstractModel):
5399
5324
 
5400
5325
  @property
5401
5326
  def Encryption(self):
5402
- r"""是否需要对返回中的敏感信息进行加密。
5403
- 只需指定加密算法Algorithm即可,其余字段传入默认值。
5327
+ r"""<p>是否需要对返回中的敏感信息进行加密。<br>只需指定加密算法Algorithm即可,其余字段传入默认值。</p>
5404
5328
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5405
5329
  """
5406
5330
  return self._Encryption
@@ -5435,78 +5359,45 @@ class GetFaceIdResultResponse(AbstractModel):
5435
5359
 
5436
5360
  def __init__(self):
5437
5361
  r"""
5438
- :param _IdCard: 身份证。
5362
+ :param _IdCard: <p>身份证。</p>
5439
5363
  :type IdCard: str
5440
- :param _Name: 姓名。
5364
+ :param _Name: <p>姓名。</p>
5441
5365
  :type Name: str
5442
- :param _Result: 业务核验结果。
5443
- - 参考:https://cloud.tencent.com/document/product/1007/47912。
5366
+ :param _Result: <p>业务核验结果。</p><ul><li>参考:https://cloud.tencent.com/document/product/1007/47912。</li></ul>
5444
5367
  :type Result: str
5445
- :param _Description: 业务核验描述。
5368
+ :param _Description: <p>业务核验描述。</p>
5446
5369
  :type Description: str
5447
- :param _Similarity: 相似度。
5448
- - 取值:0-100。
5449
- - 数值越大相似度越高。
5370
+ :param _Similarity: <p>相似度。</p><ul><li>取值:0-100。</li><li>数值越大相似度越高。</li></ul>
5450
5371
  :type Similarity: float
5451
- :param _VideoBase64: 用户核验的视频base64
5452
- - 如果选择了使用cos,返回完整cos地址,如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
5372
+ :param _VideoBase64: <p>用户核验的视频base64。</p><ul><li>如果选择了使用cos,返回完整cos地址,如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。</li></ul>
5453
5373
  注意:此字段可能返回 null,表示取不到有效值。
5454
5374
  :type VideoBase64: str
5455
- :param _BestFrameBase64: 用户核验视频的截帧base64
5456
- - 如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
5375
+ :param _BestFrameBase64: <p>用户核验视频的截帧base64。</p><ul><li>如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。</li></ul>
5457
5376
  注意:此字段可能返回 null,表示取不到有效值。
5458
5377
  :type BestFrameBase64: str
5459
- :param _Extra: 获取token时透传的信息。
5378
+ :param _Extra: <p>获取token时透传的信息。</p>
5460
5379
  注意:此字段可能返回 null,表示取不到有效值。
5461
5380
  :type Extra: str
5462
- :param _DeviceInfoTag: plus版:描述当前请求所在设备的风险标签。
5463
- - 详情如下:
5464
- 06-疑似黑产设备。
5465
- null-无设备风险。
5466
- - 增强版:此字段不生效,默认为null。
5381
+ :param _DeviceInfoTag: <p>plus版:描述当前请求所在设备的风险标签。</p><ul><li>详情如下:<br>01-设备疑似被Root/设备疑似越狱。<br>02-设备疑似被注入。<br>03-设备疑似为模拟器。<br>04-设备疑似存在风险操作。<br>05-摄像头疑似被劫持。<br>06-疑似黑产设备。<br>null-无设备风险。</li><li>增强版:此字段不生效,默认为null。</li></ul>
5467
5382
  注意:此字段可能返回 null,表示取不到有效值。
5468
5383
  :type DeviceInfoTag: str
5469
- :param _RiskInfoTag: 行为风险标签。
5470
- - 仅错误码返回1007(设备疑似被劫持)时返回风险标签。
5471
- - 标签说明:
5472
- 02:攻击风险
5384
+ :param _RiskInfoTag: <p>行为风险标签。</p><ul><li>仅错误码返回1007(设备疑似被劫持)时返回风险标签。</li><li>标签说明:<br>02:攻击风险</li></ul>
5473
5385
  注意:此字段可能返回 null,表示取不到有效值。
5474
5386
  :type RiskInfoTag: str
5475
- :param _LivenessInfoTag: plus版:描述当前请求活体阶段被拒绝的详细原因。
5476
- - 详情如下:
5477
- 01-用户全程闭眼。
5478
- 02-用户未完成指定动作。
5479
- 03-疑似翻拍攻击。
5480
- 04-疑似合成图片。
5481
- 05-疑似合成视频。
5482
- 06-疑似合成动作。
5483
- 07-疑似黑产模板。
5484
- 08-疑似存在水印。
5485
- 09-反光校验未通过。
5486
- 10-最佳帧校验未通过。
5487
- 11-人脸质量过差。
5488
- 12-人脸距离不匹配。
5489
- 13-疑似对抗样本攻击。
5490
- null-无。
5491
- - 增强版:此字段不生效,默认为null。
5387
+ :param _LivenessInfoTag: <p>plus版:描述当前请求活体阶段被拒绝的详细原因。</p><ul><li>详情如下:<br>01-用户全程闭眼。<br>02-用户未完成指定动作。<br>03-疑似翻拍攻击。<br>04-疑似合成图片。<br>05-疑似合成视频。<br>06-疑似合成动作。<br>07-疑似黑产模板。<br>08-疑似存在水印。<br>09-反光校验未通过。<br>10-最佳帧校验未通过。<br>11-人脸质量过差。<br>12-人脸距离不匹配。<br>13-疑似对抗样本攻击。<br>null-无。</li><li>增强版:此字段不生效,默认为null。</li></ul>
5492
5388
  注意:此字段可能返回 null,表示取不到有效值。
5493
5389
  :type LivenessInfoTag: str
5494
- :param _DeviceInfoLevel: plus版:描述当前请求所在设备的风险等级,共4级。
5495
- - 详情如下:
5496
- 1 - 安全。
5497
- 2 - 低风险。
5498
- 3 - 中风险。
5499
- 4 - 高危。
5500
- null - 未获取到风险等级。
5501
- - 增强版:此字段不生效,默认为null。
5390
+ :param _DeviceInfoLevel: <p>plus版:描述当前请求所在设备的风险等级,共4级。</p><ul><li>详情如下:<br>1 - 安全。<br>2 - 低风险。<br>3 - 中风险。<br>4 - 高危。<br>null - 未获取到风险等级。</li><li>增强版:此字段不生效,默认为null。</li></ul>
5502
5391
  注意:此字段可能返回 null,表示取不到有效值。
5503
5392
  :type DeviceInfoLevel: str
5504
- :param _Encryption: 敏感数据加密信息。
5393
+ :param _Encryption: <p>敏感数据加密信息。</p>
5505
5394
  注意:此字段可能返回 null,表示取不到有效值。
5506
5395
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5507
- :param _EncryptedBody: 加密后的数据。
5396
+ :param _EncryptedBody: <p>加密后的数据。</p>
5508
5397
  注意:此字段可能返回 null,表示取不到有效值。
5509
5398
  :type EncryptedBody: str
5399
+ :param _IdCardFrontBase64: <p>用户核验的身份证人像页base64</p>
5400
+ :type IdCardFrontBase64: str
5510
5401
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5511
5402
  :type RequestId: str
5512
5403
  """
@@ -5524,11 +5415,12 @@ null - 未获取到风险等级。
5524
5415
  self._DeviceInfoLevel = None
5525
5416
  self._Encryption = None
5526
5417
  self._EncryptedBody = None
5418
+ self._IdCardFrontBase64 = None
5527
5419
  self._RequestId = None
5528
5420
 
5529
5421
  @property
5530
5422
  def IdCard(self):
5531
- r"""身份证。
5423
+ r"""<p>身份证。</p>
5532
5424
  :rtype: str
5533
5425
  """
5534
5426
  return self._IdCard
@@ -5539,7 +5431,7 @@ null - 未获取到风险等级。
5539
5431
 
5540
5432
  @property
5541
5433
  def Name(self):
5542
- r"""姓名。
5434
+ r"""<p>姓名。</p>
5543
5435
  :rtype: str
5544
5436
  """
5545
5437
  return self._Name
@@ -5550,8 +5442,7 @@ null - 未获取到风险等级。
5550
5442
 
5551
5443
  @property
5552
5444
  def Result(self):
5553
- r"""业务核验结果。
5554
- - 参考:https://cloud.tencent.com/document/product/1007/47912。
5445
+ r"""<p>业务核验结果。</p><ul><li>参考:https://cloud.tencent.com/document/product/1007/47912。</li></ul>
5555
5446
  :rtype: str
5556
5447
  """
5557
5448
  return self._Result
@@ -5562,7 +5453,7 @@ null - 未获取到风险等级。
5562
5453
 
5563
5454
  @property
5564
5455
  def Description(self):
5565
- r"""业务核验描述。
5456
+ r"""<p>业务核验描述。</p>
5566
5457
  :rtype: str
5567
5458
  """
5568
5459
  return self._Description
@@ -5573,9 +5464,7 @@ null - 未获取到风险等级。
5573
5464
 
5574
5465
  @property
5575
5466
  def Similarity(self):
5576
- r"""相似度。
5577
- - 取值:0-100。
5578
- - 数值越大相似度越高。
5467
+ r"""<p>相似度。</p><ul><li>取值:0-100。</li><li>数值越大相似度越高。</li></ul>
5579
5468
  :rtype: float
5580
5469
  """
5581
5470
  return self._Similarity
@@ -5586,8 +5475,7 @@ null - 未获取到风险等级。
5586
5475
 
5587
5476
  @property
5588
5477
  def VideoBase64(self):
5589
- r"""用户核验的视频base64
5590
- - 如果选择了使用cos,返回完整cos地址,如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
5478
+ r"""<p>用户核验的视频base64。</p><ul><li>如果选择了使用cos,返回完整cos地址,如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。</li></ul>
5591
5479
  注意:此字段可能返回 null,表示取不到有效值。
5592
5480
  :rtype: str
5593
5481
  """
@@ -5599,8 +5487,7 @@ null - 未获取到风险等级。
5599
5487
 
5600
5488
  @property
5601
5489
  def BestFrameBase64(self):
5602
- r"""用户核验视频的截帧base64
5603
- - 如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
5490
+ r"""<p>用户核验视频的截帧base64。</p><ul><li>如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。</li></ul>
5604
5491
  注意:此字段可能返回 null,表示取不到有效值。
5605
5492
  :rtype: str
5606
5493
  """
@@ -5612,7 +5499,7 @@ null - 未获取到风险等级。
5612
5499
 
5613
5500
  @property
5614
5501
  def Extra(self):
5615
- r"""获取token时透传的信息。
5502
+ r"""<p>获取token时透传的信息。</p>
5616
5503
  注意:此字段可能返回 null,表示取不到有效值。
5617
5504
  :rtype: str
5618
5505
  """
@@ -5624,11 +5511,7 @@ null - 未获取到风险等级。
5624
5511
 
5625
5512
  @property
5626
5513
  def DeviceInfoTag(self):
5627
- r"""plus版:描述当前请求所在设备的风险标签。
5628
- - 详情如下:
5629
- 06-疑似黑产设备。
5630
- null-无设备风险。
5631
- - 增强版:此字段不生效,默认为null。
5514
+ r"""<p>plus版:描述当前请求所在设备的风险标签。</p><ul><li>详情如下:<br>01-设备疑似被Root/设备疑似越狱。<br>02-设备疑似被注入。<br>03-设备疑似为模拟器。<br>04-设备疑似存在风险操作。<br>05-摄像头疑似被劫持。<br>06-疑似黑产设备。<br>null-无设备风险。</li><li>增强版:此字段不生效,默认为null。</li></ul>
5632
5515
  注意:此字段可能返回 null,表示取不到有效值。
5633
5516
  :rtype: str
5634
5517
  """
@@ -5640,10 +5523,7 @@ null-无设备风险。
5640
5523
 
5641
5524
  @property
5642
5525
  def RiskInfoTag(self):
5643
- r"""行为风险标签。
5644
- - 仅错误码返回1007(设备疑似被劫持)时返回风险标签。
5645
- - 标签说明:
5646
- 02:攻击风险
5526
+ r"""<p>行为风险标签。</p><ul><li>仅错误码返回1007(设备疑似被劫持)时返回风险标签。</li><li>标签说明:<br>02:攻击风险</li></ul>
5647
5527
  注意:此字段可能返回 null,表示取不到有效值。
5648
5528
  :rtype: str
5649
5529
  """
@@ -5655,23 +5535,7 @@ null-无设备风险。
5655
5535
 
5656
5536
  @property
5657
5537
  def LivenessInfoTag(self):
5658
- r"""plus版:描述当前请求活体阶段被拒绝的详细原因。
5659
- - 详情如下:
5660
- 01-用户全程闭眼。
5661
- 02-用户未完成指定动作。
5662
- 03-疑似翻拍攻击。
5663
- 04-疑似合成图片。
5664
- 05-疑似合成视频。
5665
- 06-疑似合成动作。
5666
- 07-疑似黑产模板。
5667
- 08-疑似存在水印。
5668
- 09-反光校验未通过。
5669
- 10-最佳帧校验未通过。
5670
- 11-人脸质量过差。
5671
- 12-人脸距离不匹配。
5672
- 13-疑似对抗样本攻击。
5673
- null-无。
5674
- - 增强版:此字段不生效,默认为null。
5538
+ r"""<p>plus版:描述当前请求活体阶段被拒绝的详细原因。</p><ul><li>详情如下:<br>01-用户全程闭眼。<br>02-用户未完成指定动作。<br>03-疑似翻拍攻击。<br>04-疑似合成图片。<br>05-疑似合成视频。<br>06-疑似合成动作。<br>07-疑似黑产模板。<br>08-疑似存在水印。<br>09-反光校验未通过。<br>10-最佳帧校验未通过。<br>11-人脸质量过差。<br>12-人脸距离不匹配。<br>13-疑似对抗样本攻击。<br>null-无。</li><li>增强版:此字段不生效,默认为null。</li></ul>
5675
5539
  注意:此字段可能返回 null,表示取不到有效值。
5676
5540
  :rtype: str
5677
5541
  """
@@ -5683,14 +5547,7 @@ null-无。
5683
5547
 
5684
5548
  @property
5685
5549
  def DeviceInfoLevel(self):
5686
- r"""plus版:描述当前请求所在设备的风险等级,共4级。
5687
- - 详情如下:
5688
- 1 - 安全。
5689
- 2 - 低风险。
5690
- 3 - 中风险。
5691
- 4 - 高危。
5692
- null - 未获取到风险等级。
5693
- - 增强版:此字段不生效,默认为null。
5550
+ r"""<p>plus版:描述当前请求所在设备的风险等级,共4级。</p><ul><li>详情如下:<br>1 - 安全。<br>2 - 低风险。<br>3 - 中风险。<br>4 - 高危。<br>null - 未获取到风险等级。</li><li>增强版:此字段不生效,默认为null。</li></ul>
5694
5551
  注意:此字段可能返回 null,表示取不到有效值。
5695
5552
  :rtype: str
5696
5553
  """
@@ -5702,7 +5559,7 @@ null - 未获取到风险等级。
5702
5559
 
5703
5560
  @property
5704
5561
  def Encryption(self):
5705
- r"""敏感数据加密信息。
5562
+ r"""<p>敏感数据加密信息。</p>
5706
5563
  注意:此字段可能返回 null,表示取不到有效值。
5707
5564
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5708
5565
  """
@@ -5714,7 +5571,7 @@ null - 未获取到风险等级。
5714
5571
 
5715
5572
  @property
5716
5573
  def EncryptedBody(self):
5717
- r"""加密后的数据。
5574
+ r"""<p>加密后的数据。</p>
5718
5575
  注意:此字段可能返回 null,表示取不到有效值。
5719
5576
  :rtype: str
5720
5577
  """
@@ -5724,6 +5581,17 @@ null - 未获取到风险等级。
5724
5581
  def EncryptedBody(self, EncryptedBody):
5725
5582
  self._EncryptedBody = EncryptedBody
5726
5583
 
5584
+ @property
5585
+ def IdCardFrontBase64(self):
5586
+ r"""<p>用户核验的身份证人像页base64</p>
5587
+ :rtype: str
5588
+ """
5589
+ return self._IdCardFrontBase64
5590
+
5591
+ @IdCardFrontBase64.setter
5592
+ def IdCardFrontBase64(self, IdCardFrontBase64):
5593
+ self._IdCardFrontBase64 = IdCardFrontBase64
5594
+
5727
5595
  @property
5728
5596
  def RequestId(self):
5729
5597
  r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -5753,6 +5621,7 @@ null - 未获取到风险等级。
5753
5621
  self._Encryption = Encryption()
5754
5622
  self._Encryption._deserialize(params.get("Encryption"))
5755
5623
  self._EncryptedBody = params.get("EncryptedBody")
5624
+ self._IdCardFrontBase64 = params.get("IdCardFrontBase64")
5756
5625
  self._RequestId = params.get("RequestId")
5757
5626
 
5758
5627
 
@@ -5985,39 +5854,26 @@ class GetFaceIdTokenRequest(AbstractModel):
5985
5854
 
5986
5855
  def __init__(self):
5987
5856
  r"""
5988
- :param _CompareLib: 比对库。
5989
- - 取值范围:
5990
- LOCAL:本地上传照片。
5991
- BUSINESS:商业库。
5857
+ :param _CompareLib: <p>比对库。</p><ul><li>取值范围:<br>LOCAL:本地上传照片。<br>BUSINESS:商业库。</li></ul>
5992
5858
  :type CompareLib: str
5993
- :param _IdCard: 身份证。
5994
- - CompareLib为商业库时必传。
5859
+ :param _IdCard: <p>身份证。</p><ul><li>CompareLib为商业库时必传。</li></ul>
5995
5860
  :type IdCard: str
5996
- :param _Name: 姓名。
5997
- - CompareLib为商业库时必传。
5861
+ :param _Name: <p>姓名。</p><ul><li>CompareLib为商业库时必传。</li></ul>
5998
5862
  :type Name: str
5999
- :param _ImageBase64: 图片的Base64
6000
- - CompareLib为上传照片比对时必传。
6001
- - Base64后图片最大8MB。
6002
- - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
5863
+ :param _ImageBase64: <p>图片的Base64。</p><ul><li>CompareLib为上传照片比对时必传。</li><li>Base64后图片最大8MB。</li><li>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</li></ul>
6003
5864
  :type ImageBase64: str
6004
- :param _Meta: SDK中生成的Meta字符串。
5865
+ :param _Meta: <p>SDK中生成的Meta字符串。</p>
6005
5866
  :type Meta: str
6006
- :param _Extra: 透传参数。
6007
- - 1000长度字符串
5867
+ :param _Extra: <p>透传参数。</p><ul><li>1000长度字符串</li></ul>
6008
5868
  :type Extra: str
6009
- :param _UseCos: 是否使用cos桶。
6010
- - 默认为false。
6011
- - 设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。
6012
- - 开通地址见https://console.cloud.tencent.com/faceid/cos
6013
- - 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
5869
+ :param _UseCos: <p>是否使用cos桶。</p><ul><li>默认为false。</li><li>设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。</li><li>开通地址见https://console.cloud.tencent.com/faceid/cos</li><li>【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。</li></ul>
6014
5870
  :type UseCos: bool
6015
- :param _Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号、自传照片)有加密需求的用户可使用此参数,详情请点击左侧链接。
5871
+ :param _Encryption: <p>敏感数据加密信息。对传入信息(姓名、身份证号、自传照片)有加密需求的用户可使用此参数,详情请点击左侧链接。</p>
6016
5872
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
6017
- :param _RuleId: 用于细分客户使用场景。
6018
- - 申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。
6019
- - 如有疑问,请添加腾讯云人脸核身小助手进行咨询。
5873
+ :param _RuleId: <p>用于细分客户使用场景。</p><ul><li>申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。</li><li>如有疑问,请添加腾讯云人脸核身小助手进行咨询。</li></ul>
6020
5874
  :type RuleId: str
5875
+ :param _MetaData: <p>SDK和用户设备的元信息。该字段的值由HuiYan SDK以JSON字符串格式返回。 说明:不要修改返回值,直接传递即可。</p>
5876
+ :type MetaData: str
6021
5877
  """
6022
5878
  self._CompareLib = None
6023
5879
  self._IdCard = None
@@ -6028,13 +5884,11 @@ BUSINESS:商业库。
6028
5884
  self._UseCos = None
6029
5885
  self._Encryption = None
6030
5886
  self._RuleId = None
5887
+ self._MetaData = None
6031
5888
 
6032
5889
  @property
6033
5890
  def CompareLib(self):
6034
- r"""比对库。
6035
- - 取值范围:
6036
- LOCAL:本地上传照片。
6037
- BUSINESS:商业库。
5891
+ r"""<p>比对库。</p><ul><li>取值范围:<br>LOCAL:本地上传照片。<br>BUSINESS:商业库。</li></ul>
6038
5892
  :rtype: str
6039
5893
  """
6040
5894
  return self._CompareLib
@@ -6045,8 +5899,7 @@ BUSINESS:商业库。
6045
5899
 
6046
5900
  @property
6047
5901
  def IdCard(self):
6048
- r"""身份证。
6049
- - CompareLib为商业库时必传。
5902
+ r"""<p>身份证。</p><ul><li>CompareLib为商业库时必传。</li></ul>
6050
5903
  :rtype: str
6051
5904
  """
6052
5905
  return self._IdCard
@@ -6057,8 +5910,7 @@ BUSINESS:商业库。
6057
5910
 
6058
5911
  @property
6059
5912
  def Name(self):
6060
- r"""姓名。
6061
- - CompareLib为商业库时必传。
5913
+ r"""<p>姓名。</p><ul><li>CompareLib为商业库时必传。</li></ul>
6062
5914
  :rtype: str
6063
5915
  """
6064
5916
  return self._Name
@@ -6069,10 +5921,7 @@ BUSINESS:商业库。
6069
5921
 
6070
5922
  @property
6071
5923
  def ImageBase64(self):
6072
- r"""图片的Base64
6073
- - CompareLib为上传照片比对时必传。
6074
- - Base64后图片最大8MB。
6075
- - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
5924
+ r"""<p>图片的Base64。</p><ul><li>CompareLib为上传照片比对时必传。</li><li>Base64后图片最大8MB。</li><li>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</li></ul>
6076
5925
  :rtype: str
6077
5926
  """
6078
5927
  return self._ImageBase64
@@ -6083,7 +5932,7 @@ BUSINESS:商业库。
6083
5932
 
6084
5933
  @property
6085
5934
  def Meta(self):
6086
- r"""SDK中生成的Meta字符串。
5935
+ r"""<p>SDK中生成的Meta字符串。</p>
6087
5936
  :rtype: str
6088
5937
  """
6089
5938
  return self._Meta
@@ -6094,8 +5943,7 @@ BUSINESS:商业库。
6094
5943
 
6095
5944
  @property
6096
5945
  def Extra(self):
6097
- r"""透传参数。
6098
- - 1000长度字符串
5946
+ r"""<p>透传参数。</p><ul><li>1000长度字符串</li></ul>
6099
5947
  :rtype: str
6100
5948
  """
6101
5949
  return self._Extra
@@ -6106,11 +5954,7 @@ BUSINESS:商业库。
6106
5954
 
6107
5955
  @property
6108
5956
  def UseCos(self):
6109
- r"""是否使用cos桶。
6110
- - 默认为false。
6111
- - 设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。
6112
- - 开通地址见https://console.cloud.tencent.com/faceid/cos
6113
- - 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
5957
+ r"""<p>是否使用cos桶。</p><ul><li>默认为false。</li><li>设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。</li><li>开通地址见https://console.cloud.tencent.com/faceid/cos</li><li>【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。</li></ul>
6114
5958
  :rtype: bool
6115
5959
  """
6116
5960
  return self._UseCos
@@ -6121,7 +5965,7 @@ BUSINESS:商业库。
6121
5965
 
6122
5966
  @property
6123
5967
  def Encryption(self):
6124
- r"""敏感数据加密信息。对传入信息(姓名、身份证号、自传照片)有加密需求的用户可使用此参数,详情请点击左侧链接。
5968
+ r"""<p>敏感数据加密信息。对传入信息(姓名、身份证号、自传照片)有加密需求的用户可使用此参数,详情请点击左侧链接。</p>
6125
5969
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
6126
5970
  """
6127
5971
  return self._Encryption
@@ -6132,9 +5976,7 @@ BUSINESS:商业库。
6132
5976
 
6133
5977
  @property
6134
5978
  def RuleId(self):
6135
- r"""用于细分客户使用场景。
6136
- - 申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。
6137
- - 如有疑问,请添加腾讯云人脸核身小助手进行咨询。
5979
+ r"""<p>用于细分客户使用场景。</p><ul><li>申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。</li><li>如有疑问,请添加腾讯云人脸核身小助手进行咨询。</li></ul>
6138
5980
  :rtype: str
6139
5981
  """
6140
5982
  return self._RuleId
@@ -6143,6 +5985,17 @@ BUSINESS:商业库。
6143
5985
  def RuleId(self, RuleId):
6144
5986
  self._RuleId = RuleId
6145
5987
 
5988
+ @property
5989
+ def MetaData(self):
5990
+ r"""<p>SDK和用户设备的元信息。该字段的值由HuiYan SDK以JSON字符串格式返回。 说明:不要修改返回值,直接传递即可。</p>
5991
+ :rtype: str
5992
+ """
5993
+ return self._MetaData
5994
+
5995
+ @MetaData.setter
5996
+ def MetaData(self, MetaData):
5997
+ self._MetaData = MetaData
5998
+
6146
5999
 
6147
6000
  def _deserialize(self, params):
6148
6001
  self._CompareLib = params.get("CompareLib")
@@ -6156,6 +6009,7 @@ BUSINESS:商业库。
6156
6009
  self._Encryption = Encryption()
6157
6010
  self._Encryption._deserialize(params.get("Encryption"))
6158
6011
  self._RuleId = params.get("RuleId")
6012
+ self._MetaData = params.get("MetaData")
6159
6013
  memeber_set = set(params.keys())
6160
6014
  for name, value in vars(self).items():
6161
6015
  property_name = name[1:]
@@ -6173,17 +6027,20 @@ class GetFaceIdTokenResponse(AbstractModel):
6173
6027
 
6174
6028
  def __init__(self):
6175
6029
  r"""
6176
- :param _FaceIdToken: token值。- 有效期 10分钟。- 只能完成1次核身。
6030
+ :param _FaceIdToken: <p>token值。- 有效期 10分钟。- 只能完成1次核身。</p>
6177
6031
  :type FaceIdToken: str
6032
+ :param _ClientConfig: <p>客户端配置信息,SDK将使用该配置进行后续操作。请将返回值原样传递给客户端SDK。</p>
6033
+ :type ClientConfig: str
6178
6034
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6179
6035
  :type RequestId: str
6180
6036
  """
6181
6037
  self._FaceIdToken = None
6038
+ self._ClientConfig = None
6182
6039
  self._RequestId = None
6183
6040
 
6184
6041
  @property
6185
6042
  def FaceIdToken(self):
6186
- r"""token值。- 有效期 10分钟。- 只能完成1次核身。
6043
+ r"""<p>token值。- 有效期 10分钟。- 只能完成1次核身。</p>
6187
6044
  :rtype: str
6188
6045
  """
6189
6046
  return self._FaceIdToken
@@ -6192,6 +6049,17 @@ class GetFaceIdTokenResponse(AbstractModel):
6192
6049
  def FaceIdToken(self, FaceIdToken):
6193
6050
  self._FaceIdToken = FaceIdToken
6194
6051
 
6052
+ @property
6053
+ def ClientConfig(self):
6054
+ r"""<p>客户端配置信息,SDK将使用该配置进行后续操作。请将返回值原样传递给客户端SDK。</p>
6055
+ :rtype: str
6056
+ """
6057
+ return self._ClientConfig
6058
+
6059
+ @ClientConfig.setter
6060
+ def ClientConfig(self, ClientConfig):
6061
+ self._ClientConfig = ClientConfig
6062
+
6195
6063
  @property
6196
6064
  def RequestId(self):
6197
6065
  r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -6206,6 +6074,7 @@ class GetFaceIdTokenResponse(AbstractModel):
6206
6074
 
6207
6075
  def _deserialize(self, params):
6208
6076
  self._FaceIdToken = params.get("FaceIdToken")
6077
+ self._ClientConfig = params.get("ClientConfig")
6209
6078
  self._RequestId = params.get("RequestId")
6210
6079
 
6211
6080
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-faceid
3
- Version: 3.1.134
3
+ Version: 3.1.161
4
4
  Summary: Tencent Cloud Faceid SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.134
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.161
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.1.161
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.1.134