tencentcloud-sdk-python 3.0.1265__py2.py3-none-any.whl → 3.0.1267__py2.py3-none-any.whl

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 (78) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/apm/v20210622/models.py +128 -0
  3. tencentcloud/asr/v20190614/models.py +2 -2
  4. tencentcloud/autoscaling/v20180419/models.py +65 -6
  5. tencentcloud/batch/v20170312/models.py +20 -2
  6. tencentcloud/cat/v20180409/models.py +20 -0
  7. tencentcloud/cbs/v20170312/models.py +124 -70
  8. tencentcloud/ccc/v20200210/models.py +125 -0
  9. tencentcloud/cdb/v20170320/cdb_client.py +2 -2
  10. tencentcloud/cdb/v20170320/errorcodes.py +1 -1
  11. tencentcloud/cdb/v20170320/models.py +17 -6
  12. tencentcloud/cdc/v20201214/models.py +2 -54
  13. tencentcloud/cdz/v20221123/models.py +75 -1
  14. tencentcloud/ckafka/v20190819/models.py +67 -22
  15. tencentcloud/clb/v20180317/clb_client.py +1 -1
  16. tencentcloud/clb/v20180317/models.py +54 -20
  17. tencentcloud/cloudstudio/v20230508/models.py +0 -18
  18. tencentcloud/cls/v20201016/models.py +91 -0
  19. tencentcloud/cvm/v20170312/models.py +99 -22
  20. tencentcloud/cwp/v20180228/cwp_client.py +0 -25
  21. tencentcloud/cwp/v20180228/models.py +0 -197
  22. tencentcloud/dasb/v20191018/models.py +150 -0
  23. tencentcloud/emr/v20190103/emr_client.py +9 -9
  24. tencentcloud/emr/v20190103/models.py +325 -1
  25. tencentcloud/es/v20180416/errorcodes.py +3 -0
  26. tencentcloud/es/v20180416/models.py +30 -0
  27. tencentcloud/ess/v20201111/ess_client.py +22 -30
  28. tencentcloud/ess/v20201111/models.py +59 -14
  29. tencentcloud/essbasic/v20210526/essbasic_client.py +34 -8
  30. tencentcloud/essbasic/v20210526/models.py +77 -28
  31. tencentcloud/faceid/v20180301/models.py +983 -539
  32. tencentcloud/gme/v20180711/errorcodes.py +9 -0
  33. tencentcloud/gme/v20180711/models.py +17 -2
  34. tencentcloud/hai/v20230812/models.py +2 -2
  35. tencentcloud/hunyuan/v20230901/models.py +30 -0
  36. tencentcloud/iai/v20180301/models.py +40 -26
  37. tencentcloud/iai/v20200303/models.py +760 -546
  38. tencentcloud/iotexplorer/v20190423/errorcodes.py +1 -1
  39. tencentcloud/iotexplorer/v20190423/models.py +8 -8
  40. tencentcloud/iotvideo/v20191126/models.py +4 -4
  41. tencentcloud/lke/v20231130/models.py +12 -12
  42. tencentcloud/monitor/v20180724/models.py +17 -0
  43. tencentcloud/mrs/v20200910/models.py +27 -8
  44. tencentcloud/ms/v20180408/ms_client.py +3 -1
  45. tencentcloud/ocr/v20181119/models.py +519 -14
  46. tencentcloud/ocr/v20181119/ocr_client.py +49 -2
  47. tencentcloud/omics/v20221128/models.py +100 -232
  48. tencentcloud/partners/v20180321/models.py +2 -92
  49. tencentcloud/rce/v20201103/errorcodes.py +132 -0
  50. tencentcloud/rce/v20201103/models.py +261 -0
  51. tencentcloud/rce/v20201103/rce_client.py +23 -0
  52. tencentcloud/redis/v20180412/models.py +2 -6
  53. tencentcloud/rum/v20210622/models.py +15 -0
  54. tencentcloud/scf/v20180416/models.py +2 -2
  55. tencentcloud/ssl/v20191205/models.py +2 -2
  56. tencentcloud/tdmq/v20200217/models.py +40 -10
  57. tencentcloud/tds/v20220801/models.py +4 -4
  58. tencentcloud/thpc/v20230321/models.py +2 -2
  59. tencentcloud/tke/v20180525/models.py +2 -4
  60. tencentcloud/tmt/v20180321/models.py +60 -5
  61. tencentcloud/trro/v20220325/models.py +0 -30
  62. tencentcloud/trtc/v20190722/models.py +97 -2
  63. tencentcloud/vclm/v20240523/models.py +170 -100
  64. tencentcloud/vclm/v20240523/vclm_client.py +52 -52
  65. tencentcloud/vod/v20180717/models.py +114 -2
  66. tencentcloud/vod/v20180717/vod_client.py +1 -1
  67. tencentcloud/vod/v20240718/models.py +15 -15
  68. tencentcloud/vpc/v20170312/errorcodes.py +3 -0
  69. tencentcloud/vpc/v20170312/models.py +167 -10
  70. tencentcloud/vpc/v20170312/vpc_client.py +7 -2
  71. tencentcloud/waf/v20180125/models.py +618 -0
  72. tencentcloud/waf/v20180125/waf_client.py +69 -0
  73. tencentcloud/wedata/v20210820/models.py +18 -18
  74. {tencentcloud_sdk_python-3.0.1265.dist-info → tencentcloud_sdk_python-3.0.1267.dist-info}/METADATA +1 -1
  75. {tencentcloud_sdk_python-3.0.1265.dist-info → tencentcloud_sdk_python-3.0.1267.dist-info}/RECORD +78 -78
  76. {tencentcloud_sdk_python-3.0.1265.dist-info → tencentcloud_sdk_python-3.0.1267.dist-info}/LICENSE +0 -0
  77. {tencentcloud_sdk_python-3.0.1265.dist-info → tencentcloud_sdk_python-3.0.1267.dist-info}/WHEEL +0 -0
  78. {tencentcloud_sdk_python-3.0.1265.dist-info → tencentcloud_sdk_python-3.0.1267.dist-info}/top_level.txt +0 -0
@@ -2099,33 +2099,47 @@ class DetectAuthRequest(AbstractModel):
2099
2099
 
2100
2100
  def __init__(self):
2101
2101
  r"""
2102
- :param _RuleId: 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
2102
+ :param _RuleId: 业务流程ID。
2103
+ - 用于细分客户使用场景, 可为业务配置不同的业务流程。
2104
+ - 申请开通服务后,登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建,审核通过后即可调用。
2105
+ - 如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
2103
2106
  :type RuleId: str
2104
2107
  :param _TerminalType: 本接口不需要传递此参数。
2105
2108
  :type TerminalType: str
2106
- :param _IdCard: 身份标识(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。
2107
- 规则:a-z,A-Z,0-9组合。最长长度32位。
2109
+ :param _IdCard: 验证人的身份证号码。
2110
+ - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
2111
+
2108
2112
  :type IdCard: str
2109
- :param _Name: 姓名。(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。
2110
- 最长长度32位。中文请使用UTF-8编码。
2113
+ :param _Name: 验证人的姓名。
2114
+ - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
2115
+ - 最长长度32位。中文请使用UTF-8编码。
2111
2116
  :type Name: str
2112
- :param _RedirectUrl: 认证结束后重定向的回调链接地址。最长长度1024位。
2117
+ :param _RedirectUrl: 认证结束后重定向的回调链接地址。
2118
+ - 最长长度1024位。
2113
2119
  :type RedirectUrl: str
2114
2120
  :param _Extra: 透传字段,在获取验证结果时返回。
2115
2121
  :type Extra: str
2116
- :param _ImageBase64: 用于人脸比对的照片,图片的Base64值;
2117
- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648
2122
+ :param _ImageBase64: 用于人脸比对的图像数据,使用base64编码。
2123
+ - Base64编码后的图片数据大小不超过3M。
2124
+ - 仅支持jpg、png格式。
2125
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2118
2126
  :type ImageBase64: str
2119
2127
  :param _Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
2120
2128
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
2121
- :param _IntentionVerifyText: 意愿核身(朗读模式)使用的文案,若未使用意愿核身(朗读模式),则该字段无需传入。默认为空,最长可接受120的字符串长度。
2129
+ :param _IntentionVerifyText: 意愿核身(朗读模式)使用的文案。
2130
+ - 若未使用意愿核身(朗读模式),则该字段无需传入。
2131
+ - 最长可接受120的字符串长度。
2122
2132
  :type IntentionVerifyText: str
2123
- :param _IntentionQuestions: 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
2133
+ :param _IntentionQuestions: 意愿核身(语音播报+语音回答模式)使用的文案。
2134
+ - 包括:系统语音播报的文本、需要核验的标准文本。
2135
+ - 当前仅支持1轮问答。
2124
2136
  :type IntentionQuestions: list of IntentionQuestion
2125
- :param _Config: RuleId相关配置
2126
- :type Config: :class:`tencentcloud.faceid.v20180301.models.RuleIdConfig`
2127
- :param _IntentionActions: 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
2137
+ :param _IntentionActions: 意愿核身(点头确认模式)使用的文案。
2138
+ - 若未使用意愿核身(点头确认模式),则该字段无需传入。
2139
+ - 当前仅支持一个提示文本。
2128
2140
  :type IntentionActions: list of IntentionActionConfig
2141
+ :param _Config: 意愿核身流程配置。
2142
+ :type Config: :class:`tencentcloud.faceid.v20180301.models.RuleIdConfig`
2129
2143
  """
2130
2144
  self._RuleId = None
2131
2145
  self._TerminalType = None
@@ -2137,12 +2151,15 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
2137
2151
  self._Encryption = None
2138
2152
  self._IntentionVerifyText = None
2139
2153
  self._IntentionQuestions = None
2140
- self._Config = None
2141
2154
  self._IntentionActions = None
2155
+ self._Config = None
2142
2156
 
2143
2157
  @property
2144
2158
  def RuleId(self):
2145
- """用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
2159
+ """业务流程ID。
2160
+ - 用于细分客户使用场景, 可为业务配置不同的业务流程。
2161
+ - 申请开通服务后,登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建,审核通过后即可调用。
2162
+ - 如有疑问,请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
2146
2163
  :rtype: str
