tencentcloud-sdk-python-faceid 3.1.147__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.147 → tencentcloud_sdk_python_faceid-3.1.161}/PKG-INFO +2 -2
  2. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/setup.py +1 -1
  3. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/v20180301/models.py +131 -238
  5. {tencentcloud_sdk_python_faceid-3.1.147 → 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.147/tencentcloud_sdk_python_faceid.egg-info/requires.txt +0 -1
  8. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/README.rst +0 -0
  9. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/setup.cfg +0 -0
  10. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/__init__.py +0 -0
  11. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/v20180301/__init__.py +0 -0
  12. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/v20180301/errorcodes.py +0 -0
  13. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/v20180301/faceid_client.py +0 -0
  14. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud/faceid/v20180301/faceid_client_async.py +0 -0
  15. {tencentcloud_sdk_python_faceid-3.1.147 → tencentcloud_sdk_python_faceid-3.1.161}/tencentcloud_sdk_python_faceid.egg-info/SOURCES.txt +0 -0
  16. {tencentcloud_sdk_python_faceid-3.1.147 → 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.147 → 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.147
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.147
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.147,<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.147'
17
+ __version__ = '3.1.161'
@@ -1947,49 +1947,29 @@ class DetectAuthRequest(AbstractModel):
1947
1947
 
1948
1948
  def __init__(self):
1949
1949
  r"""
1950
- :param _RuleId: 业务流程ID
1951
- - 用于细分客户使用场景, 可为业务配置不同的业务流程。
1952
- - 申请开通服务后,登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建,审核通过后即可调用。
1953
- - 如有疑问,请添加[腾讯云人脸核身小助手](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>
1954
1951
  :type RuleId: str
1955
- :param _TerminalType: 本接口不需要传递此参数。
1952
+ :param _TerminalType: <p>本接口不需要传递此参数。</p>
1956
1953
  :type TerminalType: str
1957
- :param _IdCard: 验证人的身份证号码。
1958
- - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
1959
-
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>
1960
1955
  :type IdCard: str
1961
- :param _Name: 验证人的姓名。
1962
- - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
1963
- - 最长长度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>
1964
1957
  :type Name: str
1965
- :param _RedirectUrl: 认证结束后重定向的回调链接地址,仅微信H5场景使用。
1966
- - 最长长度1024位。
1967
- - 默认值:[腾讯云人脸核身产品介绍页](URL Here)https://cloud.tencent.com/product/faceid?Is=sdk-topnav
1968
-
1958
+ :param _RedirectUrl: <p>认证结束后重定向的回调链接地址,仅微信H5场景使用。</p><ul><li>最长长度1024位。</li><li>默认值:[腾讯云人脸核身产品介绍页](URL Here)https://cloud.tencent.com/product/faceid?Is=sdk-topnav</li></ul>
1969
1959
  :type RedirectUrl: str
1970
- :param _Extra: 透传字段,在获取验证结果时返回。
1971
- - 最长长度1024位。
1960
+ :param _Extra: <p>透传字段,在获取验证结果时返回。</p><ul><li>最长长度1024位。</li></ul>
1972
1961
  :type Extra: str
1973
- :param _ImageBase64: 用于人脸比对的图像数据,使用base64编码。
1974
- - Base64编码后的图片数据大小不超过3M。
1975
- - 仅支持jpg、png格式。
1976
- - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
1962
+ :param _ImageBase64: <p>用于人脸比对的图像数据,使用base64编码。</p><ul><li>Base64编码后的图片数据大小不超过3M。</li><li>仅支持jpg、png格式。</li><li>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</li></ul>
1977
1963
  :type ImageBase64: str
1978
- :param _Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
1964
+ :param _Encryption: <p>敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。</p>
1979
1965
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
1980
- :param _IntentionVerifyText: 意愿核身(朗读模式)使用的文案。
1981
- - 若未使用意愿核身(朗读模式),则该字段无需传入。
1982
- - 最长可接受120的字符串长度。
1966
+ :param _IntentionVerifyText: <p>意愿核身(朗读模式)使用的文案。</p><ul><li>若未使用意愿核身(朗读模式),则该字段无需传入。</li><li>最长可接受120的字符串长度。</li></ul>
1983
1967
  :type IntentionVerifyText: str
1984
- :param _IntentionQuestions: 意愿核身(语音播报+语音回答模式)使用的文案。
1985
- - 包括:系统语音播报的文本、需要核验的标准文本。
1986
- - 问答模式支持1-10轮(不超过10轮)的意愿确认。
1968
+ :param _IntentionQuestions: <p>意愿核身(语音播报+语音回答模式)使用的文案。</p><ul><li>包括:系统语音播报的文本、需要核验的标准文本。</li><li>问答模式支持1-10轮(不超过10轮)的意愿确认。</li></ul>
1987
1969
  :type IntentionQuestions: list of IntentionQuestion
1988
- :param _IntentionActions: 意愿核身(点头确认模式)使用的文案。
1989
- - 若未使用意愿核身(点头确认模式),则该字段无需传入。
1990
- - 点头确认模式支持1-10轮(不超过10轮)的意愿确认。
1970
+ :param _IntentionActions: <p>意愿核身(点头确认模式)使用的文案。</p><ul><li>若未使用意愿核身(点头确认模式),则该字段无需传入。</li><li>点头确认模式支持1-10轮(不超过10轮)的意愿确认。</li></ul>
1991
1971
  :type IntentionActions: list of IntentionActionConfig
1992
- :param _Config: 意愿核身流程配置。
1972
+ :param _Config: <p>意愿核身流程配置。</p>
1993
1973
  :type Config: :class:`tencentcloud.faceid.v20180301.models.RuleIdConfig`
1994
1974
  """
1995
1975
  self._RuleId = None
@@ -2007,10 +1987,7 @@ class DetectAuthRequest(AbstractModel):
2007
1987
 
2008
1988
  @property
2009
1989
  def RuleId(self):
2010
- r"""业务流程ID
2011
- - 用于细分客户使用场景, 可为业务配置不同的业务流程。
2012
- - 申请开通服务后,登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建,审核通过后即可调用。
2013
- - 如有疑问,请添加[腾讯云人脸核身小助手](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>
2014
1991
  :rtype: str
2015
1992
  """
2016
1993
  return self._RuleId
@@ -2021,7 +1998,7 @@ class DetectAuthRequest(AbstractModel):
2021
1998
 
2022
1999
  @property
2023
2000
  def TerminalType(self):
2024
- r"""本接口不需要传递此参数。
2001
+ r"""<p>本接口不需要传递此参数。</p>
2025
2002
  :rtype: str
2026
2003
  """
2027
2004
  return self._TerminalType
@@ -2032,9 +2009,7 @@ class DetectAuthRequest(AbstractModel):
2032
2009
 
2033
2010
  @property
2034
2011
  def IdCard(self):
2035
- r"""验证人的身份证号码。
2036
- - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
2037
-
2012
+ r"""<p>验证人的身份证号码。</p><ul><li>调用 detectAuth 时,该字段是否必传,以在<a href="https://console.cloud.tencent.com/faceid/access">控制台</a>申请 ruleId 时的配置提示为准,具体必填字段请参阅控制台界面。</li><li>若身份证号包含字母,该字母必须为大写 X,小写 x 将无法通过校验。</li></ul>
2038
2013
  :rtype: str
2039
2014
  """
2040
2015
  return self._IdCard
@@ -2045,9 +2020,7 @@ class DetectAuthRequest(AbstractModel):
2045
2020
 
2046
2021
  @property
2047
2022
  def Name(self):
2048
- r"""验证人的姓名。
2049
- - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
2050
- - 最长长度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>
2051
2024
  :rtype: str
2052
2025
  """
2053
2026
  return self._Name
@@ -2058,10 +2031,7 @@ class DetectAuthRequest(AbstractModel):
2058
2031
 
2059
2032
  @property
2060
2033
  def RedirectUrl(self):
2061
- r"""认证结束后重定向的回调链接地址,仅微信H5场景使用。
2062
- - 最长长度1024位。
2063
- - 默认值:[腾讯云人脸核身产品介绍页](URL Here)https://cloud.tencent.com/product/faceid?Is=sdk-topnav
2064
-
2034
+ r"""<p>认证结束后重定向的回调链接地址,仅微信H5场景使用。</p><ul><li>最长长度1024位。</li><li>默认值:[腾讯云人脸核身产品介绍页](URL Here)https://cloud.tencent.com/product/faceid?Is=sdk-topnav</li></ul>
2065
2035
  :rtype: str
2066
2036
  """
2067
2037
  return self._RedirectUrl
@@ -2072,8 +2042,7 @@ class DetectAuthRequest(AbstractModel):
2072
2042
 
2073
2043
  @property
2074
2044
  def Extra(self):
2075
- r"""透传字段,在获取验证结果时返回。
2076
- - 最长长度1024位。
2045
+ r"""<p>透传字段,在获取验证结果时返回。</p><ul><li>最长长度1024位。</li></ul>
2077
2046
  :rtype: str
2078
2047
  """
2079
2048
  return self._Extra
@@ -2084,10 +2053,7 @@ class DetectAuthRequest(AbstractModel):
2084
2053
 
2085
2054
  @property
2086
2055
  def ImageBase64(self):
2087
- r"""用于人脸比对的图像数据,使用base64编码。
2088
- - Base64编码后的图片数据大小不超过3M。
2089
- - 仅支持jpg、png格式。
2090
- - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2056
+ r"""<p>用于人脸比对的图像数据,使用base64编码。</p><ul><li>Base64编码后的图片数据大小不超过3M。</li><li>仅支持jpg、png格式。</li><li>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</li></ul>
2091
2057
  :rtype: str
2092
2058
  """
2093
2059
  return self._ImageBase64
@@ -2098,7 +2064,7 @@ class DetectAuthRequest(AbstractModel):
2098
2064
 
2099
2065
  @property
2100
2066
  def Encryption(self):
2101
- r"""敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2067
+ r"""<p>敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。</p>
2102
2068
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
2103
2069
  """
2104
2070
  return self._Encryption
@@ -2109,9 +2075,7 @@ class DetectAuthRequest(AbstractModel):
2109
2075
 
2110
2076
  @property
2111
2077
  def IntentionVerifyText(self):
2112
- r"""意愿核身(朗读模式)使用的文案。
2113
- - 若未使用意愿核身(朗读模式),则该字段无需传入。
2114
- - 最长可接受120的字符串长度。
2078
+ r"""<p>意愿核身(朗读模式)使用的文案。</p><ul><li>若未使用意愿核身(朗读模式),则该字段无需传入。</li><li>最长可接受120的字符串长度。</li></ul>
2115
2079
  :rtype: str
2116
2080
  """
2117
2081
  return self._IntentionVerifyText
@@ -2122,9 +2086,7 @@ class DetectAuthRequest(AbstractModel):
2122
2086
 
2123
2087
  @property
2124
2088
  def IntentionQuestions(self):
2125
- r"""意愿核身(语音播报+语音回答模式)使用的文案。
2126
- - 包括:系统语音播报的文本、需要核验的标准文本。
2127
- - 问答模式支持1-10轮(不超过10轮)的意愿确认。
2089
+ r"""<p>意愿核身(语音播报+语音回答模式)使用的文案。</p><ul><li>包括:系统语音播报的文本、需要核验的标准文本。</li><li>问答模式支持1-10轮(不超过10轮)的意愿确认。</li></ul>
2128
2090
  :rtype: list of IntentionQuestion
2129
2091
  """
2130
2092
  return self._IntentionQuestions
@@ -2135,9 +2097,7 @@ class DetectAuthRequest(AbstractModel):
2135
2097
 
2136
2098
  @property
2137
2099
  def IntentionActions(self):
2138
- r"""意愿核身(点头确认模式)使用的文案。
2139
- - 若未使用意愿核身(点头确认模式),则该字段无需传入。
2140
- - 点头确认模式支持1-10轮(不超过10轮)的意愿确认。
2100
+ r"""<p>意愿核身(点头确认模式)使用的文案。</p><ul><li>若未使用意愿核身(点头确认模式),则该字段无需传入。</li><li>点头确认模式支持1-10轮(不超过10轮)的意愿确认。</li></ul>
2141
2101
  :rtype: list of IntentionActionConfig
2142
2102
  """
2143
2103
  return self._IntentionActions
@@ -2148,7 +2108,7 @@ class DetectAuthRequest(AbstractModel):
2148
2108
 
2149
2109
  @property
2150
2110
  def Config(self):
2151
- r"""意愿核身流程配置。
2111
+ r"""<p>意愿核身流程配置。</p>
2152
2112
  :rtype: :class:`tencentcloud.faceid.v20180301.models.RuleIdConfig`
2153
2113
  """
2154
2114
  return self._Config
@@ -2202,11 +2162,9 @@ class DetectAuthResponse(AbstractModel):
2202
2162
 
2203
2163
  def __init__(self):
2204
2164
  r"""
2205
- :param _Url: 用于发起核身流程的URL,仅微信H5场景使用。
2165
+ :param _Url: <p>用于发起核身流程的URL,仅微信H5场景使用。</p>
2206
2166
  :type Url: str
2207
- :param _BizToken: 一次核验流程的唯一标识。
2208
- - 有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。
2209
- - 完成人脸核验后,需根据此标识调用[获取实名核身结果信息增强版](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>
2210
2168
  :type BizToken: str
2211
2169
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2212
2170
  :type RequestId: str
@@ -2217,7 +2175,7 @@ class DetectAuthResponse(AbstractModel):
2217
2175
 
2218
2176
  @property
2219
2177
  def Url(self):
2220
- r"""用于发起核身流程的URL,仅微信H5场景使用。
2178
+ r"""<p>用于发起核身流程的URL,仅微信H5场景使用。</p>
2221
2179
  :rtype: str
2222
2180
  """
2223
2181
  return self._Url
@@ -2228,9 +2186,7 @@ class DetectAuthResponse(AbstractModel):
2228
2186
 
2229
2187
  @property
2230
2188
  def BizToken(self):
2231
- r"""一次核验流程的唯一标识。
2232
- - 有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。
2233
- - 完成人脸核验后,需根据此标识调用[获取实名核身结果信息增强版](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>
2234
2190
  :rtype: str
2235
2191
  """
2236
2192
  return self._BizToken
@@ -5305,19 +5261,15 @@ class GetFaceIdResultRequest(AbstractModel):
5305
5261
 
5306
5262
  def __init__(self):
5307
5263
  r"""
5308
- :param _FaceIdToken: SDK人脸核身流程的标识。
5309
- - 调用[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>
5310
5265
  :type FaceIdToken: str
5311
- :param _IsNeedVideo: 是否需要拉取视频。
5312
- - 默认false:不需要。
5266
+ :param _IsNeedVideo: <p>是否需要拉取视频。</p><ul><li>默认false:不需要。</li></ul>
5313
5267
  :type IsNeedVideo: bool
5314
- :param _IsNeedBestFrame: 是否需要拉取截帧。
5315
- - 默认false:不需要。
5268
+ :param _IsNeedBestFrame: <p>是否需要拉取截帧。</p><ul><li>默认false:不需要。</li></ul>
5316
5269
  :type IsNeedBestFrame: bool
5317
- :param _IsEncryptResponse: 是否对回包整体进行加密。
5270
+ :param _IsEncryptResponse: <p>是否对回包整体进行加密。</p>
5318
5271
  :type IsEncryptResponse: bool
5319
- :param _Encryption: 是否需要对返回中的敏感信息进行加密。
5320
- 只需指定加密算法Algorithm即可,其余字段传入默认值。
5272
+ :param _Encryption: <p>是否需要对返回中的敏感信息进行加密。<br>只需指定加密算法Algorithm即可,其余字段传入默认值。</p>
5321
5273
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5322
5274
  """
5323
5275
  self._FaceIdToken = None
@@ -5328,8 +5280,7 @@ class GetFaceIdResultRequest(AbstractModel):
5328
5280
 
5329
5281
  @property
5330
5282
  def FaceIdToken(self):
5331
- r"""SDK人脸核身流程的标识。
5332
- - 调用[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>
5333
5284
  :rtype: str
5334
5285
  """
5335
5286
  return self._FaceIdToken
@@ -5340,8 +5291,7 @@ class GetFaceIdResultRequest(AbstractModel):
5340
5291
 
5341
5292
  @property
5342
5293
  def IsNeedVideo(self):
5343
- r"""是否需要拉取视频。
5344
- - 默认false:不需要。
5294
+ r"""<p>是否需要拉取视频。</p><ul><li>默认false:不需要。</li></ul>
5345
5295
  :rtype: bool
5346
5296
  """
5347
5297
  return self._IsNeedVideo
@@ -5352,8 +5302,7 @@ class GetFaceIdResultRequest(AbstractModel):
5352
5302
 
5353
5303
  @property
5354
5304
  def IsNeedBestFrame(self):
5355
- r"""是否需要拉取截帧。
5356
- - 默认false:不需要。
5305
+ r"""<p>是否需要拉取截帧。</p><ul><li>默认false:不需要。</li></ul>
5357
5306
  :rtype: bool
5358
5307
  """
5359
5308
  return self._IsNeedBestFrame
@@ -5364,7 +5313,7 @@ class GetFaceIdResultRequest(AbstractModel):
5364
5313
 
5365
5314
  @property
5366
5315
  def IsEncryptResponse(self):
5367
- r"""是否对回包整体进行加密。
5316
+ r"""<p>是否对回包整体进行加密。</p>
5368
5317
  :rtype: bool
5369
5318
  """
5370
5319
  return self._IsEncryptResponse
@@ -5375,8 +5324,7 @@ class GetFaceIdResultRequest(AbstractModel):
5375
5324
 
5376
5325
  @property
5377
5326
  def Encryption(self):
5378
- r"""是否需要对返回中的敏感信息进行加密。
5379
- 只需指定加密算法Algorithm即可,其余字段传入默认值。
5327
+ r"""<p>是否需要对返回中的敏感信息进行加密。<br>只需指定加密算法Algorithm即可,其余字段传入默认值。</p>
5380
5328
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5381
5329
  """
5382
5330
  return self._Encryption
@@ -5411,78 +5359,45 @@ class GetFaceIdResultResponse(AbstractModel):
5411
5359
 
5412
5360
  def __init__(self):
5413
5361
  r"""
5414
- :param _IdCard: 身份证。
5362
+ :param _IdCard: <p>身份证。</p>
5415
5363
  :type IdCard: str
5416
- :param _Name: 姓名。
5364
+ :param _Name: <p>姓名。</p>
5417
5365
  :type Name: str
5418
- :param _Result: 业务核验结果。
5419
- - 参考: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>
5420
5367
  :type Result: str
5421
- :param _Description: 业务核验描述。
5368
+ :param _Description: <p>业务核验描述。</p>
5422
5369
  :type Description: str
5423
- :param _Similarity: 相似度。
5424
- - 取值:0-100。
5425
- - 数值越大相似度越高。
5370
+ :param _Similarity: <p>相似度。</p><ul><li>取值:0-100。</li><li>数值越大相似度越高。</li></ul>
5426
5371
  :type Similarity: float
5427
- :param _VideoBase64: 用户核验的视频base64
5428
- - 如果选择了使用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>
5429
5373
  注意:此字段可能返回 null,表示取不到有效值。
5430
5374
  :type VideoBase64: str
5431
- :param _BestFrameBase64: 用户核验视频的截帧base64
5432
- - 如果选择了使用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>
5433
5376
  注意:此字段可能返回 null,表示取不到有效值。
5434
5377
  :type BestFrameBase64: str
5435
- :param _Extra: 获取token时透传的信息。
5378
+ :param _Extra: <p>获取token时透传的信息。</p>
5436
5379
  注意:此字段可能返回 null,表示取不到有效值。
5437
5380
  :type Extra: str
5438
- :param _DeviceInfoTag: plus版:描述当前请求所在设备的风险标签。
5439
- - 详情如下:
5440
- 06-疑似黑产设备。
5441
- null-无设备风险。
5442
- - 增强版:此字段不生效,默认为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>
5443
5382
  注意:此字段可能返回 null,表示取不到有效值。
5444
5383
  :type DeviceInfoTag: str
5445
- :param _RiskInfoTag: 行为风险标签。
5446
- - 仅错误码返回1007(设备疑似被劫持)时返回风险标签。
5447
- - 标签说明:
5448
- 02:攻击风险
5384
+ :param _RiskInfoTag: <p>行为风险标签。</p><ul><li>仅错误码返回1007(设备疑似被劫持)时返回风险标签。</li><li>标签说明:<br>02:攻击风险</li></ul>
5449
5385
  注意:此字段可能返回 null,表示取不到有效值。
5450
5386
  :type RiskInfoTag: str
5451
- :param _LivenessInfoTag: plus版:描述当前请求活体阶段被拒绝的详细原因。
5452
- - 详情如下:
5453
- 01-用户全程闭眼。
5454
- 02-用户未完成指定动作。
5455
- 03-疑似翻拍攻击。
5456
- 04-疑似合成图片。
5457
- 05-疑似合成视频。
5458
- 06-疑似合成动作。
5459
- 07-疑似黑产模板。
5460
- 08-疑似存在水印。
5461
- 09-反光校验未通过。
5462
- 10-最佳帧校验未通过。
5463
- 11-人脸质量过差。
5464
- 12-人脸距离不匹配。
5465
- 13-疑似对抗样本攻击。
5466
- null-无。
5467
- - 增强版:此字段不生效,默认为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>
5468
5388
  注意:此字段可能返回 null,表示取不到有效值。
5469
5389
  :type LivenessInfoTag: str
5470
- :param _DeviceInfoLevel: plus版:描述当前请求所在设备的风险等级,共4级。
5471
- - 详情如下:
5472
- 1 - 安全。
5473
- 2 - 低风险。
5474
- 3 - 中风险。
5475
- 4 - 高危。
5476
- null - 未获取到风险等级。
5477
- - 增强版:此字段不生效,默认为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>
5478
5391
  注意:此字段可能返回 null,表示取不到有效值。
5479
5392
  :type DeviceInfoLevel: str
5480
- :param _Encryption: 敏感数据加密信息。
5393
+ :param _Encryption: <p>敏感数据加密信息。</p>
5481
5394
  注意:此字段可能返回 null,表示取不到有效值。
5482
5395
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5483
- :param _EncryptedBody: 加密后的数据。
5396
+ :param _EncryptedBody: <p>加密后的数据。</p>
5484
5397
  注意:此字段可能返回 null,表示取不到有效值。
5485
5398
  :type EncryptedBody: str
5399
+ :param _IdCardFrontBase64: <p>用户核验的身份证人像页base64</p>
5400
+ :type IdCardFrontBase64: str
5486
5401
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5487
5402
  :type RequestId: str
5488
5403
  """
@@ -5500,11 +5415,12 @@ null - 未获取到风险等级。
5500
5415
  self._DeviceInfoLevel = None
5501
5416
  self._Encryption = None
5502
5417
  self._EncryptedBody = None
5418
+ self._IdCardFrontBase64 = None
5503
5419
  self._RequestId = None
5504
5420
 
5505
5421
  @property
5506
5422
  def IdCard(self):
5507
- r"""身份证。
5423
+ r"""<p>身份证。</p>
5508
5424
  :rtype: str
5509
5425
  """
5510
5426
  return self._IdCard
@@ -5515,7 +5431,7 @@ null - 未获取到风险等级。
5515
5431
 
5516
5432
  @property
5517
5433
  def Name(self):
5518
- r"""姓名。
5434
+ r"""<p>姓名。</p>
5519
5435
  :rtype: str
5520
5436
  """
5521
5437
  return self._Name
@@ -5526,8 +5442,7 @@ null - 未获取到风险等级。
5526
5442
 
5527
5443
  @property
5528
5444
  def Result(self):
5529
- r"""业务核验结果。
5530
- - 参考:https://cloud.tencent.com/document/product/1007/47912。
5445
+ r"""<p>业务核验结果。</p><ul><li>参考:https://cloud.tencent.com/document/product/1007/47912。</li></ul>
5531
5446
  :rtype: str
5532
5447
  """
5533
5448
  return self._Result
@@ -5538,7 +5453,7 @@ null - 未获取到风险等级。
5538
5453
 
5539
5454
  @property
5540
5455
  def Description(self):
5541
- r"""业务核验描述。
5456
+ r"""<p>业务核验描述。</p>
5542
5457
  :rtype: str
5543
5458
  """
5544
5459
  return self._Description
@@ -5549,9 +5464,7 @@ null - 未获取到风险等级。
5549
5464
 
5550
5465
  @property
5551
5466
  def Similarity(self):
5552
- r"""相似度。
5553
- - 取值:0-100。
5554
- - 数值越大相似度越高。
5467
+ r"""<p>相似度。</p><ul><li>取值:0-100。</li><li>数值越大相似度越高。</li></ul>
5555
5468
  :rtype: float
5556
5469
  """
5557
5470
  return self._Similarity
@@ -5562,8 +5475,7 @@ null - 未获取到风险等级。
5562
5475
 
5563
5476
  @property
5564
5477
  def VideoBase64(self):
5565
- r"""用户核验的视频base64
5566
- - 如果选择了使用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>
5567
5479
  注意:此字段可能返回 null,表示取不到有效值。
5568
5480
  :rtype: str
5569
5481
  """
@@ -5575,8 +5487,7 @@ null - 未获取到风险等级。
5575
5487
 
5576
5488
  @property
5577
5489
  def BestFrameBase64(self):
5578
- r"""用户核验视频的截帧base64
5579
- - 如果选择了使用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>
5580
5491
  注意:此字段可能返回 null,表示取不到有效值。
5581
5492
  :rtype: str
5582
5493
  """
@@ -5588,7 +5499,7 @@ null - 未获取到风险等级。
5588
5499
 
5589
5500
  @property
5590
5501
  def Extra(self):
5591
- r"""获取token时透传的信息。
5502
+ r"""<p>获取token时透传的信息。</p>
5592
5503
  注意:此字段可能返回 null,表示取不到有效值。
5593
5504
  :rtype: str
5594
5505
  """
@@ -5600,11 +5511,7 @@ null - 未获取到风险等级。
5600
5511
 
5601
5512
  @property
5602
5513
  def DeviceInfoTag(self):
5603
- r"""plus版:描述当前请求所在设备的风险标签。
5604
- - 详情如下:
5605
- 06-疑似黑产设备。
5606
- null-无设备风险。
5607
- - 增强版:此字段不生效,默认为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>
5608
5515
  注意:此字段可能返回 null,表示取不到有效值。
5609
5516
  :rtype: str
5610
5517
  """
@@ -5616,10 +5523,7 @@ null-无设备风险。
5616
5523
 
5617
5524
  @property
5618
5525
  def RiskInfoTag(self):
5619
- r"""行为风险标签。
5620
- - 仅错误码返回1007(设备疑似被劫持)时返回风险标签。
5621
- - 标签说明:
5622
- 02:攻击风险
5526
+ r"""<p>行为风险标签。</p><ul><li>仅错误码返回1007(设备疑似被劫持)时返回风险标签。</li><li>标签说明:<br>02:攻击风险</li></ul>
5623
5527
  注意:此字段可能返回 null,表示取不到有效值。
5624
5528
  :rtype: str
5625
5529
  """
@@ -5631,23 +5535,7 @@ null-无设备风险。
5631
5535
 
5632
5536
  @property
5633
5537
  def LivenessInfoTag(self):
5634
- r"""plus版:描述当前请求活体阶段被拒绝的详细原因。
5635
- - 详情如下:
5636
- 01-用户全程闭眼。
5637
- 02-用户未完成指定动作。
5638
- 03-疑似翻拍攻击。
5639
- 04-疑似合成图片。
5640
- 05-疑似合成视频。
5641
- 06-疑似合成动作。
5642
- 07-疑似黑产模板。
5643
- 08-疑似存在水印。
5644
- 09-反光校验未通过。
5645
- 10-最佳帧校验未通过。
5646
- 11-人脸质量过差。
5647
- 12-人脸距离不匹配。
5648
- 13-疑似对抗样本攻击。
5649
- null-无。
5650
- - 增强版:此字段不生效,默认为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>
5651
5539
  注意:此字段可能返回 null,表示取不到有效值。
5652
5540
  :rtype: str
5653
5541
  """
@@ -5659,14 +5547,7 @@ null-无。
5659
5547
 
5660
5548
  @property
5661
5549
  def DeviceInfoLevel(self):
5662
- r"""plus版:描述当前请求所在设备的风险等级,共4级。
5663
- - 详情如下:
5664
- 1 - 安全。
5665
- 2 - 低风险。
5666
- 3 - 中风险。
5667
- 4 - 高危。
5668
- null - 未获取到风险等级。
5669
- - 增强版:此字段不生效,默认为null。
5550
+ r"""<p>plus版:描述当前请求所在设备的风险等级,共4级。</p><ul><li>详情如下:<br>1 - 安全。<br>2 - 低风险。<br>3 - 中风险。<br>4 - 高危。<br>null - 未获取到风险等级。</li><li>增强版:此字段不生效,默认为null。</li></ul>
5670
5551
  注意:此字段可能返回 null,表示取不到有效值。
5671
5552
  :rtype: str
5672
5553
  """
@@ -5678,7 +5559,7 @@ null - 未获取到风险等级。
5678
5559
 
5679
5560
  @property
5680
5561
  def Encryption(self):
5681
- r"""敏感数据加密信息。
5562
+ r"""<p>敏感数据加密信息。</p>
5682
5563
  注意:此字段可能返回 null,表示取不到有效值。
5683
5564
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5684
5565
  """
@@ -5690,7 +5571,7 @@ null - 未获取到风险等级。
5690
5571
 
5691
5572
  @property
5692
5573
  def EncryptedBody(self):
5693
- r"""加密后的数据。
5574
+ r"""<p>加密后的数据。</p>
5694
5575
  注意:此字段可能返回 null,表示取不到有效值。
5695
5576
  :rtype: str
5696
5577
  """
@@ -5700,6 +5581,17 @@ null - 未获取到风险等级。
5700
5581
  def EncryptedBody(self, EncryptedBody):
5701
5582
  self._EncryptedBody = EncryptedBody
5702
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
+
5703
5595
  @property
5704
5596
  def RequestId(self):
5705
5597
  r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -5729,6 +5621,7 @@ null - 未获取到风险等级。
5729
5621
  self._Encryption = Encryption()
5730
5622
  self._Encryption._deserialize(params.get("Encryption"))
5731
5623
  self._EncryptedBody = params.get("EncryptedBody")
5624
+ self._IdCardFrontBase64 = params.get("IdCardFrontBase64")
5732
5625
  self._RequestId = params.get("RequestId")
5733
5626
 
5734
5627
 
@@ -5961,39 +5854,26 @@ class GetFaceIdTokenRequest(AbstractModel):
5961
5854
 
5962
5855
  def __init__(self):
5963
5856
  r"""
5964
- :param _CompareLib: 比对库。
5965
- - 取值范围:
5966
- LOCAL:本地上传照片。
5967
- BUSINESS:商业库。
5857
+ :param _CompareLib: <p>比对库。</p><ul><li>取值范围:<br>LOCAL:本地上传照片。<br>BUSINESS:商业库。</li></ul>
5968
5858
  :type CompareLib: str
5969
- :param _IdCard: 身份证。
5970
- - CompareLib为商业库时必传。
5859
+ :param _IdCard: <p>身份证。</p><ul><li>CompareLib为商业库时必传。</li></ul>
5971
5860
  :type IdCard: str
5972
- :param _Name: 姓名。
5973
- - CompareLib为商业库时必传。
5861
+ :param _Name: <p>姓名。</p><ul><li>CompareLib为商业库时必传。</li></ul>
5974
5862
  :type Name: str
5975
- :param _ImageBase64: 图片的Base64
5976
- - CompareLib为上传照片比对时必传。
5977
- - Base64后图片最大8MB。
5978
- - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
5863
+ :param _ImageBase64: <p>图片的Base64。</p><ul><li>CompareLib为上传照片比对时必传。</li><li>Base64后图片最大8MB。</li><li>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</li></ul>
5979
5864
  :type ImageBase64: str
5980
- :param _Meta: SDK中生成的Meta字符串。
5865
+ :param _Meta: <p>SDK中生成的Meta字符串。</p>
5981
5866
  :type Meta: str
5982
- :param _Extra: 透传参数。
5983
- - 1000长度字符串
5867
+ :param _Extra: <p>透传参数。</p><ul><li>1000长度字符串</li></ul>
5984
5868
  :type Extra: str
5985
- :param _UseCos: 是否使用cos桶。
5986
- - 默认为false。
5987
- - 设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。
5988
- - 开通地址见https://console.cloud.tencent.com/faceid/cos
5989
- - 【注意】选择该参数为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>
5990
5870
  :type UseCos: bool
5991
- :param _Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号、自传照片)有加密需求的用户可使用此参数,详情请点击左侧链接。
5871
+ :param _Encryption: <p>敏感数据加密信息。对传入信息(姓名、身份证号、自传照片)有加密需求的用户可使用此参数,详情请点击左侧链接。</p>
5992
5872
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5993
- :param _RuleId: 用于细分客户使用场景。
5994
- - 申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。
5995
- - 如有疑问,请添加腾讯云人脸核身小助手进行咨询。
5873
+ :param _RuleId: <p>用于细分客户使用场景。</p><ul><li>申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。</li><li>如有疑问,请添加腾讯云人脸核身小助手进行咨询。</li></ul>
5996
5874
  :type RuleId: str
5875
+ :param _MetaData: <p>SDK和用户设备的元信息。该字段的值由HuiYan SDK以JSON字符串格式返回。 说明:不要修改返回值,直接传递即可。</p>
5876
+ :type MetaData: str
5997
5877
  """
5998
5878
  self._CompareLib = None
5999
5879
  self._IdCard = None
@@ -6004,13 +5884,11 @@ BUSINESS:商业库。
6004
5884
  self._UseCos = None
6005
5885
  self._Encryption = None
6006
5886
  self._RuleId = None
5887
+ self._MetaData = None
6007
5888
 
6008
5889
  @property
6009
5890
  def CompareLib(self):
6010
- r"""比对库。
6011
- - 取值范围:
6012
- LOCAL:本地上传照片。
6013
- BUSINESS:商业库。
5891
+ r"""<p>比对库。</p><ul><li>取值范围:<br>LOCAL:本地上传照片。<br>BUSINESS:商业库。</li></ul>
6014
5892
  :rtype: str
6015
5893
  """
6016
5894
  return self._CompareLib
@@ -6021,8 +5899,7 @@ BUSINESS:商业库。
6021
5899
 
6022
5900
  @property
6023
5901
  def IdCard(self):
6024
- r"""身份证。
6025
- - CompareLib为商业库时必传。
5902
+ r"""<p>身份证。</p><ul><li>CompareLib为商业库时必传。</li></ul>
6026
5903
  :rtype: str
6027
5904
  """
6028
5905
  return self._IdCard
@@ -6033,8 +5910,7 @@ BUSINESS:商业库。
6033
5910
 
6034
5911
  @property
6035
5912
  def Name(self):
6036
- r"""姓名。
6037
- - CompareLib为商业库时必传。
5913
+ r"""<p>姓名。</p><ul><li>CompareLib为商业库时必传。</li></ul>
6038
5914
  :rtype: str
6039
5915
  """
6040
5916
  return self._Name
@@ -6045,10 +5921,7 @@ BUSINESS:商业库。
6045
5921
 
6046
5922
  @property
6047
5923
  def ImageBase64(self):
6048
- r"""图片的Base64
6049
- - CompareLib为上传照片比对时必传。
6050
- - Base64后图片最大8MB。
6051
- - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
5924
+ r"""<p>图片的Base64。</p><ul><li>CompareLib为上传照片比对时必传。</li><li>Base64后图片最大8MB。</li><li>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</li></ul>
6052
5925
  :rtype: str
6053
5926
  """
6054
5927
  return self._ImageBase64
@@ -6059,7 +5932,7 @@ BUSINESS:商业库。
6059
5932
 
6060
5933
  @property
6061
5934
  def Meta(self):
6062
- r"""SDK中生成的Meta字符串。
5935
+ r"""<p>SDK中生成的Meta字符串。</p>
6063
5936
  :rtype: str
6064
5937
  """
6065
5938
  return self._Meta
@@ -6070,8 +5943,7 @@ BUSINESS:商业库。
6070
5943
 
6071
5944
  @property
6072
5945
  def Extra(self):
6073
- r"""透传参数。
6074
- - 1000长度字符串
5946
+ r"""<p>透传参数。</p><ul><li>1000长度字符串</li></ul>
6075
5947
  :rtype: str
6076
5948
  """
6077
5949
  return self._Extra
@@ -6082,11 +5954,7 @@ BUSINESS:商业库。
6082
5954
 
6083
5955
  @property
6084
5956
  def UseCos(self):
6085
- r"""是否使用cos桶。
6086
- - 默认为false。
6087
- - 设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。
6088
- - 开通地址见https://console.cloud.tencent.com/faceid/cos
6089
- - 【注意】选择该参数为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>
6090
5958
  :rtype: bool
6091
5959
  """
6092
5960
  return self._UseCos
@@ -6097,7 +5965,7 @@ BUSINESS:商业库。
6097
5965
 
6098
5966
  @property
6099
5967
  def Encryption(self):
6100
- r"""敏感数据加密信息。对传入信息(姓名、身份证号、自传照片)有加密需求的用户可使用此参数,详情请点击左侧链接。
5968
+ r"""<p>敏感数据加密信息。对传入信息(姓名、身份证号、自传照片)有加密需求的用户可使用此参数,详情请点击左侧链接。</p>
6101
5969
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
6102
5970
  """
6103
5971
  return self._Encryption
@@ -6108,9 +5976,7 @@ BUSINESS:商业库。
6108
5976
 
6109
5977
  @property
6110
5978
  def RuleId(self):
6111
- r"""用于细分客户使用场景。
6112
- - 申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。
6113
- - 如有疑问,请添加腾讯云人脸核身小助手进行咨询。
5979
+ r"""<p>用于细分客户使用场景。</p><ul><li>申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。</li><li>如有疑问,请添加腾讯云人脸核身小助手进行咨询。</li></ul>
6114
5980
  :rtype: str
6115
5981
  """
6116
5982
  return self._RuleId
@@ -6119,6 +5985,17 @@ BUSINESS:商业库。
6119
5985
  def RuleId(self, RuleId):
6120
5986
  self._RuleId = RuleId
6121
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
+
6122
5999
 
6123
6000
  def _deserialize(self, params):
6124
6001
  self._CompareLib = params.get("CompareLib")
@@ -6132,6 +6009,7 @@ BUSINESS:商业库。
6132
6009
  self._Encryption = Encryption()
6133
6010
  self._Encryption._deserialize(params.get("Encryption"))
6134
6011
  self._RuleId = params.get("RuleId")
6012
+ self._MetaData = params.get("MetaData")
6135
6013
  memeber_set = set(params.keys())
6136
6014
  for name, value in vars(self).items():
6137
6015
  property_name = name[1:]
@@ -6149,17 +6027,20 @@ class GetFaceIdTokenResponse(AbstractModel):
6149
6027
 
6150
6028
  def __init__(self):
6151
6029
  r"""
6152
- :param _FaceIdToken: token值。- 有效期 10分钟。- 只能完成1次核身。
6030
+ :param _FaceIdToken: <p>token值。- 有效期 10分钟。- 只能完成1次核身。</p>
6153
6031
  :type FaceIdToken: str
6032
+ :param _ClientConfig: <p>客户端配置信息,SDK将使用该配置进行后续操作。请将返回值原样传递给客户端SDK。</p>
6033
+ :type ClientConfig: str
6154
6034
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6155
6035
  :type RequestId: str
6156
6036
  """
6157
6037
  self._FaceIdToken = None
6038
+ self._ClientConfig = None
6158
6039
  self._RequestId = None
6159
6040
 
6160
6041
  @property
6161
6042
  def FaceIdToken(self):
6162
- r"""token值。- 有效期 10分钟。- 只能完成1次核身。
6043
+ r"""<p>token值。- 有效期 10分钟。- 只能完成1次核身。</p>
6163
6044
  :rtype: str
6164
6045
  """
6165
6046
  return self._FaceIdToken
@@ -6168,6 +6049,17 @@ class GetFaceIdTokenResponse(AbstractModel):
6168
6049
  def FaceIdToken(self, FaceIdToken):
6169
6050
  self._FaceIdToken = FaceIdToken
6170
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
+
6171
6063
  @property
6172
6064
  def RequestId(self):
6173
6065
  r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -6182,6 +6074,7 @@ class GetFaceIdTokenResponse(AbstractModel):
6182
6074
 
6183
6075
  def _deserialize(self, params):
6184
6076
  self._FaceIdToken = params.get("FaceIdToken")
6077
+ self._ClientConfig = params.get("ClientConfig")
6185
6078
  self._RequestId = params.get("RequestId")
6186
6079
 
6187
6080
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-faceid
3
- Version: 3.1.147
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.147
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.147