2147
2164
  """
2148
2165
  return self._RuleId
@@ -2164,8 +2181,9 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
2164
2181
 
2165
2182
  @property
2166
2183
  def IdCard(self):
2167
- """身份标识(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。
2168
- 规则:a-z,A-Z,0-9组合。最长长度32位。
2184
+ """验证人的身份证号码。
2185
+ - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
2186
+
2169
2187
  :rtype: str
2170
2188
  """
2171
2189
  return self._IdCard
@@ -2176,8 +2194,9 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
2176
2194
 
2177
2195
  @property
2178
2196
  def Name(self):
2179
- """姓名。(是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示)。
2180
- 最长长度32位。中文请使用UTF-8编码。
2197
+ """验证人的姓名。
2198
+ - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。
2199
+ - 最长长度32位。中文请使用UTF-8编码。
2181
2200
  :rtype: str
2182
2201
  """
2183
2202
  return self._Name
@@ -2188,7 +2207,8 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
2188
2207
 
2189
2208
  @property
2190
2209
  def RedirectUrl(self):
2191
- """认证结束后重定向的回调链接地址。最长长度1024位。
2210
+ """认证结束后重定向的回调链接地址。
2211
+ - 最长长度1024位。
2192
2212
  :rtype: str
2193
2213
  """
2194
2214
  return self._RedirectUrl
@@ -2210,8 +2230,10 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
2210
2230
 
2211
2231
  @property
2212
2232
  def ImageBase64(self):
2213
- """用于人脸比对的照片,图片的Base64值;
2214
- Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648
2233
+ """用于人脸比对的图像数据,使用base64编码。
2234
+ - Base64编码后的图片数据大小不超过3M。
2235
+ - 仅支持jpg、png格式。
2236
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
2215
2237
  :rtype: str
2216
2238
  """
2217
2239
  return self._ImageBase64
@@ -2233,7 +2255,9 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
2233
2255
 
2234
2256
  @property
2235
2257
  def IntentionVerifyText(self):
2236
- """意愿核身(朗读模式)使用的文案,若未使用意愿核身(朗读模式),则该字段无需传入。默认为空,最长可接受120的字符串长度。
2258
+ """意愿核身(朗读模式)使用的文案。
2259
+ - 若未使用意愿核身(朗读模式),则该字段无需传入。
2260
+ - 最长可接受120的字符串长度。
2237
2261
  :rtype: str
2238
2262
  """
2239
2263
  return self._IntentionVerifyText
@@ -2244,7 +2268,9 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
2244
2268
 
2245
2269
  @property
2246
2270
  def IntentionQuestions(self):
2247
- """意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
2271
+ """意愿核身(语音播报+语音回答模式)使用的文案。
2272
+ - 包括:系统语音播报的文本、需要核验的标准文本。
2273
+ - 当前仅支持1轮问答。
2248
2274
  :rtype: list of IntentionQuestion
2249
2275
  """
2250
2276
  return self._IntentionQuestions
@@ -2253,20 +2279,11 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
2253
2279
  def IntentionQuestions(self, IntentionQuestions):
2254
2280
  self._IntentionQuestions = IntentionQuestions
2255
2281
 
2256
- @property
2257
- def Config(self):
2258
- """RuleId相关配置
2259
- :rtype: :class:`tencentcloud.faceid.v20180301.models.RuleIdConfig`
2260
- """
2261
- return self._Config
2262
-
2263
- @Config.setter
2264
- def Config(self, Config):
2265
- self._Config = Config
2266
-
2267
2282
  @property
2268
2283
  def IntentionActions(self):
2269
- """意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
2284
+ """意愿核身(点头确认模式)使用的文案。
2285
+ - 若未使用意愿核身(点头确认模式),则该字段无需传入。
2286
+ - 当前仅支持一个提示文本。
2270
2287
  :rtype: list of IntentionActionConfig
2271
2288
  """
2272
2289
  return self._IntentionActions
@@ -2275,6 +2292,17 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
2275
2292
  def IntentionActions(self, IntentionActions):
2276
2293
  self._IntentionActions = IntentionActions
2277
2294
 
2295
+ @property
2296
+ def Config(self):
2297
+ """意愿核身流程配置。
2298
+ :rtype: :class:`tencentcloud.faceid.v20180301.models.RuleIdConfig`
2299
+ """
2300
+ return self._Config
2301
+
2302
+ @Config.setter
2303
+ def Config(self, Config):
2304
+ self._Config = Config
2305
+
2278
2306
 
2279
2307
  def _deserialize(self, params):
2280
2308
  self._RuleId = params.get("RuleId")
@@ -2294,15 +2322,15 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请
2294
2322
  obj = IntentionQuestion()
2295
2323
  obj._deserialize(item)
2296
2324
  self._IntentionQuestions.append(obj)
2297
- if params.get("Config") is not None:
2298
- self._Config = RuleIdConfig()
2299
- self._Config._deserialize(params.get("Config"))
2300
2325
  if params.get("IntentionActions") is not None:
2301
2326
  self._IntentionActions = []
2302
2327
  for item in params.get("IntentionActions"):
2303
2328
  obj = IntentionActionConfig()
2304
2329
  obj._deserialize(item)
2305
2330
  self._IntentionActions.append(obj)
2331
+ if params.get("Config") is not None:
2332
+ self._Config = RuleIdConfig()
2333
+ self._Config._deserialize(params.get("Config"))
2306
2334
  memeber_set = set(params.keys())
2307
2335
  for name, value in vars(self).items():
2308
2336
  property_name = name[1:]
@@ -2322,8 +2350,9 @@ class DetectAuthResponse(AbstractModel):
2322
2350
  r"""
2323
2351
  :param _Url: 用于发起核身流程的URL,仅微信H5场景使用。
2324
2352
  :type Url: str
2325
- :param _BizToken: 一次核身流程的标识,有效时间为7,200秒;
2326
- 完成核身后,可用该标识获取验证结果信息。
2353
+ :param _BizToken: 一次核验流程的唯一标识。
2354
+ - 有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。
2355
+ - 完成人脸核验后,需根据此标识调用[获取实名核身结果信息增强版](https://cloud.tencent.com/document/api/1007/41957)获取用户最终验证结果信息。
2327
2356
  :type BizToken: str
2328
2357
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2329
2358
  :type RequestId: str
@@ -2345,8 +2374,9 @@ class DetectAuthResponse(AbstractModel):
2345
2374
 
2346
2375
  @property
2347
2376
  def BizToken(self):
2348
- """一次核身流程的标识,有效时间为7,200秒;
2349
- 完成核身后,可用该标识获取验证结果信息。
2377
+ """一次核验流程的唯一标识。
2378
+ - 有效时间为7,200秒,超过有效期再进行人脸核验会报错,请在有效期内进行核验。
2379
+ - 完成人脸核验后,需根据此标识调用[获取实名核身结果信息增强版](https://cloud.tencent.com/document/api/1007/41957)获取用户最终验证结果信息。
2350
2380
  :rtype: str
2351
2381
  """
2352
2382
  return self._BizToken
@@ -2651,7 +2681,7 @@ class DetectDetail(AbstractModel):
2651
2681
 
2652
2682
 
2653
2683
  class DetectInfoBestFrame(AbstractModel):
2654
- """核身最佳帧信息
2684
+ """核身最佳帧信息。
2655
2685
 
2656
2686
  """
2657
2687
 
@@ -2706,7 +2736,7 @@ class DetectInfoBestFrame(AbstractModel):
2706
2736
 
2707
2737
 
2708
2738
  class DetectInfoIdCardData(AbstractModel):
2709
- """核身身份证图片信息
2739
+ """核身身份证图片信息。
2710
2740
 
2711
2741
  """
2712
2742
 
@@ -2715,7 +2745,7 @@ class DetectInfoIdCardData(AbstractModel):
2715
2745
  :param _OcrFront: OCR正面照片的base64编码。
2716
2746
  注意:此字段可能返回 null,表示取不到有效值。
2717
2747
  :type OcrFront: str
2718
- :param _OcrBack: OCR反面照片的base64编码
2748
+ :param _OcrBack: OCR反面照片的base64编码。
2719
2749
  注意:此字段可能返回 null,表示取不到有效值。
2720
2750
  :type OcrBack: str
2721
2751
  :param _ProcessedFrontImage: 旋转裁边后的正面照片base64编码。
@@ -2727,26 +2757,30 @@ class DetectInfoIdCardData(AbstractModel):
2727
2757
  :param _Avatar: 身份证正面人像图base64编码。
2728
2758
  注意:此字段可能返回 null,表示取不到有效值。
2729
2759
  :type Avatar: str
2730
- :param _WarnInfos: 身份证人像面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
2731
- -9100 身份证有效日期不合法告警,
2732
- -9101 身份证边框不完整告警,
2733
- -9102 身份证复印件告警,
2734
- -9103 身份证翻拍告警,
2735
- -9105 身份证框内遮挡告警,
2736
- -9104 临时身份证告警,
2737
- -9106 身份证 PS 告警(疑似存在PS痕迹),
2738
- -9107 身份证反光告警。
2760
+ :param _WarnInfos: 身份证人像面告警码。
2761
+ - 开启身份证告警功能后才会返回。
2762
+ - 返回数组中可能出现的告警码如下:
2763
+ - -9100 身份证有效日期不合法告警。
2764
+ - -9101 身份证边框不完整告警。
2765
+ - -9102 身份证复印件告警。
2766
+ - -9103 身份证翻拍告警。
2767
+ - -9105 身份证框内遮挡告警。
2768
+ - -9104 临时身份证告警。
2769
+ - -9106 身份证 PS 告警(疑似存在PS痕迹)。
2770
+ - -9107 身份证反光告警。
2739
2771
  注意:此字段可能返回 null,表示取不到有效值。
2740
2772
  :type WarnInfos: list of int
2741
- :param _BackWarnInfos: 身份证国徽面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
2742
- -9100 身份证有效日期不合法告警,
2743
- -9101 身份证边框不完整告警,
2744
- -9102 身份证复印件告警,
2745
- -9103 身份证翻拍告警,
2746
- -9105 身份证框内遮挡告警,
2747
- -9104 临时身份证告警,
2748
- -9106 身份证 PS 告警(疑似存在PS痕迹),
2749
- -9107 身份证反光告警。
2773
+ :param _BackWarnInfos: 身份证国徽面告警码。
2774
+ - 开启身份证告警功能后才会返回。
2775
+ - 返回数组中可能出现的告警码如下:
2776
+ - -9100 身份证有效日期不合法告警,
2777
+ - -9101 身份证边框不完整告警,
2778
+ - -9102 身份证复印件告警,
2779
+ - -9103 身份证翻拍告警,
2780
+ - -9105 身份证框内遮挡告警,
2781
+ - -9104 临时身份证告警,
2782
+ - -9106 身份证 PS 告警(疑似存在PS痕迹),
2783
+ - -9107 身份证反光告警。
2750
2784
  注意:此字段可能返回 null,表示取不到有效值。
2751
2785
  :type BackWarnInfos: list of int
2752
2786
  """
@@ -2772,7 +2806,7 @@ class DetectInfoIdCardData(AbstractModel):
2772
2806
 
2773
2807
  @property
2774
2808
  def OcrBack(self):
2775
- """OCR反面照片的base64编码
2809
+ """OCR反面照片的base64编码。
2776
2810
  注意:此字段可能返回 null,表示取不到有效值。
2777
2811
  :rtype: str
2778
2812
  """
@@ -2820,15 +2854,17 @@ class DetectInfoIdCardData(AbstractModel):
2820
2854
 
2821
2855
  @property
2822
2856
  def WarnInfos(self):
2823
- """身份证人像面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
2824
- -9100 身份证有效日期不合法告警,
2825
- -9101 身份证边框不完整告警,
2826
- -9102 身份证复印件告警,
2827
- -9103 身份证翻拍告警,
2828
- -9105 身份证框内遮挡告警,
2829
- -9104 临时身份证告警,
2830
- -9106 身份证 PS 告警(疑似存在PS痕迹),
2831
- -9107 身份证反光告警。
2857
+ """身份证人像面告警码。
2858
+ - 开启身份证告警功能后才会返回。
2859
+ - 返回数组中可能出现的告警码如下:
2860
+ - -9100 身份证有效日期不合法告警。
2861
+ - -9101 身份证边框不完整告警。
2862
+ - -9102 身份证复印件告警。
2863
+ - -9103 身份证翻拍告警。
2864
+ - -9105 身份证框内遮挡告警。
2865
+ - -9104 临时身份证告警。
2866
+ - -9106 身份证 PS 告警(疑似存在PS痕迹)。
2867
+ - -9107 身份证反光告警。
2832
2868
  注意:此字段可能返回 null,表示取不到有效值。
2833
2869
  :rtype: list of int
2834
2870
  """
@@ -2840,15 +2876,17 @@ class DetectInfoIdCardData(AbstractModel):
2840
2876
 
2841
2877
  @property
2842
2878
  def BackWarnInfos(self):
2843
- """身份证国徽面告警码,开启身份证告警功能后才会返回,返回数组中可能出现的告警码如下:
2844
- -9100 身份证有效日期不合法告警,
2845
- -9101 身份证边框不完整告警,
2846
- -9102 身份证复印件告警,
2847
- -9103 身份证翻拍告警,
2848
- -9105 身份证框内遮挡告警,
2849
- -9104 临时身份证告警,
2850
- -9106 身份证 PS 告警(疑似存在PS痕迹),
2851
- -9107 身份证反光告警。
2879
+ """身份证国徽面告警码。
2880
+ - 开启身份证告警功能后才会返回。
2881
+ - 返回数组中可能出现的告警码如下:
2882
+ - -9100 身份证有效日期不合法告警,
2883
+ - -9101 身份证边框不完整告警,
2884
+ - -9102 身份证复印件告警,
2885
+ - -9103 身份证翻拍告警,
2886
+ - -9105 身份证框内遮挡告警,
2887
+ - -9104 临时身份证告警,
2888
+ - -9106 身份证 PS 告警(疑似存在PS痕迹),
2889
+ - -9107 身份证反光告警。
2852
2890
  注意:此字段可能返回 null,表示取不到有效值。
2853
2891
  :rtype: list of int
2854
2892
  """
@@ -2878,25 +2916,29 @@ class DetectInfoIdCardData(AbstractModel):
2878
2916
 
2879
2917
 
2880
2918
  class DetectInfoText(AbstractModel):
2881
- """核身文本信息
2919
+ """核身文本信息。
2882
2920
 
2883
2921
  """
2884
2922
 
2885
2923
  def __init__(self):
2886
2924
  r"""
2887
- :param _ErrCode: 本次流程最终验证结果。0为成功(仅包含活体人脸核身结果,不包含意愿核身结果)
2925
+ :param _ErrCode: 本次流程最终验证结果。
2926
+ - 取值范围:0为成功。
2927
+ - 仅包含活体人脸核身结果,不包含意愿核身结果。
2888
2928
  注意:此字段可能返回 null,表示取不到有效值。
2889
2929
  :type ErrCode: int
2890
- :param _ErrMsg: 本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
2930
+ :param _ErrMsg: 本次流程最终验证结果描述。
2931
+ - 仅描述用,文案更新时不会通知。
2891
2932
  注意:此字段可能返回 null,表示取不到有效值。
2892
2933
  :type ErrMsg: str
2893
2934
  :param _IdCard: 本次验证使用的身份证号。
2894
2935
  注意:此字段可能返回 null,表示取不到有效值。
2895
2936
  :type IdCard: str
2896
- :param _UseIDType: 用户认证时使用的证件号码类型:
2897
- 0:二代身份证的证件号码
2898
- 1:港澳台居住证的证件号码
2899
- 2:其他(核验使用的证件号码非合法身份号码)
2937
+ :param _UseIDType: 用户认证时使用的证件号码类型。
2938
+ - 取值范围:
2939
+ 0:二代身份证的证件号码。
2940
+ 1:港澳台居住证的证件号码。
2941
+ 2:其他(核验使用的证件号码非合法身份号码)。
2900
2942
  注意:此字段可能返回 null,表示取不到有效值。
2901
2943
  :type UseIDType: int
2902
2944
  :param _Name: 本次验证使用的姓名。
@@ -2908,13 +2950,15 @@ class DetectInfoText(AbstractModel):
2908
2950
  :param _OcrAddress: 身份校验环节识别结果:家庭住址。
2909
2951
  注意:此字段可能返回 null,表示取不到有效值。
2910
2952
  :type OcrAddress: str
2911
- :param _OcrBirth: 身份校验环节识别结果:生日。格式为:YYYY/M/D
2953
+ :param _OcrBirth: 身份校验环节识别结果:生日。
2954
+ - 格式为:YYYY/M/D
2912
2955
  注意:此字段可能返回 null,表示取不到有效值。
2913
2956
  :type OcrBirth: str
2914
2957
  :param _OcrAuthority: 身份校验环节识别结果:签发机关。
2915
2958
  注意:此字段可能返回 null,表示取不到有效值。
2916
2959
  :type OcrAuthority: str
2917
- :param _OcrValidDate: 身份校验环节识别结果:有效日期。格式为:YYYY.MM.DD-YYYY.MM.DD
2960
+ :param _OcrValidDate: 身份校验环节识别结果:有效日期。
2961
+ - 格式为:YYYY.MM.DD-YYYY.MM.DD。
2918
2962
  注意:此字段可能返回 null,表示取不到有效值。
2919
2963
  :type OcrValidDate: str
2920
2964
  :param _OcrName: 身份校验环节识别结果:姓名。
@@ -2927,22 +2971,29 @@ class DetectInfoText(AbstractModel):
2927
2971
  注意:此字段可能返回 null,表示取不到有效值。
2928
2972
  :type OcrGender: str
2929
2973
  :param _IdInfoFrom: 身份校验环节采用的信息上传方式。
2930
- 取值有"NFC"、"OCR"、"手动输入"、"其他"
2974
+ - 取值有"NFC"、"OCR"、"手动输入"、"其他"
2931
2975
  注意:此字段可能返回 null,表示取不到有效值。
2932
2976
  :type IdInfoFrom: str
2933
- :param _LiveStatus: 本次流程最终活体结果。0为成功
2977
+ :param _LiveStatus: 本次流程最终活体结果。
2978
+ - 0为成功
2934
2979
  注意:此字段可能返回 null,表示取不到有效值。
2935
2980
  :type LiveStatus: int
2936
- :param _LiveMsg: 本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
2981
+ :param _LiveMsg: 本次流程最终活体结果描述。
2982
+ - 仅描述用,文案更新时不会通知。
2937
2983
  注意:此字段可能返回 null,表示取不到有效值。
2938
2984
  :type LiveMsg: str
2939
- :param _Comparestatus: 本次流程最终一比一结果。0为成功
2985
+ :param _Comparestatus: 本次流程最终一比一结果。
2986
+ - 0为成功
2940
2987
  注意:此字段可能返回 null,表示取不到有效值。
2941
2988
  :type Comparestatus: int
2942
- :param _Comparemsg: 本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
2989
+ :param _Comparemsg: 本次流程最终一比一结果描述。
2990
+ - 仅描述用,文案更新时不会通知。
2943
2991
  注意:此字段可能返回 null,表示取不到有效值。
2944
2992
  :type Comparemsg: str
2945
- :param _Sim: 本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
2993
+ :param _Sim: 本次流程活体一比一的分数。
2994
+ - 取值范围 [0.00, 100.00]。
2995
+ - 相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值。
2996
+ - 阈值70的误通过率为千分之一,阈值80的误通过率是万分之一。
2946
2997
  注意:此字段可能返回 null,表示取不到有效值。
2947
2998
  :type Sim: str
2948
2999
  :param _Location: 地理位置经纬度。
@@ -2954,51 +3005,54 @@ class DetectInfoText(AbstractModel):
2954
3005
  :param _LivenessDetail: 本次流程进行的活体一比一流水。
2955
3006
  注意:此字段可能返回 null,表示取不到有效值。
2956
3007
  :type LivenessDetail: list of DetectDetail
2957
- :param _LivenessInfoTag: 描述当前请求活体阶段被拒绝的详细原因,详情如下:
2958
- 01-用户全程闭眼
2959
- 02-用户未完成指定动作
2960
- 03-疑似翻拍攻击
2961
- 04-疑似合成攻击
2962
- 05-疑似黑产模版
2963
- 06-疑似存在水印
2964
- 07-反光校验未通过
2965
- 08-疑似中途换人
2966
- 09-人脸质量过差
2967
- 10-距离校验不通过
2968
- 11-疑似对抗样本攻击
2969
- 12-嘴巴区域疑似存在攻击痕迹
2970
- 13-眼睛区域疑似存在攻击痕迹
2971
- 14-眼睛或嘴巴被遮挡
3008
+ :param _LivenessInfoTag: 描述当前请求活体阶段被拒绝的详细原因,该参数仅限PLUS版本核身服务返回。
3009
+ - 详情如下:
3010
+ 01-用户全程闭眼
3011
+ 02-用户未完成指定动作
3012
+ 03-疑似翻拍攻击
3013
+ 04-疑似合成攻击
3014
+ 05-疑似黑产模版
3015
+ 06-疑似存在水印
3016
+ 07-反光校验未通过
3017
+ 08-疑似中途换人
3018
+ 09-人脸质量过差
3019
+ 10-距离校验不通过
3020
+ 11-疑似对抗样本攻击
3021
+ 12-嘴巴区域疑似存在攻击痕迹
3022
+ 13-眼睛区域疑似存在攻击痕迹
3023
+ 14-眼睛或嘴巴被遮挡
2972
3024
  注意:此字段可能返回 null,表示取不到有效值。
2973
3025
  :type LivenessInfoTag: list of str
2974
3026
  :param _Mobile: 手机号码。
2975
3027
  注意:此字段可能返回 null,表示取不到有效值。
2976
3028
  :type Mobile: str
2977
- :param _CompareLibType: 本次流程最终比对库源类型。包括:
2978
- 权威库;
2979
- 业务方自有库(用户上传照片、客户的混合库、混合部署库);
2980
- 二次验证库;
2981
- 人工审核库;
3029
+ :param _CompareLibType: 本次流程最终比对库源类型。
3030
+ - 取值范围:
3031
+ 权威库。
3032
+ 业务方自有库(用户上传照片、客户的混合库、混合部署库)。
3033
+ 二次验证库。
3034
+ 人工审核库。
2982
3035
  注意:此字段可能返回 null,表示取不到有效值。
2983
3036
  :type CompareLibType: str
2984
- :param _LivenessMode: 本次流程最终活体类型。包括:
2985
- 0:未知
2986
- 1:数字活体
2987
- 2:动作活体
2988
- 3:静默活体
2989
- 4:一闪活体(动作+光线)
3037
+ :param _LivenessMode: 本次流程最终活体类型。
3038
+ - 取值范围:
3039
+ 0:未知
3040
+ 1:数字活体
3041
+ 2:动作活体
3042
+ 3:静默活体
3043
+ 4:一闪活体(动作+光线)
2990
3044
  注意:此字段可能返回 null,表示取不到有效值。
2991
3045
  :type LivenessMode: int
2992
- :param _NFCRequestIds: nfc重复计费requestId列表
3046
+ :param _NFCRequestIds: nfc重复计费requestId列表。
2993
3047
  注意:此字段可能返回 null,表示取不到有效值。
2994
3048
  :type NFCRequestIds: list of str
2995
- :param _NFCBillingCounts: nfc重复计费计数
3049
+ :param _NFCBillingCounts: nfc重复计费计数。
2996
3050
  注意:此字段可能返回 null,表示取不到有效值。
2997
3051
  :type NFCBillingCounts: int
2998
- :param _PassNo: 港澳台居住证通行证号码
3052
+ :param _PassNo: 港澳台居住证通行证号码。
2999
3053
  注意:此字段可能返回 null,表示取不到有效值。
3000
3054
  :type PassNo: str
3001
- :param _VisaNum: 港澳台居住证签发次数
3055
+ :param _VisaNum: 港澳台居住证签发次数。
3002
3056
  注意:此字段可能返回 null,表示取不到有效值。
3003
3057
  :type VisaNum: str
3004
3058
  """
@@ -3035,7 +3089,9 @@ class DetectInfoText(AbstractModel):
3035
3089
 
3036
3090
  @property
3037
3091
  def ErrCode(self):
3038
- """本次流程最终验证结果。0为成功(仅包含活体人脸核身结果,不包含意愿核身结果)
3092
+ """本次流程最终验证结果。
3093
+ - 取值范围:0为成功。
3094
+ - 仅包含活体人脸核身结果,不包含意愿核身结果。
3039
3095
  注意:此字段可能返回 null,表示取不到有效值。
3040
3096
  :rtype: int
3041
3097
  """
@@ -3047,7 +3103,8 @@ class DetectInfoText(AbstractModel):
3047
3103
 
3048
3104
  @property
3049
3105
  def ErrMsg(self):
3050
- """本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
3106
+ """本次流程最终验证结果描述。
3107
+ - 仅描述用,文案更新时不会通知。
3051
3108
  注意:此字段可能返回 null,表示取不到有效值。
3052
3109
  :rtype: str
3053
3110
  """
@@ -3071,10 +3128,11 @@ class DetectInfoText(AbstractModel):
3071
3128
 
3072
3129
  @property
3073
3130
  def UseIDType(self):
3074
- """用户认证时使用的证件号码类型:
3075
- 0:二代身份证的证件号码
3076
- 1:港澳台居住证的证件号码
3077
- 2:其他(核验使用的证件号码非合法身份号码)
3131
+ """用户认证时使用的证件号码类型。
3132
+ - 取值范围:
3133
+ 0:二代身份证的证件号码。
3134
+ 1:港澳台居住证的证件号码。
3135
+ 2:其他(核验使用的证件号码非合法身份号码)。
3078
3136
  注意:此字段可能返回 null,表示取不到有效值。
3079
3137
  :rtype: int
3080
3138
  """
@@ -3122,7 +3180,8 @@ class DetectInfoText(AbstractModel):
3122
3180
 
3123
3181
  @property
3124
3182
  def OcrBirth(self):
3125
- """身份校验环节识别结果:生日。格式为:YYYY/M/D
3183
+ """身份校验环节识别结果:生日。
3184
+ - 格式为:YYYY/M/D
3126
3185
  注意:此字段可能返回 null,表示取不到有效值。
3127
3186
  :rtype: str
3128
3187
  """
@@ -3146,7 +3205,8 @@ class DetectInfoText(AbstractModel):
3146
3205
 
3147
3206
  @property
3148
3207
  def OcrValidDate(self):
3149
- """身份校验环节识别结果:有效日期。格式为:YYYY.MM.DD-YYYY.MM.DD
3208
+ """身份校验环节识别结果:有效日期。
3209
+ - 格式为:YYYY.MM.DD-YYYY.MM.DD。
3150
3210
  注意:此字段可能返回 null,表示取不到有效值。
3151
3211
  :rtype: str
3152
3212
  """
@@ -3195,7 +3255,7 @@ class DetectInfoText(AbstractModel):
3195
3255
  @property
3196
3256
  def IdInfoFrom(self):
3197
3257
  """身份校验环节采用的信息上传方式。
3198
- 取值有"NFC"、"OCR"、"手动输入"、"其他"
3258
+ - 取值有"NFC"、"OCR"、"手动输入"、"其他"
3199
3259
  注意:此字段可能返回 null,表示取不到有效值。
3200
3260
  :rtype: str
3201
3261
  """
@@ -3207,7 +3267,8 @@ class DetectInfoText(AbstractModel):
3207
3267
 
3208
3268
  @property
3209
3269
  def LiveStatus(self):
3210
- """本次流程最终活体结果。0为成功
3270
+ """本次流程最终活体结果。
3271
+ - 0为成功
3211
3272
  注意:此字段可能返回 null,表示取不到有效值。
3212
3273
  :rtype: int
3213
3274
  """
@@ -3219,7 +3280,8 @@ class DetectInfoText(AbstractModel):
3219
3280
 
3220
3281
  @property
3221
3282
  def LiveMsg(self):
3222
- """本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
3283
+ """本次流程最终活体结果描述。
3284
+ - 仅描述用,文案更新时不会通知。
3223
3285
  注意:此字段可能返回 null,表示取不到有效值。
3224
3286
  :rtype: str
3225
3287
  """
@@ -3231,7 +3293,8 @@ class DetectInfoText(AbstractModel):
3231
3293
 
3232
3294
  @property
3233
3295
  def Comparestatus(self):
3234
- """本次流程最终一比一结果。0为成功
3296
+ """本次流程最终一比一结果。
3297
+ - 0为成功
3235
3298
  注意:此字段可能返回 null,表示取不到有效值。
3236
3299
  :rtype: int
3237
3300
  """
@@ -3243,7 +3306,8 @@ class DetectInfoText(AbstractModel):
3243
3306
 
3244
3307
  @property
3245
3308
  def Comparemsg(self):
3246
- """本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
3309
+ """本次流程最终一比一结果描述。
3310
+ - 仅描述用,文案更新时不会通知。
3247
3311
  注意:此字段可能返回 null,表示取不到有效值。
3248
3312
  :rtype: str
3249
3313
  """
@@ -3255,7 +3319,10 @@ class DetectInfoText(AbstractModel):
3255
3319
 
3256
3320
  @property
3257
3321
  def Sim(self):
3258
- """本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
3322
+ """本次流程活体一比一的分数。
3323
+ - 取值范围 [0.00, 100.00]。
3324
+ - 相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值。
3325
+ - 阈值70的误通过率为千分之一,阈值80的误通过率是万分之一。
3259
3326
  注意:此字段可能返回 null,表示取不到有效值。
3260
3327
  :rtype: str
3261
3328
  """
@@ -3303,21 +3370,22 @@ class DetectInfoText(AbstractModel):
3303
3370
 
3304
3371
  @property
3305
3372
  def LivenessInfoTag(self):
3306
- """描述当前请求活体阶段被拒绝的详细原因,详情如下:
3307
- 01-用户全程闭眼
3308
- 02-用户未完成指定动作
3309
- 03-疑似翻拍攻击
3310
- 04-疑似合成攻击
3311
- 05-疑似黑产模版
3312
- 06-疑似存在水印
3313
- 07-反光校验未通过
3314
- 08-疑似中途换人
3315
- 09-人脸质量过差
3316
- 10-距离校验不通过
3317
- 11-疑似对抗样本攻击
3318
- 12-嘴巴区域疑似存在攻击痕迹
3319
- 13-眼睛区域疑似存在攻击痕迹
3320
- 14-眼睛或嘴巴被遮挡
3373
+ """描述当前请求活体阶段被拒绝的详细原因,该参数仅限PLUS版本核身服务返回。
3374
+ - 详情如下:
3375
+ 01-用户全程闭眼
3376
+ 02-用户未完成指定动作
3377
+ 03-疑似翻拍攻击
3378
+ 04-疑似合成攻击
3379
+ 05-疑似黑产模版
3380
+ 06-疑似存在水印
3381
+ 07-反光校验未通过
3382
+ 08-疑似中途换人
3383
+ 09-人脸质量过差
3384
+ 10-距离校验不通过
3385
+ 11-疑似对抗样本攻击
3386
+ 12-嘴巴区域疑似存在攻击痕迹
3387
+ 13-眼睛区域疑似存在攻击痕迹
3388
+ 14-眼睛或嘴巴被遮挡
3321
3389
  注意:此字段可能返回 null,表示取不到有效值。
3322
3390
  :rtype: list of str
3323
3391
  """
@@ -3341,11 +3409,12 @@ class DetectInfoText(AbstractModel):
3341
3409
 
3342
3410
  @property
3343
3411
  def CompareLibType(self):
3344
- """本次流程最终比对库源类型。包括:
3345
- 权威库;
3346
- 业务方自有库(用户上传照片、客户的混合库、混合部署库);
3347
- 二次验证库;
3348
- 人工审核库;
3412
+ """本次流程最终比对库源类型。
3413
+ - 取值范围:
3414
+ 权威库。
3415
+ 业务方自有库(用户上传照片、客户的混合库、混合部署库)。
3416
+ 二次验证库。
3417
+ 人工审核库。
3349
3418
  注意:此字段可能返回 null,表示取不到有效值。
3350
3419
  :rtype: str
3351
3420
  """
@@ -3357,12 +3426,13 @@ class DetectInfoText(AbstractModel):
3357
3426
 
3358
3427
  @property
3359
3428
  def LivenessMode(self):
3360
- """本次流程最终活体类型。包括:
3361
- 0:未知
3362
- 1:数字活体
3363
- 2:动作活体
3364
- 3:静默活体
3365
- 4:一闪活体(动作+光线)
3429
+ """本次流程最终活体类型。
3430
+ - 取值范围:
3431
+ 0:未知
3432
+ 1:数字活体
3433
+ 2:动作活体
3434
+ 3:静默活体
3435
+ 4:一闪活体(动作+光线)
3366
3436
  注意:此字段可能返回 null,表示取不到有效值。
3367
3437
  :rtype: int
3368
3438
  """
@@ -3374,7 +3444,7 @@ class DetectInfoText(AbstractModel):
3374
3444
 
3375
3445
  @property
3376
3446
  def NFCRequestIds(self):
3377
- """nfc重复计费requestId列表
3447
+ """nfc重复计费requestId列表。
3378
3448
  注意:此字段可能返回 null,表示取不到有效值。
3379
3449
  :rtype: list of str
3380
3450
  """
@@ -3386,7 +3456,7 @@ class DetectInfoText(AbstractModel):
3386
3456
 
3387
3457
  @property
3388
3458
  def NFCBillingCounts(self):
3389
- """nfc重复计费计数
3459
+ """nfc重复计费计数。
3390
3460
  注意:此字段可能返回 null,表示取不到有效值。
3391
3461
  :rtype: int
3392
3462
  """
@@ -3398,7 +3468,7 @@ class DetectInfoText(AbstractModel):
3398
3468
 
3399
3469
  @property
3400
3470
  def PassNo(self):
3401
- """港澳台居住证通行证号码
3471
+ """港澳台居住证通行证号码。
3402
3472
  注意:此字段可能返回 null,表示取不到有效值。
3403
3473
  :rtype: str
3404
3474
  """
@@ -3410,7 +3480,7 @@ class DetectInfoText(AbstractModel):
3410
3480
 
3411
3481
  @property
3412
3482
  def VisaNum(self):
3413
- """港澳台居住证签发次数
3483
+ """港澳台居住证签发次数。
3414
3484
  注意:此字段可能返回 null,表示取不到有效值。
3415
3485
  :rtype: str
3416
3486
  """
@@ -3468,13 +3538,13 @@ class DetectInfoText(AbstractModel):
3468
3538
 
3469
3539
 
3470
3540
  class DetectInfoVideoData(AbstractModel):
3471
- """核身视频信息
3541
+ """核身视频信息。
3472
3542
 
3473
3543
  """
3474
3544
 
3475
3545
  def __init__(self):
3476
3546
  r"""
3477
- :param _LivenessVideo: 活体视频的base64编码
3547
+ :param _LivenessVideo: 活体视频的base64编码。
3478
3548
  注意:此字段可能返回 null,表示取不到有效值。
3479
3549
  :type LivenessVideo: str
3480
3550
  """
@@ -3482,7 +3552,7 @@ class DetectInfoVideoData(AbstractModel):
3482
3552
 
3483
3553
  @property
3484
3554
  def LivenessVideo(self):
3485
- """活体视频的base64编码
3555
+ """活体视频的base64编码。
3486
3556
  注意:此字段可能返回 null,表示取不到有效值。
3487
3557
  :rtype: str
3488
3558
  """
@@ -3512,13 +3582,13 @@ class EidInfo(AbstractModel):
3512
3582
 
3513
3583
  def __init__(self):
3514
3584
  r"""
3515
- :param _EidCode: 商户方 appeIDcode 的数字证书
3585
+ :param _EidCode: 商户方 appeIDcode 的数字证书。
3516
3586
  :type EidCode: str
3517
- :param _EidSign: Eid中心针对商户方EidCode的电子签名
3587
+ :param _EidSign: Eid中心针对商户方EidCode的电子签名。
3518
3588
  :type EidSign: str
3519
- :param _DesKey: 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
3589
+ :param _DesKey: 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
3520
3590
  :type DesKey: str
3521
- :param _UserInfo: 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
3591
+ :param _UserInfo: 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
3522
3592
  :type UserInfo: str
3523
3593
  """
3524
3594
  self._EidCode = None
@@ -3528,7 +3598,7 @@ class EidInfo(AbstractModel):
3528
3598
 
3529
3599
  @property
3530
3600
  def EidCode(self):
3531
- """商户方 appeIDcode 的数字证书
3601
+ """商户方 appeIDcode 的数字证书。
3532
3602
  :rtype: str
3533
3603
  """
3534
3604
  return self._EidCode
@@ -3539,7 +3609,7 @@ class EidInfo(AbstractModel):
3539
3609
 
3540
3610
  @property
3541
3611
  def EidSign(self):
3542
- """Eid中心针对商户方EidCode的电子签名
3612
+ """Eid中心针对商户方EidCode的电子签名。
3543
3613
  :rtype: str
3544
3614
  """
3545
3615
  return self._EidSign
@@ -3550,7 +3620,7 @@ class EidInfo(AbstractModel):
3550
3620
 
3551
3621
  @property
3552
3622
  def DesKey(self):
3553
- """商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
3623
+ """商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
3554
3624
  :rtype: str
3555
3625
  """
3556
3626
  return self._DesKey
@@ -3561,7 +3631,7 @@ class EidInfo(AbstractModel):
3561
3631
 
3562
3632
  @property
3563
3633
  def UserInfo(self):
3564
- """会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
3634
+ """会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
3565
3635
  :rtype: str
3566
3636
  """
3567
3637
  return self._UserInfo
@@ -4011,21 +4081,31 @@ class GetDetectInfoEnhancedRequest(AbstractModel):
4011
4081
  :type BizToken: str
4012
4082
  :param _RuleId: 用于细分客户使用场景,由腾讯侧在线下对接时分配。
4013
4083
  :type RuleId: str
4014
- :param _InfoType: 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
4015
- 13表示拉取文本类、视频最佳截图信息。
4016
- 默认值:0
4084
+ :param _InfoType: 指定拉取的结果信息。
4085
+ - 取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
4086
+ - 例如 13 表示拉取文本类、视频最佳截图信息。
4087
+ - 默认值:0
4017
4088
  :type InfoType: str
4018
- :param _BestFramesCount: 从活体视频中截取一定张数的最佳帧(仅部分服务支持,若需使用请与慧眼小助手沟通)。默认为0,最大为10,超出10的最多只给10张。(InfoType需要包含3)
4089
+ :param _BestFramesCount: 从活体视频中截取一定张数的最佳帧。
4090
+ - 仅部分服务支持,若需使用请与慧眼小助手沟通。
4091
+ - 默认值为0,最大值为10,超出10的最多只给10张。
4092
+ - InfoType需要包含3。
4019
4093
  :type BestFramesCount: int
4020
- :param _IsCutIdCardImage: 是否对身份证照片进行裁边。默认为false。(InfoType需要包含2)
4094
+ :param _IsCutIdCardImage: 是否对身份证照片进行裁边。
4095
+ - 默认为false。
4096
+ - InfoType需要包含2。
4021
4097
  :type IsCutIdCardImage: bool
4022
- :param _IsNeedIdCardAvatar: 是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2)
4098
+ :param _IsNeedIdCardAvatar: 是否需要从身份证中抠出头像。
4099
+ - 默认为false。
4100
+ - InfoType需要包含2。
4023
4101
  :type IsNeedIdCardAvatar: bool
4024
4102
  :param _IsEncrypt: 已弃用。
4025
4103
  :type IsEncrypt: bool
4026
- :param _Encryption: 是否需要对返回中的敏感信息进行加密。仅指定加密算法Algorithm即可,其余字段传入默认值。其中敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName
4104
+ :param _Encryption: 是否需要对返回中的敏感信息进行加密。
4105
+ - 只需指定加密算法Algorithm即可,其余字段传入默认值。
4106
+ - 敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
4027
4107
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
4028
- :param _IsEncryptResponse: 是否对回包整体进行加密
4108
+ :param _IsEncryptResponse: 是否对回包整体进行加密。
4029
4109
  :type IsEncryptResponse: bool
4030
4110
  """
4031
4111
  self._BizToken = None
@@ -4062,9 +4142,10 @@ class GetDetectInfoEnhancedRequest(AbstractModel):
4062
4142
 
4063
4143
  @property
4064
4144
  def InfoType(self):
4065
- """指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
4066
- 13表示拉取文本类、视频最佳截图信息。
4067
- 默认值:0
4145
+ """指定拉取的结果信息。
4146
+ - 取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。
4147
+ - 例如 13 表示拉取文本类、视频最佳截图信息。
4148
+ - 默认值:0
4068
4149
  :rtype: str
4069
4150
  """
4070
4151
  return self._InfoType
@@ -4075,7 +4156,10 @@ class GetDetectInfoEnhancedRequest(AbstractModel):
4075
4156
 
4076
4157
  @property
4077
4158
  def BestFramesCount(self):
4078
- """从活体视频中截取一定张数的最佳帧(仅部分服务支持,若需使用请与慧眼小助手沟通)。默认为0,最大为10,超出10的最多只给10张。(InfoType需要包含3)
4159
+ """从活体视频中截取一定张数的最佳帧。
4160
+ - 仅部分服务支持,若需使用请与慧眼小助手沟通。
4161
+ - 默认值为0,最大值为10,超出10的最多只给10张。
4162
+ - InfoType需要包含3。
4079
4163
  :rtype: int
4080
4164
  """
4081
4165
  return self._BestFramesCount
@@ -4086,7 +4170,9 @@ class GetDetectInfoEnhancedRequest(AbstractModel):
4086
4170
 
4087
4171
  @property
4088
4172
  def IsCutIdCardImage(self):
4089
- """是否对身份证照片进行裁边。默认为false。(InfoType需要包含2)
4173
+ """是否对身份证照片进行裁边。
4174
+ - 默认为false。
4175
+ - InfoType需要包含2。
4090
4176
  :rtype: bool
4091
4177
  """
4092
4178
  return self._IsCutIdCardImage
@@ -4097,7 +4183,9 @@ class GetDetectInfoEnhancedRequest(AbstractModel):
4097
4183
 
4098
4184
  @property
4099
4185
  def IsNeedIdCardAvatar(self):
4100
- """是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2)
4186
+ """是否需要从身份证中抠出头像。
4187
+ - 默认为false。
4188
+ - InfoType需要包含2。
4101
4189
  :rtype: bool
4102
4190
  """
4103
4191
  return self._IsNeedIdCardAvatar
@@ -4119,7 +4207,9 @@ class GetDetectInfoEnhancedRequest(AbstractModel):
4119
4207
 
4120
4208
  @property
4121
4209
  def Encryption(self):
4122
- """是否需要对返回中的敏感信息进行加密。仅指定加密算法Algorithm即可,其余字段传入默认值。其中敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName
4210
+ """是否需要对返回中的敏感信息进行加密。
4211
+ - 只需指定加密算法Algorithm即可,其余字段传入默认值。
4212
+ - 敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。
4123
4213
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
4124
4214
  """
4125
4215
  return self._Encryption
@@ -4130,7 +4220,7 @@ class GetDetectInfoEnhancedRequest(AbstractModel):
4130
4220
 
4131
4221
  @property
4132
4222
  def IsEncryptResponse(self):
4133
- """是否对回包整体进行加密
4223
+ """是否对回包整体进行加密。
4134
4224
  :rtype: bool
4135
4225
  """
4136
4226
  return self._IsEncryptResponse
@@ -4184,16 +4274,20 @@ class GetDetectInfoEnhancedResponse(AbstractModel):
4184
4274
  :param _Encryption: 敏感数据加密信息。
4185
4275
  注意:此字段可能返回 null,表示取不到有效值。
4186
4276
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
4187
- :param _IntentionVerifyData: 意愿核身朗读模式结果信息。若未使用意愿核身功能,该字段返回值可以不处理。
4277
+ :param _IntentionVerifyData: 意愿核身朗读模式结果信息。
4278
+ - 若未使用意愿核身功能,该字段返回值可以不处理。
4188
4279
  注意:此字段可能返回 null,表示取不到有效值。
4189
4280
  :type IntentionVerifyData: :class:`tencentcloud.faceid.v20180301.models.IntentionVerifyData`
4190
- :param _IntentionQuestionResult: 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
4281
+ :param _IntentionQuestionResult: 意愿核身问答模式结果。
4282
+
4283
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
4191
4284
  注意:此字段可能返回 null,表示取不到有效值。
4192
4285
  :type IntentionQuestionResult: :class:`tencentcloud.faceid.v20180301.models.IntentionQuestionResult`
4193
- :param _IntentionActionResult: 意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
4286
+ :param _IntentionActionResult: 意愿核身点头确认模式的结果信息。
4287
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
4194
4288
  注意:此字段可能返回 null,表示取不到有效值。
4195
4289
  :type IntentionActionResult: :class:`tencentcloud.faceid.v20180301.models.IntentionActionResult`
4196
- :param _EncryptedBody: 加密后的数据
4290
+ :param _EncryptedBody: 加密后的数据。
4197
4291
  注意:此字段可能返回 null,表示取不到有效值。
4198
4292
  :type EncryptedBody: str
4199
4293
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -4272,7 +4366,8 @@ class GetDetectInfoEnhancedResponse(AbstractModel):
4272
4366
 
4273
4367
  @property
4274
4368
  def IntentionVerifyData(self):
4275
- """意愿核身朗读模式结果信息。若未使用意愿核身功能,该字段返回值可以不处理。
4369
+ """意愿核身朗读模式结果信息。
4370
+ - 若未使用意愿核身功能,该字段返回值可以不处理。
4276
4371
  注意:此字段可能返回 null,表示取不到有效值。
4277
4372
  :rtype: :class:`tencentcloud.faceid.v20180301.models.IntentionVerifyData`
4278
4373
  """
@@ -4284,7 +4379,9 @@ class GetDetectInfoEnhancedResponse(AbstractModel):
4284
4379
 
4285
4380
  @property
4286
4381
  def IntentionQuestionResult(self):
4287
- """意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
4382
+ """意愿核身问答模式结果。
4383
+
4384
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
4288
4385
  注意:此字段可能返回 null,表示取不到有效值。
4289
4386
  :rtype: :class:`tencentcloud.faceid.v20180301.models.IntentionQuestionResult`
4290
4387
  """
@@ -4296,7 +4393,8 @@ class GetDetectInfoEnhancedResponse(AbstractModel):
4296
4393
 
4297
4394
  @property
4298
4395
  def IntentionActionResult(self):
4299
- """意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
4396
+ """意愿核身点头确认模式的结果信息。
4397
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
4300
4398
  注意:此字段可能返回 null,表示取不到有效值。
4301
4399
  :rtype: :class:`tencentcloud.faceid.v20180301.models.IntentionActionResult`
4302
4400
  """
@@ -4308,7 +4406,7 @@ class GetDetectInfoEnhancedResponse(AbstractModel):
4308
4406
 
4309
4407
  @property
4310
4408
  def EncryptedBody(self):
4311
- """加密后的数据
4409
+ """加密后的数据。
4312
4410
  注意:此字段可能返回 null,表示取不到有效值。
4313
4411
  :rtype: str
4314
4412
  """
@@ -4577,15 +4675,28 @@ class GetEidResultRequest(AbstractModel):
4577
4675
  r"""
4578
4676
  :param _EidToken: E证通流程的唯一标识,调用GetEidToken接口时生成。
4579
4677
  :type EidToken: str
4580
- :param _InfoType: 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:最佳截图信息;5:意愿核身朗读模式相关结果;6:意愿核身问答模式相关结果)。
4581
- 13表示拉取文本类、最佳截图信息。
4582
- 默认值:0
4678
+ :param _InfoType: 指定拉取的结果信息。
4679
+ - 取值范围:
4680
+ 0:全部。
4681
+ 1:文本类。
4682
+ 2:身份证信息。
4683
+ 3:最佳截图信息。
4684
+ 5:意愿核身朗读模式相关结果。
4685
+ 6:意愿核身问答模式相关结果。
4686
+ - 例如 13表示拉取文本类、最佳截图信息。
4687
+ - 默认值:0
4583
4688
  :type InfoType: str
4584
- :param _BestFramesCount: 从活体视频中截取一定张数的最佳帧。默认为0,最大为3,超出3的最多只给3张。(InfoType需要包含3)
4689
+ :param _BestFramesCount: 从活体视频中截取一定张数的最佳帧。
4690
+ - 默认为0,最大为3,超出3的最多只给3张。
4691
+ - InfoType需要包含3。
4585
4692
  :type BestFramesCount: int
4586
- :param _IsCutIdCardImage: 是否对身份证照片进行裁边。默认为false。(InfoType需要包含2)
4693
+ :param _IsCutIdCardImage: 是否对身份证照片进行裁边。
4694
+ - 默认为false。
4695
+ - InfoType需要包含2。
4587
4696
  :type IsCutIdCardImage: bool
4588
- :param _IsNeedIdCardAvatar: 是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2)
4697
+ :param _IsNeedIdCardAvatar: 是否需要从身份证中抠出头像。
4698
+ - 默认为false。
4699
+ - InfoType需要包含2。
4589
4700
  :type IsNeedIdCardAvatar: bool
4590
4701
  """
4591
4702
  self._EidToken = None
@@ -4607,9 +4718,16 @@ class GetEidResultRequest(AbstractModel):
4607
4718
 
4608
4719
  @property
4609
4720
  def InfoType(self):
4610
- """指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证信息;3:最佳截图信息;5:意愿核身朗读模式相关结果;6:意愿核身问答模式相关结果)。
4611
- 13表示拉取文本类、最佳截图信息。
4612
- 默认值:0
4721
+ """指定拉取的结果信息。
4722
+ - 取值范围:
4723
+ 0:全部。
4724
+ 1:文本类。
4725
+ 2:身份证信息。
4726
+ 3:最佳截图信息。
4727
+ 5:意愿核身朗读模式相关结果。
4728
+ 6:意愿核身问答模式相关结果。
4729
+ - 例如 13表示拉取文本类、最佳截图信息。
4730
+ - 默认值:0
4613
4731
  :rtype: str
4614
4732
  """
4615
4733
  return self._InfoType
@@ -4620,7 +4738,9 @@ class GetEidResultRequest(AbstractModel):
4620
4738
 
4621
4739
  @property
4622
4740
  def BestFramesCount(self):
4623
- """从活体视频中截取一定张数的最佳帧。默认为0,最大为3,超出3的最多只给3张。(InfoType需要包含3)
4741
+ """从活体视频中截取一定张数的最佳帧。
4742
+ - 默认为0,最大为3,超出3的最多只给3张。
4743
+ - InfoType需要包含3。
4624
4744
  :rtype: int
4625
4745
  """
4626
4746
  return self._BestFramesCount
@@ -4631,7 +4751,9 @@ class GetEidResultRequest(AbstractModel):
4631
4751
 
4632
4752
  @property
4633
4753
  def IsCutIdCardImage(self):
4634
- """是否对身份证照片进行裁边。默认为false。(InfoType需要包含2)
4754
+ """是否对身份证照片进行裁边。
4755
+ - 默认为false。
4756
+ - InfoType需要包含2。
4635
4757
  :rtype: bool
4636
4758
  """
4637
4759
  return self._IsCutIdCardImage
@@ -4642,7 +4764,9 @@ class GetEidResultRequest(AbstractModel):
4642
4764
 
4643
4765
  @property
4644
4766
  def IsNeedIdCardAvatar(self):
4645
- """是否需要从身份证中抠出头像。默认为false。(InfoType需要包含2)
4767
+ """是否需要从身份证中抠出头像。
4768
+ - 默认为false。
4769
+ - InfoType需要包含2。
4646
4770
  :rtype: bool
4647
4771
  """
4648
4772
  return self._IsNeedIdCardAvatar
@@ -4675,7 +4799,9 @@ class GetEidResultResponse(AbstractModel):
4675
4799
 
4676
4800
  def __init__(self):
4677
4801
  r"""
4678
- :param _Text: 文本类信息。(基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从Eidinfo参数中返回,如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
4802
+ :param _Text: 文本类信息。
4803
+ - 基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从EidInfo参数中返回。
4804
+ - 如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)。
4679
4805
  注意:此字段可能返回 null,表示取不到有效值。
4680
4806
  :type Text: :class:`tencentcloud.faceid.v20180301.models.DetectInfoText`
4681
4807
  :param _IdCardData: 身份证照片信息。
@@ -4684,16 +4810,21 @@ class GetEidResultResponse(AbstractModel):
4684
4810
  :param _BestFrame: 最佳帧信息。
4685
4811
  注意:此字段可能返回 null,表示取不到有效值。
4686
4812
  :type BestFrame: :class:`tencentcloud.faceid.v20180301.models.DetectInfoBestFrame`
4687
- :param _EidInfo: Eid信息。(包括商户下用户唯一标识以及加密后的姓名、身份证号信息。解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
4813
+ :param _EidInfo: Eid信息。
4814
+ - 包括商户下用户唯一标识以及加密后的姓名、身份证号信息。
4815
+ - 解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)
4688
4816
  注意:此字段可能返回 null,表示取不到有效值。
4689
4817
  :type EidInfo: :class:`tencentcloud.faceid.v20180301.models.EidInfo`
4690
- :param _IntentionVerifyData: 意愿核身朗读模式相关信息。若未使用意愿核身朗读功能,该字段返回值可以不处理。
4818
+ :param _IntentionVerifyData: 意愿核身朗读模式相关信息。
4819
+ - 若未使用意愿核身朗读功能,该字段返回值可以不处理。
4691
4820
  注意:此字段可能返回 null,表示取不到有效值。
4692
4821
  :type IntentionVerifyData: :class:`tencentcloud.faceid.v20180301.models.IntentionVerifyData`
4693
- :param _IntentionQuestionResult: 意愿核身问答模式相关信息。若未使用意愿核身问答模式功能,该字段返回值可以不处理。
4822
+ :param _IntentionQuestionResult: 意愿核身问答模式相关信息。
4823
+ - 若未使用意愿核身问答模式功能,该字段返回值可以不处理。
4694
4824
  注意:此字段可能返回 null,表示取不到有效值。
4695
4825
  :type IntentionQuestionResult: :class:`tencentcloud.faceid.v20180301.models.IntentionQuestionResult`
4696
- :param _IntentionActionResult: 意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
4826
+ :param _IntentionActionResult: 意愿核身点头确认模式的结果信息。
4827
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
4697
4828
  注意:此字段可能返回 null,表示取不到有效值。
4698
4829
  :type IntentionActionResult: :class:`tencentcloud.faceid.v20180301.models.IntentionActionResult`
4699
4830
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -4710,7 +4841,9 @@ class GetEidResultResponse(AbstractModel):
4710
4841
 
4711
4842
  @property
4712
4843
  def Text(self):
4713
- """文本类信息。(基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从Eidinfo参数中返回,如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
4844
+ """文本类信息。
4845
+ - 基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从EidInfo参数中返回。
4846
+ - 如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)。
4714
4847
  注意:此字段可能返回 null,表示取不到有效值。
4715
4848
  :rtype: :class:`tencentcloud.faceid.v20180301.models.DetectInfoText`
4716
4849
  """
@@ -4746,7 +4879,9 @@ class GetEidResultResponse(AbstractModel):
4746
4879
 
4747
4880
  @property
4748
4881
  def EidInfo(self):
4749
- """Eid信息。(包括商户下用户唯一标识以及加密后的姓名、身份证号信息。解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
4882
+ """Eid信息。
4883
+ - 包括商户下用户唯一标识以及加密后的姓名、身份证号信息。
4884
+ - 解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370)
4750
4885
  注意:此字段可能返回 null,表示取不到有效值。
4751
4886
  :rtype: :class:`tencentcloud.faceid.v20180301.models.EidInfo`
4752
4887
  """
@@ -4758,7 +4893,8 @@ class GetEidResultResponse(AbstractModel):
4758
4893
 
4759
4894
  @property
4760
4895
  def IntentionVerifyData(self):
4761
- """意愿核身朗读模式相关信息。若未使用意愿核身朗读功能,该字段返回值可以不处理。
4896
+ """意愿核身朗读模式相关信息。
4897
+ - 若未使用意愿核身朗读功能,该字段返回值可以不处理。
4762
4898
  注意:此字段可能返回 null,表示取不到有效值。
4763
4899
  :rtype: :class:`tencentcloud.faceid.v20180301.models.IntentionVerifyData`
4764
4900
  """
@@ -4770,7 +4906,8 @@ class GetEidResultResponse(AbstractModel):
4770
4906
 
4771
4907
  @property
4772
4908
  def IntentionQuestionResult(self):
4773
- """意愿核身问答模式相关信息。若未使用意愿核身问答模式功能,该字段返回值可以不处理。
4909
+ """意愿核身问答模式相关信息。
4910
+ - 若未使用意愿核身问答模式功能,该字段返回值可以不处理。
4774
4911
  注意:此字段可能返回 null,表示取不到有效值。
4775
4912
  :rtype: :class:`tencentcloud.faceid.v20180301.models.IntentionQuestionResult`
4776
4913
  """
@@ -4782,7 +4919,8 @@ class GetEidResultResponse(AbstractModel):
4782
4919
 
4783
4920
  @property
4784
4921
  def IntentionActionResult(self):
4785
- """意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
4922
+ """意愿核身点头确认模式的结果信息。
4923
+ - 若未使用该意愿核身功能,该字段返回值可以不处理。
4786
4924
  注意:此字段可能返回 null,表示取不到有效值。
4787
4925
  :rtype: :class:`tencentcloud.faceid.v20180301.models.IntentionActionResult`
4788
4926
  """
@@ -4837,30 +4975,55 @@ class GetEidTokenConfig(AbstractModel):
4837
4975
  def __init__(self):
4838
4976
  r"""
4839
4977
  :param _InputType: 姓名身份证输入方式。
4840
- 1:传身份证正反面OCR
4841
- 2:传身份证正面OCR
4842
- 3:用户手动输入
4843
- 4:客户后台传入
4844
- 默认1
4845
- 注:使用OCR时仅支持用户修改结果中的姓名
4978
+ - 取值范围:
4979
+ 1:传身份证正反面OCR
4980
+ 2:传身份证正面OCR。
4981
+ 3:用户手动输入。
4982
+ 4:客户后台传入。
4983
+ - 默认值:1。
4984
+ - 注意:使用OCR时仅支持用户修改结果中的姓名。
4846
4985
  :type InputType: str
4847
- :param _UseIntentionVerify: 是否使用意愿核身,默认不使用。注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
4986
+ :param _UseIntentionVerify: 是否使用意愿核身。
4987
+
4988
+ - 默认不使用。
4989
+ - 注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
4848
4990
  :type UseIntentionVerify: bool
4849
- :param _IntentionMode: 意愿核身模式。枚举值:1( 语音朗读模式),2(语音问答模式) ,3(点头确认模式)。默认值为1。
4991
+ :param _IntentionMode: 意愿核身模式。
4992
+ - 取值范围:
4993
+ 1:语音朗读模式。
4994
+ 2:语音问答模式。
4995
+ 3:点头确认模式。
4996
+ - 默认值为1。
4850
4997
  :type IntentionMode: str
4851
- :param _IntentionVerifyText: 意愿核身朗读模式使用的文案,若未使用意愿核身朗读功能,该字段无需传入。默认为空,最长可接受120的字符串长度。
4998
+ :param _IntentionVerifyText: 意愿核身朗读模式使用的文案。
4999
+ - 若未使用意愿核身朗读功能,该字段无需传入。
5000
+ - 默认为空,最长可接受120的字符串长度。
4852
5001
  :type IntentionVerifyText: str
4853
- :param _IntentionQuestions: 意愿核身问答模式的配置列表。当前仅支持一个问答。
5002
+ :param _IntentionQuestions: 意愿核身问答模式的配置列表。
5003
+ - 当前仅支持一个问答。
4854
5004
  :type IntentionQuestions: list of IntentionQuestion
4855
- :param _IntentionActions: 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。默认为空,最长可接受150的字符串长度。
5005
+ :param _IntentionActions: 意愿核身(点头确认模式)使用的文案。
5006
+ - 若未使用意愿核身(点头确认模式),则该字段无需传入。
5007
+ - 默认为空,最长可接受150的字符串长度。
4856
5008
  :type IntentionActions: list of IntentionActionConfig
4857
- :param _IntentionRecognition: 意愿核身过程中识别用户的回答意图,开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过,默认开启。
5009
+ :param _IntentionRecognition: 意愿核身过程中识别用户的回答意图。
5010
+ - 开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过。
5011
+ - 默认开启。
4858
5012
  :type IntentionRecognition: bool
4859
- :param _IsSupportHMTResidentPermitOCR: 是否支持港澳台居住证识别
5013
+ :param _IsSupportHMTResidentPermitOCR: 是否支持港澳台居住证识别。
4860
5014
  :type IsSupportHMTResidentPermitOCR: bool
4861
- :param _MouthOpenRecognition: 用户语音回答过程中是否开启张嘴识别检测,默认不开启,仅在意愿核身问答模式中使用。
5015
+ :param _MouthOpenRecognition: 用户语音回答过程中是否开启张嘴识别检测。
5016
+ - 默认不开启。
5017
+ - 仅在意愿核身问答模式中使用。
4862
5018
  :type MouthOpenRecognition: bool
4863
- :param _Speed: 意愿核身语音播报速度,配置后问答模式和点头模式的语音播报环节都会生效,默认值为0: 0:智能语速(根据播报文案的长度自动调整语音播报速度) 1:固定1倍速 2:固定1.2倍速 3:固定1.5倍速
5019
+ :param _Speed: 意愿核身语音播报速度。
5020
+ - 配置后问答模式和点头模式的语音播报环节都会生效。
5021
+ - 默认值为0。
5022
+ - 取值范围:
5023
+ 0:智能语速(根据播报文案的长度自动调整语音播报速度)。
5024
+ 1:固定1倍速。
5025
+ 2:固定1.2倍速。
5026
+ 3:固定1.5倍速。
4864
5027
  :type Speed: int
4865
5028
  """
4866
5029
  self._InputType = None
@@ -4877,12 +5040,13 @@ class GetEidTokenConfig(AbstractModel):
4877
5040
  @property
4878
5041
  def InputType(self):
4879
5042
  """姓名身份证输入方式。
4880
- 1:传身份证正反面OCR
4881
- 2:传身份证正面OCR
4882
- 3:用户手动输入
4883
- 4:客户后台传入
4884
- 默认1
4885
- 注:使用OCR时仅支持用户修改结果中的姓名
5043
+ - 取值范围:
5044
+ 1:传身份证正反面OCR
5045
+ 2:传身份证正面OCR。
5046
+ 3:用户手动输入。
5047
+ 4:客户后台传入。
5048
+ - 默认值:1。
5049
+ - 注意:使用OCR时仅支持用户修改结果中的姓名。
4886
5050
  :rtype: str
4887
5051
  """
4888
5052
  return self._InputType
@@ -4893,7 +5057,10 @@ class GetEidTokenConfig(AbstractModel):
4893
5057
 
4894
5058
  @property
4895
5059
  def UseIntentionVerify(self):
4896
- """是否使用意愿核身,默认不使用。注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
5060
+ """是否使用意愿核身。
5061
+
5062
+ - 默认不使用。
5063
+ - 注意:如开启使用,则计费标签按【意愿核身】计费标签计价;如不开启,则计费标签按【E证通】计费标签计价,价格详见:[价格说明](https://cloud.tencent.com/document/product/1007/56804)。
4897
5064
  :rtype: bool
4898
5065
  """
4899
5066
  return self._UseIntentionVerify
@@ -4904,7 +5071,12 @@ class GetEidTokenConfig(AbstractModel):
4904
5071
 
4905
5072
  @property
4906
5073
  def IntentionMode(self):
4907
- """意愿核身模式。枚举值:1( 语音朗读模式),2(语音问答模式) ,3(点头确认模式)。默认值为1。
5074
+ """意愿核身模式。
5075
+ - 取值范围:
5076
+ 1:语音朗读模式。
5077
+ 2:语音问答模式。
5078
+ 3:点头确认模式。
5079
+ - 默认值为1。
4908
5080
  :rtype: str
4909
5081
  """
4910
5082
  return self._IntentionMode
@@ -4915,7 +5087,9 @@ class GetEidTokenConfig(AbstractModel):
4915
5087
 
4916
5088
  @property
4917
5089
  def IntentionVerifyText(self):
4918
- """意愿核身朗读模式使用的文案,若未使用意愿核身朗读功能,该字段无需传入。默认为空,最长可接受120的字符串长度。
5090
+ """意愿核身朗读模式使用的文案。
5091
+ - 若未使用意愿核身朗读功能,该字段无需传入。
5092
+ - 默认为空,最长可接受120的字符串长度。
4919
5093
  :rtype: str
4920
5094
  """
4921
5095
  return self._IntentionVerifyText
@@ -4926,7 +5100,8 @@ class GetEidTokenConfig(AbstractModel):
4926
5100
 
4927
5101
  @property
4928
5102
  def IntentionQuestions(self):
4929
- """意愿核身问答模式的配置列表。当前仅支持一个问答。
5103
+ """意愿核身问答模式的配置列表。
5104
+ - 当前仅支持一个问答。
4930
5105
  :rtype: list of IntentionQuestion
4931
5106
  """
4932
5107
  return self._IntentionQuestions
@@ -4937,7 +5112,9 @@ class GetEidTokenConfig(AbstractModel):
4937
5112
 
4938
5113
  @property
4939
5114
  def IntentionActions(self):
4940
- """意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。默认为空,最长可接受150的字符串长度。
5115
+ """意愿核身(点头确认模式)使用的文案。
5116
+ - 若未使用意愿核身(点头确认模式),则该字段无需传入。
5117
+ - 默认为空,最长可接受150的字符串长度。
4941
5118
  :rtype: list of IntentionActionConfig
4942
5119
  """
4943
5120
  return self._IntentionActions
@@ -4948,7 +5125,9 @@ class GetEidTokenConfig(AbstractModel):
4948
5125
 
4949
5126
  @property
4950
5127
  def IntentionRecognition(self):
4951
- """意愿核身过程中识别用户的回答意图,开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过,默认开启。
5128
+ """意愿核身过程中识别用户的回答意图。
5129
+ - 开启后除了IntentionQuestions的Answers列表中的标准回答会通过,近似意图的回答也会通过。
5130
+ - 默认开启。
4952
5131
  :rtype: bool
4953
5132
  """
4954
5133
  return self._IntentionRecognition
@@ -4959,7 +5138,7 @@ class GetEidTokenConfig(AbstractModel):
4959
5138
 
4960
5139
  @property
4961
5140
  def IsSupportHMTResidentPermitOCR(self):
4962
- """是否支持港澳台居住证识别
5141
+ """是否支持港澳台居住证识别。
4963
5142
  :rtype: bool
4964
5143
  """
4965
5144
  return self._IsSupportHMTResidentPermitOCR
@@ -4970,7 +5149,9 @@ class GetEidTokenConfig(AbstractModel):
4970
5149
 
4971
5150
  @property
4972
5151
  def MouthOpenRecognition(self):
4973
- """用户语音回答过程中是否开启张嘴识别检测,默认不开启,仅在意愿核身问答模式中使用。
5152
+ """用户语音回答过程中是否开启张嘴识别检测。
5153
+ - 默认不开启。
5154
+ - 仅在意愿核身问答模式中使用。
4974
5155
  :rtype: bool
4975
5156
  """
4976
5157
  return self._MouthOpenRecognition
@@ -4981,7 +5162,14 @@ class GetEidTokenConfig(AbstractModel):
4981
5162
 
4982
5163
  @property
4983
5164
  def Speed(self):
4984
- """意愿核身语音播报速度,配置后问答模式和点头模式的语音播报环节都会生效,默认值为0: 0:智能语速(根据播报文案的长度自动调整语音播报速度) 1:固定1倍速 2:固定1.2倍速 3:固定1.5倍速
5165
+ """意愿核身语音播报速度。
5166
+ - 配置后问答模式和点头模式的语音播报环节都会生效。
5167
+ - 默认值为0。
5168
+ - 取值范围:
5169
+ 0:智能语速(根据播报文案的长度自动调整语音播报速度)。
5170
+ 1:固定1倍速。
5171
+ 2:固定1.2倍速。
5172
+ 3:固定1.5倍速。
4985
5173
  :rtype: int
4986
5174
  """
4987
5175
  return self._Speed
@@ -5029,20 +5217,30 @@ class GetEidTokenRequest(AbstractModel):
5029
5217
 
5030
5218
  def __init__(self):
5031
5219
  r"""
5032
- :param _MerchantId: EID商户id,字段长度最长50位。
5220
+ :param _MerchantId: EID商户id
5221
+ - 字段长度最长50位。
5033
5222
  :type MerchantId: str
5034
- :param _IdCard: 身份标识(未使用OCR服务时,必须传入)。
5035
- 规则:a-z,A-Z,0-9组合。最长长度32位。
5223
+ :param _IdCard: 身份标识。
5224
+ - 未使用OCR服务时,必须传入。
5225
+ - 规则:a-z,A-Z,0-9组合。
5226
+ - 最长长度32位。
5036
5227
  :type IdCard: str
5037
- :param _Name: 姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。
5228
+ :param _Name: 姓名。
5229
+ - 未使用OCR服务时,必须传入。
5230
+ - 最长长度32位。
5231
+ - 中文请使用UTF-8编码。
5038
5232
  :type Name: str
5039
- :param _Extra: 透传字段,在获取验证结果时返回。最长长度1024位。
5233
+ :param _Extra: 透传字段,在获取验证结果时返回。
5234
+ - 最长长度1024位。
5040
5235
  :type Extra: str
5041
5236
  :param _Config: 小程序模式配置,包括如何传入姓名身份证的配置,以及是否使用意愿核身。
5042
5237
  :type Config: :class:`tencentcloud.faceid.v20180301.models.GetEidTokenConfig`
5043
- :param _RedirectUrl: 最长长度1024位。用户从Url中进入核身认证结束后重定向的回调链接地址。EidToken会在该链接的query参数中。
5238
+ :param _RedirectUrl: 用户从Url中进入核身认证结束后重定向的回调链接地址。
5239
+ - 最长长度1024位。
5240
+ - EidToken会在该链接的query参数中。
5044
5241
  :type RedirectUrl: str
5045
- :param _Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
5242
+ :param _Encryption: 敏感数据加密信息。
5243
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
5046
5244
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5047
5245
  """
5048
5246
  self._MerchantId = None
@@ -5055,7 +5253,8 @@ class GetEidTokenRequest(AbstractModel):
5055
5253
 
5056
5254
  @property
5057
5255
  def MerchantId(self):
5058
- """EID商户id,字段长度最长50位。
5256
+ """EID商户id
5257
+ - 字段长度最长50位。
5059
5258
  :rtype: str
5060
5259
  """
5061
5260
  return self._MerchantId
@@ -5066,8 +5265,10 @@ class GetEidTokenRequest(AbstractModel):
5066
5265
 
5067
5266
  @property
5068
5267
  def IdCard(self):
5069
- """身份标识(未使用OCR服务时,必须传入)。
5070
- 规则:a-z,A-Z,0-9组合。最长长度32位。
5268
+ """身份标识。
5269
+ - 未使用OCR服务时,必须传入。
5270
+ - 规则:a-z,A-Z,0-9组合。
5271
+ - 最长长度32位。
5071
5272
  :rtype: str
5072
5273
  """
5073
5274
  return self._IdCard
@@ -5078,7 +5279,10 @@ class GetEidTokenRequest(AbstractModel):
5078
5279
 
5079
5280
  @property
5080
5281
  def Name(self):
5081
- """姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。
5282
+ """姓名。
5283
+ - 未使用OCR服务时,必须传入。
5284
+ - 最长长度32位。
5285
+ - 中文请使用UTF-8编码。
5082
5286
  :rtype: str
5083
5287
  """
5084
5288
  return self._Name
@@ -5089,7 +5293,8 @@ class GetEidTokenRequest(AbstractModel):
5089
5293
 
5090
5294
  @property
5091
5295
  def Extra(self):
5092
- """透传字段,在获取验证结果时返回。最长长度1024位。
5296
+ """透传字段,在获取验证结果时返回。
5297
+ - 最长长度1024位。
5093
5298
  :rtype: str
5094
5299
  """
5095
5300
  return self._Extra
@@ -5111,7 +5316,9 @@ class GetEidTokenRequest(AbstractModel):
5111
5316
 
5112
5317
  @property
5113
5318
  def RedirectUrl(self):
5114
- """最长长度1024位。用户从Url中进入核身认证结束后重定向的回调链接地址。EidToken会在该链接的query参数中。
5319
+ """用户从Url中进入核身认证结束后重定向的回调链接地址。
5320
+ - 最长长度1024位。
5321
+ - EidToken会在该链接的query参数中。
5115
5322
  :rtype: str
5116
5323
  """
5117
5324
  return self._RedirectUrl
@@ -5122,7 +5329,8 @@ class GetEidTokenRequest(AbstractModel):
5122
5329
 
5123
5330
  @property
5124
5331
  def Encryption(self):
5125
- """敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
5332
+ """敏感数据加密信息。
5333
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
5126
5334
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5127
5335
  """
5128
5336
  return self._Encryption
@@ -5161,10 +5369,12 @@ class GetEidTokenResponse(AbstractModel):
5161
5369
 
5162
5370
  def __init__(self):
5163
5371
  r"""
5164
- :param _EidToken: 一次核身流程的标识,有效时间为600秒;
5165
- 完成核身后,可用该标识获取验证结果信息。
5372
+ :param _EidToken: 一次核身流程的标识。
5373
+ - 有效时间为600秒。
5374
+ - 完成核身后,可用该标识获取验证结果信息。
5166
5375
  :type EidToken: str
5167
- :param _Url: 发起核身流程的URL,用于H5场景核身。
5376
+ :param _Url: 发起核身流程的URL
5377
+ - 用于H5场景核身。
5168
5378
  :type Url: str
5169
5379
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5170
5380
  :type RequestId: str
@@ -5175,8 +5385,9 @@ class GetEidTokenResponse(AbstractModel):
5175
5385
 
5176
5386
  @property
5177
5387
  def EidToken(self):
5178
- """一次核身流程的标识,有效时间为600秒;
5179
- 完成核身后,可用该标识获取验证结果信息。
5388
+ """一次核身流程的标识。
5389
+ - 有效时间为600秒。
5390
+ - 完成核身后,可用该标识获取验证结果信息。
5180
5391
  :rtype: str
5181
5392
  """
5182
5393
  return self._EidToken
@@ -5187,7 +5398,8 @@ class GetEidTokenResponse(AbstractModel):
5187
5398
 
5188
5399
  @property
5189
5400
  def Url(self):
5190
- """发起核身流程的URL,用于H5场景核身。
5401
+ """发起核身流程的URL
5402
+ - 用于H5场景核身。
5191
5403
  :rtype: str
5192
5404
  """
5193
5405
  return self._Url
@@ -5221,11 +5433,14 @@ class GetFaceIdResultRequest(AbstractModel):
5221
5433
 
5222
5434
  def __init__(self):
5223
5435
  r"""
5224
- :param _FaceIdToken: SDK人脸核身流程的标识,调用GetFaceIdToken接口时生成。
5436
+ :param _FaceIdToken: SDK人脸核身流程的标识。
5437
+ - 调用GetFaceIdToken接口时生成。
5225
5438
  :type FaceIdToken: str
5226
- :param _IsNeedVideo: 是否需要拉取视频,默认false不需要
5439
+ :param _IsNeedVideo: 是否需要拉取视频。
5440
+ - 默认false:不需要。
5227
5441
  :type IsNeedVideo: bool
5228
- :param _IsNeedBestFrame: 是否需要拉取截帧,默认false不需要
5442
+ :param _IsNeedBestFrame: 是否需要拉取截帧。
5443
+ - 默认false:不需要。
5229
5444
  :type IsNeedBestFrame: bool
5230
5445
  """
5231
5446
  self._FaceIdToken = None
@@ -5234,7 +5449,8 @@ class GetFaceIdResultRequest(AbstractModel):
5234
5449
 
5235
5450
  @property
5236
5451
  def FaceIdToken(self):
5237
- """SDK人脸核身流程的标识,调用GetFaceIdToken接口时生成。
5452
+ """SDK人脸核身流程的标识。
5453
+ - 调用GetFaceIdToken接口时生成。
5238
5454
  :rtype: str
5239
5455
  """
5240
5456
  return self._FaceIdToken
@@ -5245,7 +5461,8 @@ class GetFaceIdResultRequest(AbstractModel):
5245
5461
 
5246
5462
  @property
5247
5463
  def IsNeedVideo(self):
5248
- """是否需要拉取视频,默认false不需要
5464
+ """是否需要拉取视频。
5465
+ - 默认false:不需要。
5249
5466
  :rtype: bool
5250
5467
  """
5251
5468
  return self._IsNeedVideo
@@ -5256,7 +5473,8 @@ class GetFaceIdResultRequest(AbstractModel):
5256
5473
 
5257
5474
  @property
5258
5475
  def IsNeedBestFrame(self):
5259
- """是否需要拉取截帧,默认false不需要
5476
+ """是否需要拉取截帧。
5477
+ - 默认false:不需要。
5260
5478
  :rtype: bool
5261
5479
  """
5262
5480
  return self._IsNeedBestFrame
@@ -5287,50 +5505,75 @@ class GetFaceIdResultResponse(AbstractModel):
5287
5505
 
5288
5506
  def __init__(self):
5289
5507
  r"""
5290
- :param _IdCard: 身份证
5508
+ :param _IdCard: 身份证。
5291
5509
  :type IdCard: str
5292
- :param _Name: 姓名
5510
+ :param _Name: 姓名。
5293
5511
  :type Name: str
5294
- :param _Result: 业务核验结果,参考https://cloud.tencent.com/document/product/1007/47912
5512
+ :param _Result: 业务核验结果。
5513
+ - 参考:https://cloud.tencent.com/document/product/1007/47912。
5295
5514
  :type Result: str
5296
- :param _Description: 业务核验描述
5515
+ :param _Description: 业务核验描述。
5297
5516
  :type Description: str
5298
- :param _Similarity: 相似度,0-100,数值越大相似度越高
5517
+ :param _Similarity: 相似度。
5518
+ - 取值:0-100。
5519
+ - 数值越大相似度越高。
5299
5520
  :type Similarity: float
5300
- :param _VideoBase64: 用户核验的视频base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
5521
+ :param _VideoBase64: 用户核验的视频base64
5522
+ - 如果选择了使用cos,返回完整cos地址,如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
5301
5523
  注意:此字段可能返回 null,表示取不到有效值。
5302
5524
  :type VideoBase64: str
5303
- :param _BestFrameBase64: 用户核验视频的截帧base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
5525
+ :param _BestFrameBase64: 用户核验视频的截帧base64
5526
+ - 如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
5304
5527
  注意:此字段可能返回 null,表示取不到有效值。
5305
5528
  :type BestFrameBase64: str
5306
- :param _Extra: 获取token时透传的信息
5529
+ :param _Extra: 获取token时透传的信息。
5307
5530
  注意:此字段可能返回 null,表示取不到有效值。
5308
5531
  :type Extra: str
5309
- :param _DeviceInfoTag: plus版:描述当前请求所在设备的风险标签,详情如下:
5310
- 01-设备疑似被Root/设备疑似越狱
5311
- 02-设备疑似被注入
5312
- 03-设备疑似为模拟器
5313
- 04-设备疑似存在风险操作
5314
- 05-摄像头疑似被劫持
5315
- 06-疑似黑产设备
5316
- null-无设备风险
5317
- 增强版:此字段不生效,默认为null
5532
+ :param _DeviceInfoTag: plus版:描述当前请求所在设备的风险标签。
5533
+ - 详情如下:
5534
+ 01-设备疑似被Root/设备疑似越狱。
5535
+ 02-设备疑似被注入。
5536
+ 03-设备疑似为模拟器。
5537
+ 04-设备疑似存在风险操作。
5538
+ 05-摄像头疑似被劫持。
5539
+ 06-疑似黑产设备。
5540
+ null-无设备风险。
5541
+ - 增强版:此字段不生效,默认为null。
5318
5542
  注意:此字段可能返回 null,表示取不到有效值。
5319
5543
  :type DeviceInfoTag: str
5320
- :param _RiskInfoTag: 行为风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
5544
+ :param _RiskInfoTag: 行为风险标签。
5545
+ - 仅错误码返回1007(设备疑似被劫持)时返回风险标签。
5546
+ - 标签说明:
5321
5547
  02:攻击风险
5322
5548
  注意:此字段可能返回 null,表示取不到有效值。
5323
5549
  :type RiskInfoTag: str
5324
- :param _LivenessInfoTag: plus版:描述当前请求活体阶段被拒绝的详细原因,详情如下:01-用户全程闭眼02-用户未完成指定动作03-疑似翻拍攻击04-疑似合成图片05-疑似合成视频06-疑似合成动作07-疑似黑产模板08-疑似存在水印09-反光校验未通过10-最佳帧校验未通过11-人脸质量过差12-人脸距离不匹配13-疑似对抗样本攻击null-无增强版:此字段不生效,默认为null
5550
+ :param _LivenessInfoTag: plus版:描述当前请求活体阶段被拒绝的详细原因。
5551
+ - 详情如下:
5552
+ 01-用户全程闭眼。
5553
+ 02-用户未完成指定动作。
5554
+ 03-疑似翻拍攻击。
5555
+ 04-疑似合成图片。
5556
+ 05-疑似合成视频。
5557
+ 06-疑似合成动作。
5558
+ 07-疑似黑产模板。
5559
+ 08-疑似存在水印。
5560
+ 09-反光校验未通过。
5561
+ 10-最佳帧校验未通过。
5562
+ 11-人脸质量过差。
5563
+ 12-人脸距离不匹配。
5564
+ 13-疑似对抗样本攻击。
5565
+ null-无。
5566
+ - 增强版:此字段不生效,默认为null。
5325
5567
  注意:此字段可能返回 null,表示取不到有效值。
5326
5568
  :type LivenessInfoTag: str
5327
- :param _DeviceInfoLevel: plus版:描述当前请求所在设备的风险等级,共4级,详情如下:
5328
- 1 - 安全
5329
- 2 - 低风险
5330
- 3 - 中风险
5331
- 4 - 高危
5332
- null - 未获取到风险等级
5333
- 增强版:此字段不生效,默认为null
5569
+ :param _DeviceInfoLevel: plus版:描述当前请求所在设备的风险等级,共4级。
5570
+ - 详情如下:
5571
+ 1 - 安全。
5572
+ 2 - 低风险。
5573
+ 3 - 中风险。
5574
+ 4 - 高危。
5575
+ null - 未获取到风险等级。
5576
+ - 增强版:此字段不生效,默认为null。
5334
5577
  注意:此字段可能返回 null,表示取不到有效值。
5335
5578
  :type DeviceInfoLevel: str
5336
5579
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -5352,7 +5595,7 @@ null - 未获取到风险等级
5352
5595
 
5353
5596
  @property
5354
5597
  def IdCard(self):
5355
- """身份证
5598
+ """身份证。
5356
5599
  :rtype: str
5357
5600
  """
5358
5601
  return self._IdCard
@@ -5363,7 +5606,7 @@ null - 未获取到风险等级
5363
5606
 
5364
5607
  @property
5365
5608
  def Name(self):
5366
- """姓名
5609
+ """姓名。
5367
5610
  :rtype: str
5368
5611
  """
5369
5612
  return self._Name
@@ -5374,7 +5617,8 @@ null - 未获取到风险等级
5374
5617
 
5375
5618
  @property
5376
5619
  def Result(self):
5377
- """业务核验结果,参考https://cloud.tencent.com/document/product/1007/47912
5620
+ """业务核验结果。
5621
+ - 参考:https://cloud.tencent.com/document/product/1007/47912。
5378
5622
  :rtype: str
5379
5623
  """
5380
5624
  return self._Result
@@ -5385,7 +5629,7 @@ null - 未获取到风险等级
5385
5629
 
5386
5630
  @property
5387
5631
  def Description(self):
5388
- """业务核验描述
5632
+ """业务核验描述。
5389
5633
  :rtype: str
5390
5634
  """
5391
5635
  return self._Description
@@ -5396,7 +5640,9 @@ null - 未获取到风险等级
5396
5640
 
5397
5641
  @property
5398
5642
  def Similarity(self):
5399
- """相似度,0-100,数值越大相似度越高
5643
+ """相似度。
5644
+ - 取值:0-100。
5645
+ - 数值越大相似度越高。
5400
5646
  :rtype: float
5401
5647
  """
5402
5648
  return self._Similarity
@@ -5407,7 +5653,8 @@ null - 未获取到风险等级
5407
5653
 
5408
5654
  @property
5409
5655
  def VideoBase64(self):
5410
- """用户核验的视频base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
5656
+ """用户核验的视频base64
5657
+ - 如果选择了使用cos,返回完整cos地址,如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
5411
5658
  注意:此字段可能返回 null,表示取不到有效值。
5412
5659
  :rtype: str
5413
5660
  """
@@ -5419,7 +5666,8 @@ null - 未获取到风险等级
5419
5666
 
5420
5667
  @property
5421
5668
  def BestFrameBase64(self):
5422
- """用户核验视频的截帧base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
5669
+ """用户核验视频的截帧base64
5670
+ - 如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。
5423
5671
  注意:此字段可能返回 null,表示取不到有效值。
5424
5672
  :rtype: str
5425
5673
  """
@@ -5431,7 +5679,7 @@ null - 未获取到风险等级
5431
5679
 
5432
5680
  @property
5433
5681
  def Extra(self):
5434
- """获取token时透传的信息
5682
+ """获取token时透传的信息。
5435
5683
  注意:此字段可能返回 null,表示取不到有效值。
5436
5684
  :rtype: str
5437
5685
  """
@@ -5443,15 +5691,16 @@ null - 未获取到风险等级
5443
5691
 
5444
5692
  @property
5445
5693
  def DeviceInfoTag(self):
5446
- """plus版:描述当前请求所在设备的风险标签,详情如下:
5447
- 01-设备疑似被Root/设备疑似越狱
5448
- 02-设备疑似被注入
5449
- 03-设备疑似为模拟器
5450
- 04-设备疑似存在风险操作
5451
- 05-摄像头疑似被劫持
5452
- 06-疑似黑产设备
5453
- null-无设备风险
5454
- 增强版:此字段不生效,默认为null
5694
+ """plus版:描述当前请求所在设备的风险标签。
5695
+ - 详情如下:
5696
+ 01-设备疑似被Root/设备疑似越狱。
5697
+ 02-设备疑似被注入。
5698
+ 03-设备疑似为模拟器。
5699
+ 04-设备疑似存在风险操作。
5700
+ 05-摄像头疑似被劫持。
5701
+ 06-疑似黑产设备。
5702
+ null-无设备风险。
5703
+ - 增强版:此字段不生效,默认为null。
5455
5704
  注意:此字段可能返回 null,表示取不到有效值。
5456
5705
  :rtype: str
5457
5706
  """
@@ -5463,7 +5712,9 @@ null-无设备风险
5463
5712
 
5464
5713
  @property
5465
5714
  def RiskInfoTag(self):
5466
- """行为风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
5715
+ """行为风险标签。
5716
+ - 仅错误码返回1007(设备疑似被劫持)时返回风险标签。
5717
+ - 标签说明:
5467
5718
  02:攻击风险
5468
5719
  注意:此字段可能返回 null,表示取不到有效值。
5469
5720
  :rtype: str
@@ -5476,7 +5727,23 @@ null-无设备风险
5476
5727
 
5477
5728
  @property
5478
5729
  def LivenessInfoTag(self):
5479
- """plus版:描述当前请求活体阶段被拒绝的详细原因,详情如下:01-用户全程闭眼02-用户未完成指定动作03-疑似翻拍攻击04-疑似合成图片05-疑似合成视频06-疑似合成动作07-疑似黑产模板08-疑似存在水印09-反光校验未通过10-最佳帧校验未通过11-人脸质量过差12-人脸距离不匹配13-疑似对抗样本攻击null-无增强版:此字段不生效,默认为null
5730
+ """plus版:描述当前请求活体阶段被拒绝的详细原因。
5731
+ - 详情如下:
5732
+ 01-用户全程闭眼。
5733
+ 02-用户未完成指定动作。
5734
+ 03-疑似翻拍攻击。
5735
+ 04-疑似合成图片。
5736
+ 05-疑似合成视频。
5737
+ 06-疑似合成动作。
5738
+ 07-疑似黑产模板。
5739
+ 08-疑似存在水印。
5740
+ 09-反光校验未通过。
5741
+ 10-最佳帧校验未通过。
5742
+ 11-人脸质量过差。
5743
+ 12-人脸距离不匹配。
5744
+ 13-疑似对抗样本攻击。
5745
+ null-无。
5746
+ - 增强版:此字段不生效,默认为null。
5480
5747
  注意:此字段可能返回 null,表示取不到有效值。
5481
5748
  :rtype: str
5482
5749
  """
@@ -5488,13 +5755,14 @@ null-无设备风险
5488
5755
 
5489
5756
  @property
5490
5757
  def DeviceInfoLevel(self):
5491
- """plus版:描述当前请求所在设备的风险等级,共4级,详情如下:
5492
- 1 - 安全
5493
- 2 - 低风险
5494
- 3 - 中风险
5495
- 4 - 高危
5496
- null - 未获取到风险等级
5497
- 增强版:此字段不生效,默认为null
5758
+ """plus版:描述当前请求所在设备的风险等级,共4级。
5759
+ - 详情如下:
5760
+ 1 - 安全。
5761
+ 2 - 低风险。
5762
+ 3 - 中风险。
5763
+ 4 - 高危。
5764
+ null - 未获取到风险等级。
5765
+ - 增强版:此字段不生效,默认为null。
5498
5766
  注意:此字段可能返回 null,表示取不到有效值。
5499
5767
  :rtype: str
5500
5768
  """
@@ -5575,22 +5843,50 @@ class GetFaceIdRiskInfoResponse(AbstractModel):
5575
5843
 
5576
5844
  def __init__(self):
5577
5845
  r"""
5578
- :param _DeviceInfoTag: 描述当前请求所在设备的风险标签,详情如下: 01-设备疑似被Root/设备疑似越狱 02-设备疑似被注入 03-设备疑似为模拟器 04-设备疑似存在风险操作 05-摄像头疑似被劫持 06-疑似黑产设备
5846
+ :param _DeviceInfoTag: 描述当前请求所在设备的风险标签
5847
+ - 详情如下:
5848
+ 01-设备疑似被Root/设备疑似越狱。
5849
+ 02-设备疑似被注入。
5850
+ 03-设备疑似为模拟器。
5851
+ 04-设备疑似存在风险操作。
5852
+ 05-摄像头疑似被劫持。
5853
+ 06-疑似黑产设备。
5579
5854
  注意:此字段可能返回 null,表示取不到有效值。
5580
5855
  :type DeviceInfoTag: str
5581
- :param _DeviceInfoLevel: 描述当前请求所在设备的风险等级,共4级,详情如下: 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ,-1表示未获取到风险等级
5856
+ :param _DeviceInfoLevel: 描述当前请求所在设备的风险等级,共4级。
5857
+ - 详情如下:
5858
+ 1 - 低风险。
5859
+ 2 - 中风险。
5860
+ 3 - 高风险。
5861
+ 4 - 攻击。
5862
+ -1表示未获取到风险等级。
5582
5863
  注意:此字段可能返回 null,表示取不到有效值。
5583
5864
  :type DeviceInfoLevel: int
5584
- :param _OpenId: 设备id标识
5865
+ :param _OpenId: 设备id标识。
5585
5866
  注意:此字段可能返回 null,表示取不到有效值。
5586
5867
  :type OpenId: str
5587
- :param _CameraInfoLevel: 描述当前请求所在设备的相机指纹风险等级,共4级,详情如下: 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ,-1表示未获取到风险等级
5868
+ :param _CameraInfoLevel: 描述当前请求所在设备的相机指纹风险等级,共4级。
5869
+ - 详情如下:
5870
+ 1 - 低风险。
5871
+ 2 - 中风险。
5872
+ 3 - 高风险。
5873
+ 4 - 攻击。
5874
+ -1表示未获取到风险等级。
5588
5875
  注意:此字段可能返回 null,表示取不到有效值。
5589
5876
  :type CameraInfoLevel: int
5590
- :param _CameraInfoTag: 描述当前请求所在设备的相机指纹风险标签,详情如下: 01-设备疑似被Root/设备疑似越狱 02-设备疑似被注入 03-设备疑似为模拟器 04-设备疑似存在风险操作 05-摄像头疑似被劫持 06-疑似黑产设备,空表示没有相机指纹风险
5877
+ :param _CameraInfoTag: 描述当前请求所在设备的相机指纹风险标签。
5878
+
5879
+ - 详情如下:
5880
+ 01-设备疑似被Root/设备疑似越狱。
5881
+ 02-设备疑似被注入。
5882
+ 03-设备疑似为模拟器。
5883
+ 04-设备疑似存在风险操作。
5884
+ 05-摄像头疑似被劫持。
5885
+ 06-疑似黑产设备。
5886
+ 空表示没有相机指纹风险。
5591
5887
  注意:此字段可能返回 null,表示取不到有效值。
5592
5888
  :type CameraInfoTag: str
5593
- :param _Extra: 获取token时透传的信息
5889
+ :param _Extra: 获取token时透传的信息。
5594
5890
  注意:此字段可能返回 null,表示取不到有效值。
5595
5891
  :type Extra: str
5596
5892
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -5606,7 +5902,14 @@ class GetFaceIdRiskInfoResponse(AbstractModel):
5606
5902
 
5607
5903
  @property
5608
5904
  def DeviceInfoTag(self):
5609
- """描述当前请求所在设备的风险标签,详情如下: 01-设备疑似被Root/设备疑似越狱 02-设备疑似被注入 03-设备疑似为模拟器 04-设备疑似存在风险操作 05-摄像头疑似被劫持 06-疑似黑产设备
5905
+ """描述当前请求所在设备的风险标签
5906
+ - 详情如下:
5907
+ 01-设备疑似被Root/设备疑似越狱。
5908
+ 02-设备疑似被注入。
5909
+ 03-设备疑似为模拟器。
5910
+ 04-设备疑似存在风险操作。
5911
+ 05-摄像头疑似被劫持。
5912
+ 06-疑似黑产设备。
5610
5913
  注意:此字段可能返回 null,表示取不到有效值。
5611
5914
  :rtype: str
5612
5915
  """
@@ -5618,7 +5921,13 @@ class GetFaceIdRiskInfoResponse(AbstractModel):
5618
5921
 
5619
5922
  @property
5620
5923
  def DeviceInfoLevel(self):
5621
- """描述当前请求所在设备的风险等级,共4级,详情如下: 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ,-1表示未获取到风险等级
5924
+ """描述当前请求所在设备的风险等级,共4级。
5925
+ - 详情如下:
5926
+ 1 - 低风险。
5927
+ 2 - 中风险。
5928
+ 3 - 高风险。
5929
+ 4 - 攻击。
5930
+ -1表示未获取到风险等级。
5622
5931
  注意:此字段可能返回 null,表示取不到有效值。
5623
5932
  :rtype: int
5624
5933
  """
@@ -5630,7 +5939,7 @@ class GetFaceIdRiskInfoResponse(AbstractModel):
5630
5939
 
5631
5940
  @property
5632
5941
  def OpenId(self):
5633
- """设备id标识
5942
+ """设备id标识。
5634
5943
  注意:此字段可能返回 null,表示取不到有效值。
5635
5944
  :rtype: str
5636
5945
  """
@@ -5642,7 +5951,13 @@ class GetFaceIdRiskInfoResponse(AbstractModel):
5642
5951
 
5643
5952
  @property
5644
5953
  def CameraInfoLevel(self):
5645
- """描述当前请求所在设备的相机指纹风险等级,共4级,详情如下: 1 - 低风险 2 - 中风险 3 - 高风险 4 - 攻击 ,-1表示未获取到风险等级
5954
+ """描述当前请求所在设备的相机指纹风险等级,共4级。
5955
+ - 详情如下:
5956
+ 1 - 低风险。
5957
+ 2 - 中风险。
5958
+ 3 - 高风险。
5959
+ 4 - 攻击。
5960
+ -1表示未获取到风险等级。
5646
5961
  注意:此字段可能返回 null,表示取不到有效值。
5647
5962
  :rtype: int
5648
5963
  """
@@ -5654,7 +5969,16 @@ class GetFaceIdRiskInfoResponse(AbstractModel):
5654
5969
 
5655
5970
  @property
5656
5971
  def CameraInfoTag(self):
5657
- """描述当前请求所在设备的相机指纹风险标签,详情如下: 01-设备疑似被Root/设备疑似越狱 02-设备疑似被注入 03-设备疑似为模拟器 04-设备疑似存在风险操作 05-摄像头疑似被劫持 06-疑似黑产设备,空表示没有相机指纹风险
5972
+ """描述当前请求所在设备的相机指纹风险标签。
5973
+
5974
+ - 详情如下:
5975
+ 01-设备疑似被Root/设备疑似越狱。
5976
+ 02-设备疑似被注入。
5977
+ 03-设备疑似为模拟器。
5978
+ 04-设备疑似存在风险操作。
5979
+ 05-摄像头疑似被劫持。
5980
+ 06-疑似黑产设备。
5981
+ 空表示没有相机指纹风险。
5658
5982
  注意:此字段可能返回 null,表示取不到有效值。
5659
5983
  :rtype: str
5660
5984
  """
@@ -5666,7 +5990,7 @@ class GetFaceIdRiskInfoResponse(AbstractModel):
5666
5990
 
5667
5991
  @property
5668
5992
  def Extra(self):
5669
- """获取token时透传的信息
5993
+ """获取token时透传的信息。
5670
5994
  注意:此字段可能返回 null,表示取不到有效值。
5671
5995
  :rtype: str
5672
5996
  """
@@ -5705,26 +6029,38 @@ class GetFaceIdTokenRequest(AbstractModel):
5705
6029
 
5706
6030
  def __init__(self):
5707
6031
  r"""
5708
- :param _CompareLib: 本地上传照片(LOCAL)、商业库(BUSINESS)
6032
+ :param _CompareLib: 比对库。
6033
+ - 取值范围:
6034
+ LOCAL:本地上传照片。
6035
+ BUSINESS:商业库。
5709
6036
  :type CompareLib: str
5710
- :param _IdCard: CompareLib为商业库时必传。
6037
+ :param _IdCard: 身份证。
6038
+ - CompareLib为商业库时必传。
5711
6039
  :type IdCard: str
5712
- :param _Name: CompareLib为商业库时必传。
6040
+ :param _Name: 姓名。
6041
+ - CompareLib为商业库时必传。
5713
6042
  :type Name: str
5714
- :param _ImageBase64: CompareLib为上传照片比对时必传,Base64后图片最大8MB
5715
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
6043
+ :param _ImageBase64: 图片的Base64。
6044
+ - CompareLib为上传照片比对时必传。
6045
+ - Base64后图片最大8MB。
6046
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
5716
6047
  :type ImageBase64: str
5717
- :param _Meta: SDK中生成的Meta字符串
6048
+ :param _Meta: SDK中生成的Meta字符串。
5718
6049
  :type Meta: str
5719
- :param _Extra: 透传参数 1000长度字符串
6050
+ :param _Extra: 透传参数。
6051
+ - 1000长度字符串
5720
6052
  :type Extra: str
5721
- :param _UseCos: 默认为false,设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。开通地址见https://console.cloud.tencent.com/faceid/cos
5722
- 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
6053
+ :param _UseCos: 是否使用cos桶。
6054
+ - 默认为false。
6055
+ - 设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。
6056
+ - 开通地址见https://console.cloud.tencent.com/faceid/cos
6057
+ - 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
5723
6058
  :type UseCos: bool
5724
6059
  :param _Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
5725
6060
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
5726
- :param _RuleId: 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加腾讯云人脸核身小助手进行咨询。
5727
- 示例值:1
6061
+ :param _RuleId: 用于细分客户使用场景。
6062
+ - 申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。
6063
+ - 如有疑问,请添加腾讯云人脸核身小助手进行咨询。
5728
6064
  :type RuleId: str
5729
6065
  """
5730
6066
  self._CompareLib = None
@@ -5739,7 +6075,10 @@ class GetFaceIdTokenRequest(AbstractModel):
5739
6075
 
5740
6076
  @property
5741
6077
  def CompareLib(self):
5742
- """本地上传照片(LOCAL)、商业库(BUSINESS)
6078
+ """比对库。
6079
+ - 取值范围:
6080
+ LOCAL:本地上传照片。
6081
+ BUSINESS:商业库。
5743
6082
  :rtype: str
5744
6083
  """
5745
6084
  return self._CompareLib
@@ -5750,7 +6089,8 @@ class GetFaceIdTokenRequest(AbstractModel):
5750
6089
 
5751
6090
  @property
5752
6091
  def IdCard(self):
5753
- """CompareLib为商业库时必传。
6092
+ """身份证。
6093
+ - CompareLib为商业库时必传。
5754
6094
  :rtype: str
5755
6095
  """
5756
6096
  return self._IdCard
@@ -5761,7 +6101,8 @@ class GetFaceIdTokenRequest(AbstractModel):
5761
6101
 
5762
6102
  @property
5763
6103
  def Name(self):
5764
- """CompareLib为商业库时必传。
6104
+ """姓名。
6105
+ - CompareLib为商业库时必传。
5765
6106
  :rtype: str
5766
6107
  """
5767
6108
  return self._Name
@@ -5772,8 +6113,10 @@ class GetFaceIdTokenRequest(AbstractModel):
5772
6113
 
5773
6114
  @property
5774
6115
  def ImageBase64(self):
5775
- """CompareLib为上传照片比对时必传,Base64后图片最大8MB
5776
- 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
6116
+ """图片的Base64。
6117
+ - CompareLib为上传照片比对时必传。
6118
+ - Base64后图片最大8MB。
6119
+ - 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
5777
6120
  :rtype: str
5778
6121
  """
5779
6122
  return self._ImageBase64
@@ -5784,7 +6127,7 @@ class GetFaceIdTokenRequest(AbstractModel):
5784
6127
 
5785
6128
  @property
5786
6129
  def Meta(self):
5787
- """SDK中生成的Meta字符串
6130
+ """SDK中生成的Meta字符串。
5788
6131
  :rtype: str
5789
6132
  """
5790
6133
  return self._Meta
@@ -5795,7 +6138,8 @@ class GetFaceIdTokenRequest(AbstractModel):
5795
6138
 
5796
6139
  @property
5797
6140
  def Extra(self):
5798
- """透传参数 1000长度字符串
6141
+ """透传参数。
6142
+ - 1000长度字符串
5799
6143
  :rtype: str
5800
6144
  """
5801
6145
  return self._Extra
@@ -5806,8 +6150,11 @@ class GetFaceIdTokenRequest(AbstractModel):
5806
6150
 
5807
6151
  @property
5808
6152
  def UseCos(self):
5809
- """默认为false,设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。开通地址见https://console.cloud.tencent.com/faceid/cos
5810
- 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
6153
+ """是否使用cos桶。
6154
+ - 默认为false。
6155
+ - 设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。
6156
+ - 开通地址见https://console.cloud.tencent.com/faceid/cos
6157
+ - 【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
5811
6158
  :rtype: bool
5812
6159
  """
5813
6160
  return self._UseCos
@@ -5829,8 +6176,9 @@ class GetFaceIdTokenRequest(AbstractModel):
5829
6176
 
5830
6177
  @property
5831
6178
  def RuleId(self):
5832
- """用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加腾讯云人脸核身小助手进行咨询。
5833
- 示例值:1
6179
+ """用于细分客户使用场景。
6180
+ - 申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。
6181
+ - 如有疑问,请添加腾讯云人脸核身小助手进行咨询。
5834
6182
  :rtype: str
5835
6183
  """
5836
6184
  return self._RuleId
@@ -5869,7 +6217,7 @@ class GetFaceIdTokenResponse(AbstractModel):
5869
6217
 
5870
6218
  def __init__(self):
5871
6219
  r"""
5872
- :param _FaceIdToken: 有效期 10分钟。只能完成1次核身。
6220
+ :param _FaceIdToken: token值。- 有效期 10分钟。- 只能完成1次核身。
5873
6221
  :type FaceIdToken: str
5874
6222
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5875
6223
  :type RequestId: str
@@ -5879,7 +6227,7 @@ class GetFaceIdTokenResponse(AbstractModel):
5879
6227
 
5880
6228
  @property
5881
6229
  def FaceIdToken(self):
5882
- """有效期 10分钟。只能完成1次核身。
6230
+ """token值。- 有效期 10分钟。- 只能完成1次核身。
5883
6231
  :rtype: str
5884
6232
  """
5885
6233
  return self._FaceIdToken
@@ -5912,9 +6260,9 @@ class GetFaceidRiskInfoTokenRequest(AbstractModel):
5912
6260
 
5913
6261
  def __init__(self):
5914
6262
  r"""
5915
- :param _Meta: SDK中生成的Meta字符串
6263
+ :param _Meta: SDK中生成的Meta字符串。
5916
6264
  :type Meta: str
5917
- :param _Extra: 透传参数 1000长度字符串
6265
+ :param _Extra: 透传参数 1000长度字符串。
5918
6266
  :type Extra: str
5919
6267
  """
5920
6268
  self._Meta = None
@@ -5922,7 +6270,7 @@ class GetFaceidRiskInfoTokenRequest(AbstractModel):
5922
6270
 
5923
6271
  @property
5924
6272
  def Meta(self):
5925
- """SDK中生成的Meta字符串
6273
+ """SDK中生成的Meta字符串。
5926
6274
  :rtype: str
5927
6275
  """
5928
6276
  return self._Meta
@@ -5933,7 +6281,7 @@ class GetFaceidRiskInfoTokenRequest(AbstractModel):
5933
6281
 
5934
6282
  @property
5935
6283
  def Extra(self):
5936
- """透传参数 1000长度字符串
6284
+ """透传参数 1000长度字符串。
5937
6285
  :rtype: str
5938
6286
  """
5939
6287
  return self._Extra
@@ -6814,9 +7162,10 @@ class ImageRecognitionV2Request(AbstractModel):
6814
7162
 
6815
7163
  def __init__(self):
6816
7164
  r"""
6817
- :param _IdCard: 身份证号
7165
+ :param _IdCard: 身份证号。
6818
7166
  :type IdCard: str
6819
- :param _Name: 姓名。中文请使用UTF-8编码。
7167
+ :param _Name: 姓名。
7168
+ - 中文请使用UTF-8编码。
6820
7169
  :type Name: str
6821
7170
  :param _ImageBase64: 用于人脸比对的照片,图片的Base64值;
6822
7171
  Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
@@ -6824,7 +7173,8 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
6824
7173
  :type ImageBase64: str
6825
7174
  :param _Optional: 本接口不需要传递此参数。
6826
7175
  :type Optional: str
6827
- :param _Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
7176
+ :param _Encryption: 敏感数据加密信息。
7177
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
6828
7178
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
6829
7179
  """
6830
7180
  self._IdCard = None
@@ -6835,7 +7185,7 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
6835
7185
 
6836
7186
  @property
6837
7187
  def IdCard(self):
6838
- """身份证号
7188
+ """身份证号。
6839
7189
  :rtype: str
6840
7190
  """
6841
7191
  return self._IdCard
@@ -6846,7 +7196,8 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
6846
7196
 
6847
7197
  @property
6848
7198
  def Name(self):
6849
- """姓名。中文请使用UTF-8编码。
7199
+ """姓名。
7200
+ - 中文请使用UTF-8编码。
6850
7201
  :rtype: str
6851
7202
  """
6852
7203
  return self._Name
@@ -6881,7 +7232,8 @@ Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
6881
7232
 
6882
7233
  @property
6883
7234
  def Encryption(self):
6884
- """敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
7235
+ """敏感数据加密信息。
7236
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
6885
7237
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
6886
7238
  """
6887
7239
  return self._Encryption
@@ -6916,9 +7268,13 @@ class ImageRecognitionV2Response(AbstractModel):
6916
7268
 
6917
7269
  def __init__(self):
6918
7270
  r"""
6919
- :param _Sim: 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
7271
+ :param _Sim: 相似度。
7272
+ - 取值范围 [0.00, 100.00]。
7273
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
6920
7274
  :type Sim: float
6921
- :param _Result: 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
7275
+ :param _Result: 业务错误码。
7276
+ - 成功情况返回Success。
7277
+ - 错误情况请参考下方错误码 列表中FailedOperation部分
6922
7278
  :type Result: str
6923
7279
  :param _Description: 业务结果描述。
6924
7280
  :type Description: str
@@ -6932,7 +7288,9 @@ class ImageRecognitionV2Response(AbstractModel):
6932
7288
 
6933
7289
  @property
6934
7290
  def Sim(self):
6935
- """相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
7291
+ """相似度。
7292
+ - 取值范围 [0.00, 100.00]。
7293
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
6936
7294
  :rtype: float
6937
7295
  """
6938
7296
  return self._Sim
@@ -6943,7 +7301,9 @@ class ImageRecognitionV2Response(AbstractModel):
6943
7301
 
6944
7302
  @property
6945
7303
  def Result(self):
6946
- """业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
7304
+ """业务错误码。
7305
+ - 成功情况返回Success。
7306
+ - 错误情况请参考下方错误码 列表中FailedOperation部分
6947
7307
  :rtype: str
6948
7308
  """
6949
7309
  return self._Result
@@ -7197,9 +7557,12 @@ class IntentionQuestion(AbstractModel):
7197
7557
 
7198
7558
  def __init__(self):
7199
7559
  r"""
7200
- :param _Question: 当选择语音问答模式时,系统自动播报的问题文本,最大长度为150个字符。
7560
+ :param _Question: 当选择语音问答模式时,系统自动播报的问题文本。
7561
+ - 最大长度为150个字符。
7201
7562
  :type Question: str
7202
- :param _Answers: 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表,传入后可自动判断用户回答文本是否在标准文本列表中。列表长度最大为50,单个答案长度限制10个字符。
7563
+ :param _Answers: 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表。
7564
+ - 传入后可自动判断用户回答文本是否在标准文本列表中。
7565
+ - 列表长度最大为50,单个答案长度限制10个字符。
7203
7566
  :type Answers: list of str
7204
7567
  """
7205
7568
  self._Question = None
@@ -7207,7 +7570,8 @@ class IntentionQuestion(AbstractModel):
7207
7570
 
7208
7571
  @property
7209
7572
  def Question(self):
7210
- """当选择语音问答模式时,系统自动播报的问题文本,最大长度为150个字符。
7573
+ """当选择语音问答模式时,系统自动播报的问题文本。
7574
+ - 最大长度为150个字符。
7211
7575
  :rtype: str
7212
7576
  """
7213
7577
  return self._Question
@@ -7218,7 +7582,9 @@ class IntentionQuestion(AbstractModel):
7218
7582
 
7219
7583
  @property
7220
7584
  def Answers(self):
7221
- """当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表,传入后可自动判断用户回答文本是否在标准文本列表中。列表长度最大为50,单个答案长度限制10个字符。
7585
+ """当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表。
7586
+ - 传入后可自动判断用户回答文本是否在标准文本列表中。
7587
+ - 列表长度最大为50,单个答案长度限制10个字符。
7222
7588
  :rtype: list of str
7223
7589
  """
7224
7590
  return self._Answers
@@ -7242,57 +7608,63 @@ class IntentionQuestion(AbstractModel):
7242
7608
 
7243
7609
 
7244
7610
  class IntentionQuestionResult(AbstractModel):
7245
- """意愿核身问答模式结果
7611
+ """意愿核身问答模式结果。
7246
7612
 
7247
7613
  """
7248
7614
 
7249
7615
  def __init__(self):
7250
7616
  r"""
7251
- :param _FinalResultDetailCode: 意愿核身错误码:
7252
- 0: "成功"
7253
- -1: "参数错误"
7254
- -2: "系统异常"
7255
- -101: "请保持人脸在框内"
7256
- -102: "检测到多张人脸"
7257
- -103: "人脸检测失败"
7258
- -104: "人脸检测不完整"
7259
- -105: "请勿遮挡眼睛"
7260
- -106: "请勿遮挡嘴巴"
7261
- -107: "请勿遮挡鼻子"
7262
- -201: "人脸比对相似度低"
7263
- -202: "人脸比对失败"
7264
- -301: "意愿核验不通过"
7265
- -302: "用户回答阶段未检测到张嘴动作"
7266
- -800: "前端不兼容错误"
7267
- -801: "用户未授权摄像头和麦克风权限"
7268
- -802: "核验流程异常中断,请勿切屏或进行其他操作"
7269
- -803: "用户主动关闭链接/异常断开链接"
7270
- -998: "系统数据异常"
7271
- -999: "系统未知错误,请联系人工核实"
7272
- 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)
7617
+ :param _FinalResultDetailCode: 意愿核身错误码。
7618
+ - 取值范围:
7619
+ 0: "成功"
7620
+ -1: "参数错误"
7621
+ -2: "系统异常"
7622
+ -101: "请保持人脸在框内"
7623
+ -102: "检测到多张人脸"
7624
+ -103: "人脸检测失败"
7625
+ -104: "人脸检测不完整"
7626
+ -105: "请勿遮挡眼睛"
7627
+ -106: "请勿遮挡嘴巴"
7628
+ -107: "请勿遮挡鼻子"
7629
+ -201: "人脸比对相似度低"
7630
+ -202: "人脸比对失败"
7631
+ -301: "意愿核验不通过"
7632
+ -302: "用户回答阶段未检测到张嘴动作"
7633
+ -800: "前端不兼容错误"
7634
+ -801: "用户未授权摄像头和麦克风权限"
7635
+ -802: "核验流程异常中断,请勿切屏或进行其他操作"
7636
+ -803: "用户主动关闭链接/异常断开链接"
7637
+ -998: "系统数据异常"
7638
+ -999: "系统未知错误,请联系人工核实"
7639
+ - 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)
7273
7640
  注意:此字段可能返回 null,表示取不到有效值。
7274
7641
  :type FinalResultDetailCode: int
7275
- :param _FinalResultMessage: 意愿核身错误信息
7642
+ :param _FinalResultMessage: 意愿核身错误信息。
7276
7643
  注意:此字段可能返回 null,表示取不到有效值。
7277
7644
  :type FinalResultMessage: str
7278
- :param _Video: 视频base64(其中包含全程问题和回答音频,mp4格式)
7645
+ :param _Video: 视频base64
7646
+ - 其中包含全程问题和回答音频,mp4格式。
7279
7647
  注意:此字段可能返回 null,表示取不到有效值。
7280
7648
  :type Video: str
7281
- :param _ScreenShot: 屏幕截图base64列表
7649
+ :param _ScreenShot: 屏幕截图base64列表。
7282
7650
  注意:此字段可能返回 null,表示取不到有效值。
7283
7651
  :type ScreenShot: list of str
7284
- :param _ResultCode: 和答案匹配结果列表
7285
- 0:成功,-1:不匹配
7652
+ :param _ResultCode: 和答案匹配结果列表。
7653
+ - 取值范围(0:成功;-1:不匹配)
7286
7654
  注意:此字段可能返回 null,表示取不到有效值。
7287
7655
  :type ResultCode: list of str
7288
- :param _AsrResult: 回答问题语音识别结果列表
7656
+ :param _AsrResult: 回答问题语音识别结果列表。
7289
7657
  注意:此字段可能返回 null,表示取不到有效值。
7290
7658
  :type AsrResult: list of str
7291
- :param _Audios: 答案录音音频
7659
+ :param _Audios: 答案录音音频。
7292
7660
  注意:此字段可能返回 null,表示取不到有效值。
7293
7661
  :type Audios: list of str
7294
- :param _FinalResultCode: 意愿核身最终结果:
7295
- 0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验。建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
7662
+ :param _FinalResultCode: 意愿核身最终结果。
7663
+ - 取值范围:
7664
+ 0:认证通过。
7665
+ -1:认证未通过。
7666
+ -2:浏览器内核不兼容,无法进行意愿校验。
7667
+ - 建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
7296
7668
  注意:此字段可能返回 null,表示取不到有效值。
7297
7669
  :type FinalResultCode: str
7298
7670
  """
@@ -7307,28 +7679,29 @@ class IntentionQuestionResult(AbstractModel):
7307
7679
 
7308
7680
  @property
7309
7681
  def FinalResultDetailCode(self):
7310
- """意愿核身错误码:
7311
- 0: "成功"
7312
- -1: "参数错误"
7313
- -2: "系统异常"
7314
- -101: "请保持人脸在框内"
7315
- -102: "检测到多张人脸"
7316
- -103: "人脸检测失败"
7317
- -104: "人脸检测不完整"
7318
- -105: "请勿遮挡眼睛"
7319
- -106: "请勿遮挡嘴巴"
7320
- -107: "请勿遮挡鼻子"
7321
- -201: "人脸比对相似度低"
7322
- -202: "人脸比对失败"
7323
- -301: "意愿核验不通过"
7324
- -302: "用户回答阶段未检测到张嘴动作"
7325
- -800: "前端不兼容错误"
7326
- -801: "用户未授权摄像头和麦克风权限"
7327
- -802: "核验流程异常中断,请勿切屏或进行其他操作"
7328
- -803: "用户主动关闭链接/异常断开链接"
7329
- -998: "系统数据异常"
7330
- -999: "系统未知错误,请联系人工核实"
7331
- 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)
7682
+ """意愿核身错误码。
7683
+ - 取值范围:
7684
+ 0: "成功"
7685
+ -1: "参数错误"
7686
+ -2: "系统异常"
7687
+ -101: "请保持人脸在框内"
7688
+ -102: "检测到多张人脸"
7689
+ -103: "人脸检测失败"
7690
+ -104: "人脸检测不完整"
7691
+ -105: "请勿遮挡眼睛"
7692
+ -106: "请勿遮挡嘴巴"
7693
+ -107: "请勿遮挡鼻子"
7694
+ -201: "人脸比对相似度低"
7695
+ -202: "人脸比对失败"
7696
+ -301: "意愿核验不通过"
7697
+ -302: "用户回答阶段未检测到张嘴动作"
7698
+ -800: "前端不兼容错误"
7699
+ -801: "用户未授权摄像头和麦克风权限"
7700
+ -802: "核验流程异常中断,请勿切屏或进行其他操作"
7701
+ -803: "用户主动关闭链接/异常断开链接"
7702
+ -998: "系统数据异常"
7703
+ -999: "系统未知错误,请联系人工核实"
7704
+ - 若在人脸核身过程失败、未进入意愿确认过程,则该参数返回为空,请参考人脸核身错误码结果(DetectInfoText.ErrCode)
7332
7705
  注意:此字段可能返回 null,表示取不到有效值。
7333
7706
  :rtype: int
7334
7707
  """
@@ -7340,7 +7713,7 @@ class IntentionQuestionResult(AbstractModel):
7340
7713
 
7341
7714
  @property
7342
7715
  def FinalResultMessage(self):
7343
- """意愿核身错误信息
7716
+ """意愿核身错误信息。
7344
7717
  注意:此字段可能返回 null,表示取不到有效值。
7345
7718
  :rtype: str
7346
7719
  """
@@ -7352,7 +7725,8 @@ class IntentionQuestionResult(AbstractModel):
7352
7725
 
7353
7726
  @property
7354
7727
  def Video(self):
7355
- """视频base64(其中包含全程问题和回答音频,mp4格式)
7728
+ """视频base64
7729
+ - 其中包含全程问题和回答音频,mp4格式。
7356
7730
  注意:此字段可能返回 null,表示取不到有效值。
7357
7731
  :rtype: str
7358
7732
  """
@@ -7364,7 +7738,7 @@ class IntentionQuestionResult(AbstractModel):
7364
7738
 
7365
7739
  @property
7366
7740
  def ScreenShot(self):
7367
- """屏幕截图base64列表
7741
+ """屏幕截图base64列表。
7368
7742
  注意:此字段可能返回 null,表示取不到有效值。
7369
7743
  :rtype: list of str
7370
7744
  """
@@ -7376,8 +7750,8 @@ class IntentionQuestionResult(AbstractModel):
7376
7750
 
7377
7751
  @property
7378
7752
  def ResultCode(self):
7379
- """和答案匹配结果列表
7380
- 0:成功,-1:不匹配
7753
+ """和答案匹配结果列表。
7754
+ - 取值范围(0:成功;-1:不匹配)
7381
7755
  注意:此字段可能返回 null,表示取不到有效值。
7382
7756
  :rtype: list of str
7383
7757
  """
@@ -7389,7 +7763,7 @@ class IntentionQuestionResult(AbstractModel):
7389
7763
 
7390
7764
  @property
7391
7765
  def AsrResult(self):
7392
- """回答问题语音识别结果列表
7766
+ """回答问题语音识别结果列表。
7393
7767
  注意:此字段可能返回 null,表示取不到有效值。
7394
7768
  :rtype: list of str
7395
7769
  """
@@ -7401,7 +7775,7 @@ class IntentionQuestionResult(AbstractModel):
7401
7775
 
7402
7776
  @property
7403
7777
  def Audios(self):
7404
- """答案录音音频
7778
+ """答案录音音频。
7405
7779
  注意:此字段可能返回 null,表示取不到有效值。
7406
7780
  :rtype: list of str
7407
7781
  """
@@ -7413,8 +7787,12 @@ class IntentionQuestionResult(AbstractModel):
7413
7787
 
7414
7788
  @property
7415
7789
  def FinalResultCode(self):
7416
- """意愿核身最终结果:
7417
- 0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验。建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
7790
+ """意愿核身最终结果。
7791
+ - 取值范围:
7792
+ 0:认证通过。
7793
+ -1:认证未通过。
7794
+ -2:浏览器内核不兼容,无法进行意愿校验。
7795
+ - 建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
7418
7796
  注意:此字段可能返回 null,表示取不到有效值。
7419
7797
  :rtype: str
7420
7798
  """
@@ -7445,25 +7823,29 @@ class IntentionQuestionResult(AbstractModel):
7445
7823
 
7446
7824
 
7447
7825
  class IntentionVerifyData(AbstractModel):
7448
- """意愿核身相关结果
7826
+ """意愿核身相关结果。
7449
7827
 
7450
7828
  """
7451
7829
 
7452
7830
  def __init__(self):
7453
7831
  r"""
7454
- :param _IntentionVerifyVideo: 意愿确认环节中录制的视频(base64)。若不存在则为空字符串。
7832
+ :param _IntentionVerifyVideo: 意愿确认环节中录制的视频(base64)。
7833
+ - 若不存在则为空字符串。
7455
7834
  注意:此字段可能返回 null,表示取不到有效值。
7456
7835
  :type IntentionVerifyVideo: str
7457
- :param _AsrResult: 意愿确认环节中用户语音转文字的识别结果。若不存在则为空字符串。
7836
+ :param _AsrResult: 意愿确认环节中用户语音转文字的识别结果。
7837
+ - 若不存在则为空字符串。
7458
7838
  注意:此字段可能返回 null,表示取不到有效值。
7459
7839
  :type AsrResult: str
7460
- :param _ErrorCode: 意愿确认环节的结果码。当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
7840
+ :param _ErrorCode: 意愿确认环节的结果码。
7841
+ - 当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
7461
7842
  注意:此字段可能返回 null,表示取不到有效值。
7462
7843
  :type ErrorCode: int
7463
7844
  :param _ErrorMessage: 意愿确认环节的结果信息。
7464
7845
  注意:此字段可能返回 null,表示取不到有效值。
7465
7846
  :type ErrorMessage: str
7466
- :param _IntentionVerifyBestFrame: 意愿确认环节中录制视频的最佳帧(base64)。若不存在则为空字符串。
7847
+ :param _IntentionVerifyBestFrame: 意愿确认环节中录制视频的最佳帧(base64)。
7848
+ - 若不存在则为空字符串。
7467
7849
  注意:此字段可能返回 null,表示取不到有效值。
7468
7850
  :type IntentionVerifyBestFrame: str
7469
7851
  :param _AsrResultSimilarity: 本次流程用户语音与传入文本比对的相似度分值,取值范围 [0.00, 100.00]。只有配置了相似度阈值后才进行语音校验并返回相似度分值。
@@ -7479,7 +7861,8 @@ class IntentionVerifyData(AbstractModel):
7479
7861
 
7480
7862
  @property
7481
7863
  def IntentionVerifyVideo(self):
7482
- """意愿确认环节中录制的视频(base64)。若不存在则为空字符串。
7864
+ """意愿确认环节中录制的视频(base64)。
7865
+ - 若不存在则为空字符串。
7483
7866
  注意:此字段可能返回 null,表示取不到有效值。
7484
7867
  :rtype: str
7485
7868
  """
@@ -7491,7 +7874,8 @@ class IntentionVerifyData(AbstractModel):
7491
7874
 
7492
7875
  @property
7493
7876
  def AsrResult(self):
7494
- """意愿确认环节中用户语音转文字的识别结果。若不存在则为空字符串。
7877
+ """意愿确认环节中用户语音转文字的识别结果。
7878
+ - 若不存在则为空字符串。
7495
7879
  注意:此字段可能返回 null,表示取不到有效值。
7496
7880
  :rtype: str
7497
7881
  """
@@ -7503,7 +7887,8 @@ class IntentionVerifyData(AbstractModel):
7503
7887
 
7504
7888
  @property
7505
7889
  def ErrorCode(self):
7506
- """意愿确认环节的结果码。当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
7890
+ """意愿确认环节的结果码。
7891
+ - 当该结果码为0时,语音朗读的视频与语音识别结果才会返回。
7507
7892
  注意:此字段可能返回 null,表示取不到有效值。
7508
7893
  :rtype: int
7509
7894
  """
@@ -7527,7 +7912,8 @@ class IntentionVerifyData(AbstractModel):
7527
7912
 
7528
7913
  @property
7529
7914
  def IntentionVerifyBestFrame(self):
7530
- """意愿确认环节中录制视频的最佳帧(base64)。若不存在则为空字符串。
7915
+ """意愿确认环节中录制视频的最佳帧(base64)。
7916
+ - 若不存在则为空字符串。
7531
7917
  注意:此字段可能返回 null,表示取不到有效值。
7532
7918
  :rtype: str
7533
7919
  """
@@ -7871,32 +8257,37 @@ class LivenessRecognitionRequest(AbstractModel):
7871
8257
 
7872
8258
  def __init__(self):
7873
8259
  r"""
7874
- :param _IdCard: 身份证号
8260
+ :param _IdCard: 身份证号。
7875
8261
  :type IdCard: str
7876
- :param _Name: 姓名。中文请使用UTF-8编码。
8262
+ :param _Name: 姓名。
8263
+ - 中文请使用UTF-8编码。
7877
8264
  :type Name: str
7878
- :param _LivenessType: 活体检测类型,取值:LIP/ACTION/SILENT。
7879
- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
8265
+ :param _LivenessType: 活体检测类型。
8266
+ - 取值:LIP/ACTION/SILENT
8267
+ - LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
7880
8268
  :type LivenessType: str
7881
8269
  :param _VideoBase64: 用于活体检测的视频,视频的BASE64值;
7882
8270
  BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
7883
8271
  :type VideoBase64: str
7884
- :param _VideoUrl: 用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
7885
-
7886
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
7887
-
7888
- 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
8272
+ :param _VideoUrl: 用于活体检测的视频Url 地址。
8273
+ - 视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
8274
+ - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
8275
+ - 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。
8276
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
7889
8277
  :type VideoUrl: str
7890
- :param _ValidateData: 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
7891
- 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
7892
- 静默模式传参:空。
8278
+ :param _ValidateData: 验证数据。
8279
+ - 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
8280
+ - 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
8281
+ - 静默模式传参:空。
7893
8282
  :type ValidateData: str
7894
8283
  :param _Optional: 额外配置,传入JSON字符串。
8284
+ - 格式如下:
7895
8285
  {
7896
8286
  "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
7897
8287
  }
7898
8288
  :type Optional: str
7899
- :param _Encryption: 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
8289
+ :param _Encryption: 敏感数据加密信息。
8290
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
7900
8291
  :type Encryption: :class:`tencentcloud.faceid.v20180301.models.Encryption`
7901
8292
  """
7902
8293
  self._IdCard = None
@@ -7910,7 +8301,7 @@ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
7910
8301
 
7911
8302
  @property
7912
8303
  def IdCard(self):
7913
- """身份证号
8304
+ """身份证号。
7914
8305
  :rtype: str
7915
8306
  """
7916
8307
  return self._IdCard
@@ -7921,7 +8312,8 @@ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
7921
8312
 
7922
8313
  @property
7923
8314
  def Name(self):
7924
- """姓名。中文请使用UTF-8编码。
8315
+ """姓名。
8316
+ - 中文请使用UTF-8编码。
7925
8317
  :rtype: str
7926
8318
  """
7927
8319
  return self._Name
@@ -7932,8 +8324,9 @@ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
7932
8324
 
7933
8325
  @property
7934
8326
  def LivenessType(self):
7935
- """活体检测类型,取值:LIP/ACTION/SILENT。
7936
- LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
8327
+ """活体检测类型。
8328
+ - 取值:LIP/ACTION/SILENT
8329
+ - LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
7937
8330
  :rtype: str
7938
8331
  """
7939
8332
  return self._LivenessType
@@ -7956,11 +8349,11 @@ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
7956
8349
 
7957
8350
  @property
7958
8351
  def VideoUrl(self):
7959
- """用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
7960
-
7961
- 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
7962
-
7963
- 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
8352
+ """用于活体检测的视频Url 地址。
8353
+ - 视频下载后经Base64编码不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
8354
+ - 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
8355
+ - 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。
8356
+ - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
7964
8357
  :rtype: str
7965
8358
  """
7966
8359
  return self._VideoUrl
@@ -7971,9 +8364,10 @@ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
7971
8364
 
7972
8365
  @property
7973
8366
  def ValidateData(self):
7974
- """数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
7975
- 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
7976
- 静默模式传参:空。
8367
+ """验证数据。
8368
+ - 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
8369
+ - 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
8370
+ - 静默模式传参:空。
7977
8371
  :rtype: str
7978
8372
  """
7979
8373
  return self._ValidateData
@@ -7985,6 +8379,7 @@ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
7985
8379
  @property
7986
8380
  def Optional(self):
7987
8381
  """额外配置,传入JSON字符串。
8382
+ - 格式如下:
7988
8383
  {
7989
8384
  "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
7990
8385
  }
@@ -7998,7 +8393,8 @@ BASE64编码后的大小不超过8M,支持mp4、avi、flv格式。
7998
8393
 
7999
8394
  @property
8000
8395
  def Encryption(self):
8001
- """敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
8396
+ """敏感数据加密信息。
8397
+ - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
8002
8398
  :rtype: :class:`tencentcloud.faceid.v20180301.models.Encryption`
8003
8399
  """
8004
8400
  return self._Encryption
@@ -8036,12 +8432,17 @@ class LivenessRecognitionResponse(AbstractModel):
8036
8432
 
8037
8433
  def __init__(self):
8038
8434
  r"""
8039
- :param _BestFrameBase64: 验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
8435
+ :param _BestFrameBase64: 验证通过后的视频最佳截图照片。
8436
+ - 照片为BASE64编码后的值,jpg格式。
8040
8437
  注意:此字段可能返回 null,表示取不到有效值。
8041
8438
  :type BestFrameBase64: str
8042
- :param _Sim: 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
8439
+ :param _Sim: 相似度。
8440
+ - 取值范围 [0.00, 100.00]。
8441
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
8043
8442
  :type Sim: float
8044
- :param _Result: 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
8443
+ :param _Result: 业务错误码。
8444
+ - 成功情况返回Success。
8445
+ - 错误情况请参考下方错误码 列表中FailedOperation部分
8045
8446
  :type Result: str
8046
8447
  :param _Description: 业务结果描述。
8047
8448
  :type Description: str
@@ -8060,7 +8461,8 @@ class LivenessRecognitionResponse(AbstractModel):
8060
8461
 
8061
8462
  @property
8062
8463
  def BestFrameBase64(self):
8063
- """验证通过后的视频最佳截图照片,照片为BASE64编码后的值,jpg格式。
8464
+ """验证通过后的视频最佳截图照片。
8465
+ - 照片为BASE64编码后的值,jpg格式。
8064
8466
  注意:此字段可能返回 null,表示取不到有效值。
8065
8467
  :rtype: str
8066
8468
  """
@@ -8072,7 +8474,9 @@ class LivenessRecognitionResponse(AbstractModel):
8072
8474
 
8073
8475
  @property
8074
8476
  def Sim(self):
8075
- """相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
8477
+ """相似度。
8478
+ - 取值范围 [0.00, 100.00]。
8479
+ - 推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
8076
8480
  :rtype: float
8077
8481
  """
8078
8482
  return self._Sim
@@ -8083,7 +8487,9 @@ class LivenessRecognitionResponse(AbstractModel):
8083
8487
 
8084
8488
  @property
8085
8489
  def Result(self):
8086
- """业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分
8490
+ """业务错误码。
8491
+ - 成功情况返回Success。
8492
+ - 错误情况请参考下方错误码 列表中FailedOperation部分
8087
8493
  :rtype: str
8088
8494
  """
8089
8495
  return self._Result
@@ -8849,14 +9255,14 @@ class ParseNfcDataRequest(AbstractModel):
8849
9255
 
8850
9256
  def __init__(self):
8851
9257
  r"""
8852
- :param _ReqId: 前端SDK返回
9258
+ :param _ReqId: 前端SDK返回。
8853
9259
  :type ReqId: str
8854
9260
  """
8855
9261
  self._ReqId = None
8856
9262
 
8857
9263
  @property
8858
9264
  def ReqId(self):
8859
- """前端SDK返回
9265
+ """前端SDK返回。
8860
9266
  :rtype: str
8861
9267
  """
8862
9268
  return self._ReqId
@@ -8885,66 +9291,85 @@ class ParseNfcDataResponse(AbstractModel):
8885
9291
 
8886
9292
  def __init__(self):
8887
9293
  r"""
8888
- :param _ResultCode: 0为首次查询成功,-1为查询失败。
9294
+ :param _ResultCode: 结果码。
9295
+ - 取值范围:0为首次查询成功,-1为查询失败。
8889
9296
  注意:此字段可能返回 null,表示取不到有效值。
8890
9297
  :type ResultCode: str
8891
- :param _IdNum: 身份证号
9298
+ :param _IdNum: 身份证号。
8892
9299
  注意:此字段可能返回 null,表示取不到有效值。
8893
9300
  :type IdNum: str
8894
- :param _Name: 姓名
9301
+ :param _Name: 姓名。
8895
9302
  注意:此字段可能返回 null,表示取不到有效值。
8896
9303
  :type Name: str
8897
- :param _Picture: 照片
9304
+ :param _Picture: 照片。
8898
9305
  注意:此字段可能返回 null,表示取不到有效值。
8899
9306
  :type Picture: str
8900
- :param _BirthDate: 出生日期
9307
+ :param _BirthDate: 出生日期。
8901
9308
  注意:此字段可能返回 null,表示取不到有效值。
8902
9309
  :type BirthDate: str
8903
- :param _BeginTime: 有效期起始时间
9310
+ :param _BeginTime: 有效期起始时间。
8904
9311
  注意:此字段可能返回 null,表示取不到有效值。
8905
9312
  :type BeginTime: str
8906
- :param _EndTime: 有效期结束时间
9313
+ :param _EndTime: 有效期结束时间。
8907
9314
  注意:此字段可能返回 null,表示取不到有效值。
8908
9315
  :type EndTime: str
8909
- :param _Address: 住址
9316
+ :param _Address: 住址。
8910
9317
  注意:此字段可能返回 null,表示取不到有效值。
8911
9318
  :type Address: str
8912
- :param _Nation: 民族
9319
+ :param _Nation: 民族。
8913
9320
  注意:此字段可能返回 null,表示取不到有效值。
8914
9321
  :type Nation: str
8915
- :param _Sex: 性别
9322
+ :param _Sex: 性别。
8916
9323
  注意:此字段可能返回 null,表示取不到有效值。
8917
9324
  :type Sex: str
8918
- :param _IdType: 身份证 01 中国护照 03 军官证 04 武警证 05 港澳通行证 06 台胞证 07 外国护照 08 士兵证 09 临时身份证 10 户口本 11 警官证 12 外国人永久居留证 13 港澳台居民居住证 14 回乡证 15 大陆居民来往台湾通行证 16 其他证件 99
9325
+ :param _IdType: 类型。
9326
+ - 取值范围:
9327
+ 01:身份证。
9328
+ 03 :中国护照。
9329
+ 04 :军官证。
9330
+ 05 :武警证。
9331
+ 06:港澳通行证 。
9332
+ 07 :台胞证 。
9333
+ 08:外国护照 。
9334
+ 09 :士兵证。
9335
+ 09 :临时身份证。
9336
+ 11:户口本 。
9337
+ 12 :警官证 。
9338
+ 13:外国人永久居留证。
9339
+ 14:港澳台居民居住证。
9340
+ 15:回乡证。
9341
+ 16:大陆居民来往台湾通行证。
9342
+ 99:其他证件。
8919
9343
  注意:此字段可能返回 null,表示取不到有效值。
8920
9344
  :type IdType: str
8921
- :param _EnName: 英文姓名
9345
+ :param _EnName: 英文姓名。
8922
9346
  注意:此字段可能返回 null,表示取不到有效值。
8923
9347
  :type EnName: str
8924
9348
  :param _SigningOrganization: 签发机关
8925
9349
  注意:此字段可能返回 null,表示取不到有效值。
8926
9350
  :type SigningOrganization: str
8927
- :param _OtherIdNum: 港澳台居民居住证,通行证号码
9351
+ :param _OtherIdNum: 港澳台居民居住证,通行证号码。
8928
9352
  注意:此字段可能返回 null,表示取不到有效值。
8929
9353
  :type OtherIdNum: str
8930
- :param _Nationality: 旅行证件国籍
9354
+ :param _Nationality: 旅行证件国籍。
8931
9355
  注意:此字段可能返回 null,表示取不到有效值。
8932
9356
  :type Nationality: str
8933
- :param _PersonalNumber: 旅行证件机读区第二行 29~42
9357
+ :param _PersonalNumber: 旅行证件机读区第二行 29~42 位。
8934
9358
  注意:此字段可能返回 null,表示取不到有效值。
8935
9359
  :type PersonalNumber: str
8936
- :param _CheckMRTD: 旅行证件类的核验结果。JSON格式如下:
8937
- {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"}
8938
- 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真
9360
+ :param _CheckMRTD: 旅行证件类的核验结果。
9361
+ - JSON格式如下:
9362
+ {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。
9363
+ - 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。
8939
9364
  注意:此字段可能返回 null,表示取不到有效值。
8940
9365
  :type CheckMRTD: str
8941
- :param _ImageA: 身份证照片面合成图片
9366
+ :param _ImageA: 身份证照片面合成图片。
8942
9367
  注意:此字段可能返回 null,表示取不到有效值。
8943
9368
  :type ImageA: str
8944
- :param _ImageB: 身份证国徽面合成图片
9369
+ :param _ImageB: 身份证国徽面合成图片。
8945
9370
  注意:此字段可能返回 null,表示取不到有效值。
8946
9371
  :type ImageB: str
8947
- :param _ResultDescription: 对result code的结果描述
9372
+ :param _ResultDescription: 对result code的结果描述。
8948
9373
  注意:此字段可能返回 null,表示取不到有效值。
8949
9374
  :type ResultDescription: str
8950
9375
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -8974,7 +9399,8 @@ class ParseNfcDataResponse(AbstractModel):
8974
9399
 
8975
9400
  @property
8976
9401
  def ResultCode(self):
8977
- """0为首次查询成功,-1为查询失败。
9402
+ """结果码。
9403
+ - 取值范围:0为首次查询成功,-1为查询失败。
8978
9404
  注意:此字段可能返回 null,表示取不到有效值。
8979
9405
  :rtype: str
8980
9406
  """
@@ -8986,7 +9412,7 @@ class ParseNfcDataResponse(AbstractModel):
8986
9412
 
8987
9413
  @property
8988
9414
  def IdNum(self):
8989
- """身份证号
9415
+ """身份证号。
8990
9416
  注意:此字段可能返回 null,表示取不到有效值。
8991
9417
  :rtype: str
8992
9418
  """
@@ -8998,7 +9424,7 @@ class ParseNfcDataResponse(AbstractModel):
8998
9424
 
8999
9425
  @property
9000
9426
  def Name(self):
9001
- """姓名
9427
+ """姓名。
9002
9428
  注意:此字段可能返回 null,表示取不到有效值。
9003
9429
  :rtype: str
9004
9430
  """
@@ -9010,7 +9436,7 @@ class ParseNfcDataResponse(AbstractModel):
9010
9436
 
9011
9437
  @property
9012
9438
  def Picture(self):
9013
- """照片
9439
+ """照片。
9014
9440
  注意:此字段可能返回 null,表示取不到有效值。
9015
9441
  :rtype: str
9016
9442
  """
@@ -9022,7 +9448,7 @@ class ParseNfcDataResponse(AbstractModel):
9022
9448
 
9023
9449
  @property
9024
9450
  def BirthDate(self):
9025
- """出生日期
9451
+ """出生日期。
9026
9452
  注意:此字段可能返回 null,表示取不到有效值。
9027
9453
  :rtype: str
9028
9454
  """
@@ -9034,7 +9460,7 @@ class ParseNfcDataResponse(AbstractModel):
9034
9460
 
9035
9461
  @property
9036
9462
  def BeginTime(self):
9037
- """有效期起始时间
9463
+ """有效期起始时间。
9038
9464
  注意:此字段可能返回 null,表示取不到有效值。
9039
9465
  :rtype: str
9040
9466
  """
@@ -9046,7 +9472,7 @@ class ParseNfcDataResponse(AbstractModel):
9046
9472
 
9047
9473
  @property
9048
9474
  def EndTime(self):
9049
- """有效期结束时间
9475
+ """有效期结束时间。
9050
9476
  注意:此字段可能返回 null,表示取不到有效值。
9051
9477
  :rtype: str
9052
9478
  """
@@ -9058,7 +9484,7 @@ class ParseNfcDataResponse(AbstractModel):
9058
9484
 
9059
9485
  @property
9060
9486
  def Address(self):
9061
- """住址
9487
+ """住址。
9062
9488
  注意:此字段可能返回 null,表示取不到有效值。
9063
9489
  :rtype: str
9064
9490
  """
@@ -9070,7 +9496,7 @@ class ParseNfcDataResponse(AbstractModel):
9070
9496
 
9071
9497
  @property
9072
9498
  def Nation(self):
9073
- """民族
9499
+ """民族。
9074
9500
  注意:此字段可能返回 null,表示取不到有效值。
9075
9501
  :rtype: str
9076
9502
  """
@@ -9082,7 +9508,7 @@ class ParseNfcDataResponse(AbstractModel):
9082
9508
 
9083
9509
  @property
9084
9510
  def Sex(self):
9085
- """性别
9511
+ """性别。
9086
9512
  注意:此字段可能返回 null,表示取不到有效值。
9087
9513
  :rtype: str
9088
9514
  """
@@ -9094,7 +9520,24 @@ class ParseNfcDataResponse(AbstractModel):
9094
9520
 
9095
9521
  @property
9096
9522
  def IdType(self):
9097
- """身份证 01 中国护照 03 军官证 04 武警证 05 港澳通行证 06 台胞证 07 外国护照 08 士兵证 09 临时身份证 10 户口本 11 警官证 12 外国人永久居留证 13 港澳台居民居住证 14 回乡证 15 大陆居民来往台湾通行证 16 其他证件 99
9523
+ """类型。
9524
+ - 取值范围:
9525
+ 01:身份证。
9526
+ 03 :中国护照。
9527
+ 04 :军官证。
9528
+ 05 :武警证。
9529
+ 06:港澳通行证 。
9530
+ 07 :台胞证 。
9531
+ 08:外国护照 。
9532
+ 09 :士兵证。
9533
+ 09 :临时身份证。
9534
+ 11:户口本 。
9535
+ 12 :警官证 。
9536
+ 13:外国人永久居留证。
9537
+ 14:港澳台居民居住证。
9538
+ 15:回乡证。
9539
+ 16:大陆居民来往台湾通行证。
9540
+ 99:其他证件。
9098
9541
  注意:此字段可能返回 null,表示取不到有效值。
9099
9542
  :rtype: str
9100
9543
  """
@@ -9106,7 +9549,7 @@ class ParseNfcDataResponse(AbstractModel):
9106
9549
 
9107
9550
  @property
9108
9551
  def EnName(self):
9109
- """英文姓名
9552
+ """英文姓名。
9110
9553
  注意:此字段可能返回 null,表示取不到有效值。
9111
9554
  :rtype: str
9112
9555
  """
@@ -9130,7 +9573,7 @@ class ParseNfcDataResponse(AbstractModel):
9130
9573
 
9131
9574
  @property
9132
9575
  def OtherIdNum(self):
9133
- """港澳台居民居住证,通行证号码
9576
+ """港澳台居民居住证,通行证号码。
9134
9577
  注意:此字段可能返回 null,表示取不到有效值。
9135
9578
  :rtype: str
9136
9579
  """
@@ -9142,7 +9585,7 @@ class ParseNfcDataResponse(AbstractModel):
9142
9585
 
9143
9586
  @property
9144
9587
  def Nationality(self):
9145
- """旅行证件国籍
9588
+ """旅行证件国籍。
9146
9589
  注意:此字段可能返回 null,表示取不到有效值。
9147
9590
  :rtype: str
9148
9591
  """
@@ -9154,7 +9597,7 @@ class ParseNfcDataResponse(AbstractModel):
9154
9597
 
9155
9598
  @property
9156
9599
  def PersonalNumber(self):
9157
- """旅行证件机读区第二行 29~42
9600
+ """旅行证件机读区第二行 29~42 位。
9158
9601
  注意:此字段可能返回 null,表示取不到有效值。
9159
9602
  :rtype: str
9160
9603
  """
@@ -9166,9 +9609,10 @@ class ParseNfcDataResponse(AbstractModel):
9166
9609
 
9167
9610
  @property
9168
9611
  def CheckMRTD(self):
9169
- """旅行证件类的核验结果。JSON格式如下:
9170
- {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"}
9171
- 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真
9612
+ """旅行证件类的核验结果。
9613
+ - JSON格式如下:
9614
+ {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。
9615
+ - 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。
9172
9616
  注意:此字段可能返回 null,表示取不到有效值。
9173
9617
  :rtype: str
9174
9618
  """
@@ -9180,7 +9624,7 @@ class ParseNfcDataResponse(AbstractModel):
9180
9624
 
9181
9625
  @property
9182
9626
  def ImageA(self):
9183
- """身份证照片面合成图片
9627
+ """身份证照片面合成图片。
9184
9628
  注意:此字段可能返回 null,表示取不到有效值。
9185
9629
  :rtype: str
9186
9630
  """
@@ -9192,7 +9636,7 @@ class ParseNfcDataResponse(AbstractModel):
9192
9636
 
9193
9637
  @property
9194
9638
  def ImageB(self):
9195
- """身份证国徽面合成图片
9639
+ """身份证国徽面合成图片。
9196
9640
  注意:此字段可能返回 null,表示取不到有效值。
9197
9641
  :rtype: str
9198
9642
  """
@@ -9204,7 +9648,7 @@ class ParseNfcDataResponse(AbstractModel):
9204
9648
 
9205
9649
  @property
9206
9650
  def ResultDescription(self):
9207
- """对result code的结果描述
9651
+ """对result code的结果描述。
9208
9652
  注意:此字段可能返回 null,表示取不到有效值。
9209
9653
  :rtype: str
9210
9654
  """