tencentcloud-sdk-python-intl-en 3.0.1118__py2.py3-none-any.whl → 3.0.1120__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.

Potentially problematic release.


This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.

tencentcloud/__init__.py CHANGED
@@ -13,4 +13,4 @@
13
13
  # See the License for the specific language governing permissions and
14
14
  # limitations under the License.
15
15
 
16
- __version__ = '3.0.1118'
16
+ __version__ = '3.0.1120'
@@ -72,6 +72,29 @@ class ConfigClient(AbstractClient):
72
72
  raise TencentCloudSDKException(type(e).__name__, str(e))
73
73
 
74
74
 
75
+ def ListAggregateDiscoveredResources(self, request):
76
+ """Account Group access the list of resources.
77
+
78
+ :param request: Request instance for ListAggregateDiscoveredResources.
79
+ :type request: :class:`tencentcloud.config.v20220802.models.ListAggregateDiscoveredResourcesRequest`
80
+ :rtype: :class:`tencentcloud.config.v20220802.models.ListAggregateDiscoveredResourcesResponse`
81
+
82
+ """
83
+ try:
84
+ params = request._serialize()
85
+ headers = request.headers
86
+ body = self.call("ListAggregateDiscoveredResources", params, headers=headers)
87
+ response = json.loads(body)
88
+ model = models.ListAggregateDiscoveredResourcesResponse()
89
+ model._deserialize(response["Response"])
90
+ return model
91
+ except Exception as e:
92
+ if isinstance(e, TencentCloudSDKException):
93
+ raise
94
+ else:
95
+ raise TencentCloudSDKException(type(e).__name__, str(e))
96
+
97
+
75
98
  def ListConfigRules(self, request):
76
99
  """This API is used to get the rule list.
77
100
 
@@ -14,6 +14,9 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
+ # Internal error.
18
+ INTERNALERROR = 'InternalError'
19
+
17
20
  # Parameter error.
18
21
  INVALIDPARAMETER = 'InvalidParameter'
19
22
 
@@ -18,6 +18,238 @@ import warnings
18
18
  from tencentcloud.common.abstract_model import AbstractModel
19
19
 
20
20
 
21
+ class AggregateResourceInfo(AbstractModel):
22
+ """Resource list information response parameters structure
23
+
24
+ """
25
+
26
+ def __init__(self):
27
+ r"""
28
+ :param _ResourceType: Resource type
29
+ :type ResourceType: str
30
+ :param _ResourceName: Resource name
31
+ :type ResourceName: str
32
+ :param _ResourceId: Resource ID
33
+ :type ResourceId: str
34
+ :param _ResourceRegion: Region
35
+
36
+ Note: This field may return null, indicating that no valid value is found.
37
+ :type ResourceRegion: str
38
+ :param _ResourceStatus: Resource Status
39
+
40
+ Note: This field may return null, indicating that no valid value is found.
41
+ :type ResourceStatus: str
42
+ :param _ResourceDelete: Whether to delete. 1: Deleted; 0: Not deleted.
43
+ Note: This field may return null, indicating that no valid value is found.
44
+ :type ResourceDelete: int
45
+ :param _ResourceCreateTime: Resource creation time
46
+
47
+ Note: This field may return null, indicating that no valid value is found.
48
+ :type ResourceCreateTime: str
49
+ :param _Tags: Tag information
50
+
51
+ Note: This field may return null, indicating that no valid value is found.
52
+ :type Tags: list of Tag
53
+ :param _ResourceZone: Availability zone
54
+
55
+ Note: This field may return null, indicating that no valid value is found.
56
+ :type ResourceZone: str
57
+ :param _ComplianceResult: Compliance status
58
+ Note: This field may return null, indicating that no valid value is found.
59
+ :type ComplianceResult: str
60
+ :param _ResourceOwnerId: Resource owner uid
61
+ :type ResourceOwnerId: int
62
+ :param _ResourceOwnerName: User nickname
63
+ Note: This field may return null, indicating that no valid value is found.
64
+ :type ResourceOwnerName: str
65
+ """
66
+ self._ResourceType = None
67
+ self._ResourceName = None
68
+ self._ResourceId = None
69
+ self._ResourceRegion = None
70
+ self._ResourceStatus = None
71
+ self._ResourceDelete = None
72
+ self._ResourceCreateTime = None
73
+ self._Tags = None
74
+ self._ResourceZone = None
75
+ self._ComplianceResult = None
76
+ self._ResourceOwnerId = None
77
+ self._ResourceOwnerName = None
78
+
79
+ @property
80
+ def ResourceType(self):
81
+ """Resource type
82
+ :rtype: str
83
+ """
84
+ return self._ResourceType
85
+
86
+ @ResourceType.setter
87
+ def ResourceType(self, ResourceType):
88
+ self._ResourceType = ResourceType
89
+
90
+ @property
91
+ def ResourceName(self):
92
+ """Resource name
93
+ :rtype: str
94
+ """
95
+ return self._ResourceName
96
+
97
+ @ResourceName.setter
98
+ def ResourceName(self, ResourceName):
99
+ self._ResourceName = ResourceName
100
+
101
+ @property
102
+ def ResourceId(self):
103
+ """Resource ID
104
+ :rtype: str
105
+ """
106
+ return self._ResourceId
107
+
108
+ @ResourceId.setter
109
+ def ResourceId(self, ResourceId):
110
+ self._ResourceId = ResourceId
111
+
112
+ @property
113
+ def ResourceRegion(self):
114
+ """Region
115
+
116
+ Note: This field may return null, indicating that no valid value is found.
117
+ :rtype: str
118
+ """
119
+ return self._ResourceRegion
120
+
121
+ @ResourceRegion.setter
122
+ def ResourceRegion(self, ResourceRegion):
123
+ self._ResourceRegion = ResourceRegion
124
+
125
+ @property
126
+ def ResourceStatus(self):
127
+ """Resource Status
128
+
129
+ Note: This field may return null, indicating that no valid value is found.
130
+ :rtype: str
131
+ """
132
+ return self._ResourceStatus
133
+
134
+ @ResourceStatus.setter
135
+ def ResourceStatus(self, ResourceStatus):
136
+ self._ResourceStatus = ResourceStatus
137
+
138
+ @property
139
+ def ResourceDelete(self):
140
+ """Whether to delete. 1: Deleted; 0: Not deleted.
141
+ Note: This field may return null, indicating that no valid value is found.
142
+ :rtype: int
143
+ """
144
+ return self._ResourceDelete
145
+
146
+ @ResourceDelete.setter
147
+ def ResourceDelete(self, ResourceDelete):
148
+ self._ResourceDelete = ResourceDelete
149
+
150
+ @property
151
+ def ResourceCreateTime(self):
152
+ """Resource creation time
153
+
154
+ Note: This field may return null, indicating that no valid value is found.
155
+ :rtype: str
156
+ """
157
+ return self._ResourceCreateTime
158
+
159
+ @ResourceCreateTime.setter
160
+ def ResourceCreateTime(self, ResourceCreateTime):
161
+ self._ResourceCreateTime = ResourceCreateTime
162
+
163
+ @property
164
+ def Tags(self):
165
+ """Tag information
166
+
167
+ Note: This field may return null, indicating that no valid value is found.
168
+ :rtype: list of Tag
169
+ """
170
+ return self._Tags
171
+
172
+ @Tags.setter
173
+ def Tags(self, Tags):
174
+ self._Tags = Tags
175
+
176
+ @property
177
+ def ResourceZone(self):
178
+ """Availability zone
179
+
180
+ Note: This field may return null, indicating that no valid value is found.
181
+ :rtype: str
182
+ """
183
+ return self._ResourceZone
184
+
185
+ @ResourceZone.setter
186
+ def ResourceZone(self, ResourceZone):
187
+ self._ResourceZone = ResourceZone
188
+
189
+ @property
190
+ def ComplianceResult(self):
191
+ """Compliance status
192
+ Note: This field may return null, indicating that no valid value is found.
193
+ :rtype: str
194
+ """
195
+ return self._ComplianceResult
196
+
197
+ @ComplianceResult.setter
198
+ def ComplianceResult(self, ComplianceResult):
199
+ self._ComplianceResult = ComplianceResult
200
+
201
+ @property
202
+ def ResourceOwnerId(self):
203
+ """Resource owner uid
204
+ :rtype: int
205
+ """
206
+ return self._ResourceOwnerId
207
+
208
+ @ResourceOwnerId.setter
209
+ def ResourceOwnerId(self, ResourceOwnerId):
210
+ self._ResourceOwnerId = ResourceOwnerId
211
+
212
+ @property
213
+ def ResourceOwnerName(self):
214
+ """User nickname
215
+ Note: This field may return null, indicating that no valid value is found.
216
+ :rtype: str
217
+ """
218
+ return self._ResourceOwnerName
219
+
220
+ @ResourceOwnerName.setter
221
+ def ResourceOwnerName(self, ResourceOwnerName):
222
+ self._ResourceOwnerName = ResourceOwnerName
223
+
224
+
225
+ def _deserialize(self, params):
226
+ self._ResourceType = params.get("ResourceType")
227
+ self._ResourceName = params.get("ResourceName")
228
+ self._ResourceId = params.get("ResourceId")
229
+ self._ResourceRegion = params.get("ResourceRegion")
230
+ self._ResourceStatus = params.get("ResourceStatus")
231
+ self._ResourceDelete = params.get("ResourceDelete")
232
+ self._ResourceCreateTime = params.get("ResourceCreateTime")
233
+ if params.get("Tags") is not None:
234
+ self._Tags = []
235
+ for item in params.get("Tags"):
236
+ obj = Tag()
237
+ obj._deserialize(item)
238
+ self._Tags.append(obj)
239
+ self._ResourceZone = params.get("ResourceZone")
240
+ self._ComplianceResult = params.get("ComplianceResult")
241
+ self._ResourceOwnerId = params.get("ResourceOwnerId")
242
+ self._ResourceOwnerName = params.get("ResourceOwnerName")
243
+ memeber_set = set(params.keys())
244
+ for name, value in vars(self).items():
245
+ property_name = name[1:]
246
+ if property_name in memeber_set:
247
+ memeber_set.remove(property_name)
248
+ if len(memeber_set) > 0:
249
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
250
+
251
+
252
+
21
253
  class Annotation(AbstractModel):
22
254
  """Compliance details
23
255
 
@@ -1488,6 +1720,192 @@ class ListAggregateConfigRulesResponse(AbstractModel):
1488
1720
  self._RequestId = params.get("RequestId")
1489
1721
 
1490
1722
 
1723
+ class ListAggregateDiscoveredResourcesRequest(AbstractModel):
1724
+ """ListAggregateDiscoveredResources request structure.
1725
+
1726
+ """
1727
+
1728
+ def __init__(self):
1729
+ r"""
1730
+ :param _MaxResults: Items per Page
1731
+ :type MaxResults: int
1732
+ :param _AccountGroupId: Account group ID
1733
+ :type AccountGroupId: str
1734
+ :param _Filters: resourceName: Resource name; resourceId: Resource ID; resourceType: Resource type
1735
+ :type Filters: list of Filter
1736
+ :param _Tags: <Tag>
1737
+ :type Tags: list of Tag
1738
+ :param _NextToken: Next page token.
1739
+ :type NextToken: str
1740
+ :param _OrderType: Sorting method asc, desc
1741
+ :type OrderType: str
1742
+ """
1743
+ self._MaxResults = None
1744
+ self._AccountGroupId = None
1745
+ self._Filters = None
1746
+ self._Tags = None
1747
+ self._NextToken = None
1748
+ self._OrderType = None
1749
+
1750
+ @property
1751
+ def MaxResults(self):
1752
+ """Items per Page
1753
+ :rtype: int
1754
+ """
1755
+ return self._MaxResults
1756
+
1757
+ @MaxResults.setter
1758
+ def MaxResults(self, MaxResults):
1759
+ self._MaxResults = MaxResults
1760
+
1761
+ @property
1762
+ def AccountGroupId(self):
1763
+ """Account group ID
1764
+ :rtype: str
1765
+ """
1766
+ return self._AccountGroupId
1767
+
1768
+ @AccountGroupId.setter
1769
+ def AccountGroupId(self, AccountGroupId):
1770
+ self._AccountGroupId = AccountGroupId
1771
+
1772
+ @property
1773
+ def Filters(self):
1774
+ """resourceName: Resource name; resourceId: Resource ID; resourceType: Resource type
1775
+ :rtype: list of Filter
1776
+ """
1777
+ return self._Filters
1778
+
1779
+ @Filters.setter
1780
+ def Filters(self, Filters):
1781
+ self._Filters = Filters
1782
+
1783
+ @property
1784
+ def Tags(self):
1785
+ """<Tag>
1786
+ :rtype: list of Tag
1787
+ """
1788
+ return self._Tags
1789
+
1790
+ @Tags.setter
1791
+ def Tags(self, Tags):
1792
+ self._Tags = Tags
1793
+
1794
+ @property
1795
+ def NextToken(self):
1796
+ """Next page token.
1797
+ :rtype: str
1798
+ """
1799
+ return self._NextToken
1800
+
1801
+ @NextToken.setter
1802
+ def NextToken(self, NextToken):
1803
+ self._NextToken = NextToken
1804
+
1805
+ @property
1806
+ def OrderType(self):
1807
+ """Sorting method asc, desc
1808
+ :rtype: str
1809
+ """
1810
+ return self._OrderType
1811
+
1812
+ @OrderType.setter
1813
+ def OrderType(self, OrderType):
1814
+ self._OrderType = OrderType
1815
+
1816
+
1817
+ def _deserialize(self, params):
1818
+ self._MaxResults = params.get("MaxResults")
1819
+ self._AccountGroupId = params.get("AccountGroupId")
1820
+ if params.get("Filters") is not None:
1821
+ self._Filters = []
1822
+ for item in params.get("Filters"):
1823
+ obj = Filter()
1824
+ obj._deserialize(item)
1825
+ self._Filters.append(obj)
1826
+ if params.get("Tags") is not None:
1827
+ self._Tags = []
1828
+ for item in params.get("Tags"):
1829
+ obj = Tag()
1830
+ obj._deserialize(item)
1831
+ self._Tags.append(obj)
1832
+ self._NextToken = params.get("NextToken")
1833
+ self._OrderType = params.get("OrderType")
1834
+ memeber_set = set(params.keys())
1835
+ for name, value in vars(self).items():
1836
+ property_name = name[1:]
1837
+ if property_name in memeber_set:
1838
+ memeber_set.remove(property_name)
1839
+ if len(memeber_set) > 0:
1840
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
1841
+
1842
+
1843
+
1844
+ class ListAggregateDiscoveredResourcesResponse(AbstractModel):
1845
+ """ListAggregateDiscoveredResources response structure.
1846
+
1847
+ """
1848
+
1849
+ def __init__(self):
1850
+ r"""
1851
+ :param _Items: Details.
1852
+ :type Items: list of AggregateResourceInfo
1853
+ :param _NextToken: next page
1854
+ Note: This field may return null, indicating that no valid value is found.
1855
+ :type NextToken: str
1856
+ :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1857
+ :type RequestId: str
1858
+ """
1859
+ self._Items = None
1860
+ self._NextToken = None
1861
+ self._RequestId = None
1862
+
1863
+ @property
1864
+ def Items(self):
1865
+ """Details.
1866
+ :rtype: list of AggregateResourceInfo
1867
+ """
1868
+ return self._Items
1869
+
1870
+ @Items.setter
1871
+ def Items(self, Items):
1872
+ self._Items = Items
1873
+
1874
+ @property
1875
+ def NextToken(self):
1876
+ """next page
1877
+ Note: This field may return null, indicating that no valid value is found.
1878
+ :rtype: str
1879
+ """
1880
+ return self._NextToken
1881
+
1882
+ @NextToken.setter
1883
+ def NextToken(self, NextToken):
1884
+ self._NextToken = NextToken
1885
+
1886
+ @property
1887
+ def RequestId(self):
1888
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1889
+ :rtype: str
1890
+ """
1891
+ return self._RequestId
1892
+
1893
+ @RequestId.setter
1894
+ def RequestId(self, RequestId):
1895
+ self._RequestId = RequestId
1896
+
1897
+
1898
+ def _deserialize(self, params):
1899
+ if params.get("Items") is not None:
1900
+ self._Items = []
1901
+ for item in params.get("Items"):
1902
+ obj = AggregateResourceInfo()
1903
+ obj._deserialize(item)
1904
+ self._Items.append(obj)
1905
+ self._NextToken = params.get("NextToken")
1906
+ self._RequestId = params.get("RequestId")
1907
+
1908
+
1491
1909
  class ListConfigRulesRequest(AbstractModel):
1492
1910
  """ListConfigRules request structure.
1493
1911
 
@@ -56,6 +56,9 @@ FAILEDOPERATION_COMPARELOWSIMILARITY = 'FailedOperation.CompareLowSimilarity'
56
56
  # Error calling the comparison engine API.
57
57
  FAILEDOPERATION_COMPARESYSTEMERROR = 'FailedOperation.CompareSystemError'
58
58
 
59
+ # The video compression failed. Please try again or reduce the size of the input video.
60
+ FAILEDOPERATION_COMPRESSVIDEOERROR = 'FailedOperation.CompressVideoError'
61
+
59
62
  # The face in the picture is blocked, please upload a picture without any blockage
60
63
  FAILEDOPERATION_COVEREDFACE = 'FailedOperation.CoveredFace'
61
64
 
@@ -182,6 +185,9 @@ FAILEDOPERATION_UNOPENERROR = 'FailedOperation.UnOpenError'
182
185
  # Video decoding abnormality
183
186
  FAILEDOPERATION_VIDEODECODEFAILED = 'FailedOperation.VideoDecodeFailed'
184
187
 
188
+ #
189
+ FAILEDOPERATION_VIDEODURATIONEXCEEDED = 'FailedOperation.VideoDurationExceeded'
190
+
185
191
  # Internal error.
186
192
  INTERNALERROR = 'InternalError'
187
193
 
@@ -74,7 +74,7 @@ class FaceidClient(AbstractClient):
74
74
 
75
75
 
76
76
  def ApplySdkVerificationToken(self, request):
77
- """This API is used to apply for a token before calling the Identity Verification SDK service each time. This token is required for initiating the verification process and getting the result after the verification is completed.
77
+ """This API is used to apply for a token before calling the eKYC SDK service each time. This token is required for initiating the verification process and getting the result after the verification is completed.
78
78
 
79
79
  :param request: Request instance for ApplySdkVerificationToken.
80
80
  :type request: :class:`tencentcloud.faceid.v20180301.models.ApplySdkVerificationTokenRequest`
@@ -237,7 +237,7 @@ class FaceidClient(AbstractClient):
237
237
 
238
238
 
239
239
  def GenerateReflectSequence(self, request):
240
- """This API is used to generate an appropriate light sequence based on the information collected by the liveness comparison (reflection-based) SDK and pass the light sequence into the SDK to start the identity verification process.
240
+ """This API is used to generate an appropriate light sequence based on the information collected by the liveness comparison (reflection-based) SDK and pass the light sequence into the SDK to start the eKYC process.
241
241
  The data generated with the SDK must be stored in COS, and the region of the COS bucket must be same as that of requests made with this API. We recommend that you pass resources with upload link APIs.
242
242
 
243
243
  :param request: Request instance for GenerateReflectSequence.
@@ -307,7 +307,7 @@ class FaceidClient(AbstractClient):
307
307
 
308
308
 
309
309
  def GetFaceIdTokenIntl(self, request):
310
- """This API is used to apply for an SDK token before calling the liveness detection and face comparison SDK each time. The SDK token is used throughout the identity verification process and to get the verification result after the verification is completed. A token is valid for one identity verification process only.
310
+ """This API is used to apply for an SDK token before calling the selfie verification SDK each time. The SDK token is used throughout the eKYC process and to get the verification result after the verification is completed. A token is valid for one eKYC process only.
311
311
 
312
312
  :param request: Request instance for GetFaceIdTokenIntl.
313
313
  :type request: :class:`tencentcloud.faceid.v20180301.models.GetFaceIdTokenIntlRequest`
@@ -2077,31 +2077,25 @@ class CompareFaceLivenessRequest(AbstractModel):
2077
2077
 
2078
2078
  def __init__(self):
2079
2079
  r"""
2080
- :param _ImageBase64: Base64 value of photos used for face comparison.
2081
- The size of image data encoded by Base64 shall not exceed 3M, only jpg and png are supported.
2082
- Please use standard Base64 encoding (use = for padding). Refer to RFC4648 for encoding specifications.
2083
- Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
2080
+ :param _ImageBase64: Base64 string of the image for face comparison.
2081
+ - The size of the Base64-encoded image data can be up to 3 MB. JPG and PNG formats are supported.
2082
+ - Please use the standard Base64 encoding method (with = padding). Refer to RFC4648 for the encoding specification.
2084
2083
  :type ImageBase64: str
2085
- :param _VideoBase64: Base64 value of videos used for face comparison.
2086
- The size of videos data encoded by Base64 shall not exceed 8M, only mp4,avi,flv are supported.
2087
- Please use standard Base64 encoding (use = for padding). Refer to RFC4648 for encoding specifications.
2088
- Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
2084
+ :param _VideoBase64: Base64 string of the video for liveness detection.
2085
+ - The size of the Base64-encoded video data can be up to 8 MB. MP4, AVI, and FLV formats are supported.
2086
+ -Use standard Base64 encoding (with = padding), following RFC4648.
2089
2087
  :type VideoBase64: str
2090
- :param _LivenessType: The liveness detection type. Valid values: `ACTION`, and `SILENT`.
2091
- `ACTION`: Motion mode; `SILENT`: silent mode. Select one of them.
2092
- Example value: "SILENT"
2088
+ :param _LivenessType: Liveness detection type.
2089
+ -Values:
2090
+ ACTION is action mode.
2091
+ SILENT is silent mode.
2092
+ -Choose one of the two modes to pass in.
2093
2093
  :type LivenessType: str
2094
- :param _ValidateData: When the "LivenessType" parameter is "ACTION", it must be specified.
2095
- It is used to control the action sequence. Action types:
2096
- 1 (open mouth)
2097
- 2 (blink)
2098
- 3 (nod)
2099
- 4 (shake head).
2100
- Select one or two from the four actions.
2101
- Example of passing single action parameter: "1".
2102
- Example of passing multiple action parameters: "4,2".
2103
- When the "LivenessType" parameter value is "SILENT", it shall be unspecified.
2104
- Example value: ""
2094
+ :param _ValidateData: Control the action sequence. Action types include: 1 (open mouth), 2 (blink), 3 (nod), 4 (shake head). Supports one or two actions.
2095
+ -Required when the LivenessType parameter is set to ACTION.
2096
+ -Single action example: "1".
2097
+ -Multiple actions parameter passing example: "4,2".
2098
+ -When the LivenessType parameter is set to SILENT, leave it blank.
2105
2099
  :type ValidateData: str
2106
2100
  """
2107
2101
  self._ImageBase64 = None
@@ -2111,10 +2105,9 @@ Example value: ""
2111
2105
 
2112
2106
  @property
2113
2107
  def ImageBase64(self):
2114
- """Base64 value of photos used for face comparison.
2115
- The size of image data encoded by Base64 shall not exceed 3M, only jpg and png are supported.
2116
- Please use standard Base64 encoding (use = for padding). Refer to RFC4648 for encoding specifications.
2117
- Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
2108
+ """Base64 string of the image for face comparison.
2109
+ - The size of the Base64-encoded image data can be up to 3 MB. JPG and PNG formats are supported.
2110
+ - Please use the standard Base64 encoding method (with = padding). Refer to RFC4648 for the encoding specification.
2118
2111
  :rtype: str
2119
2112
  """
2120
2113
  return self._ImageBase64
@@ -2125,10 +2118,9 @@ Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
2125
2118
 
2126
2119
  @property
2127
2120
  def VideoBase64(self):
2128
- """Base64 value of videos used for face comparison.
2129
- The size of videos data encoded by Base64 shall not exceed 8M, only mp4,avi,flv are supported.
2130
- Please use standard Base64 encoding (use = for padding). Refer to RFC4648 for encoding specifications.
2131
- Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
2121
+ """Base64 string of the video for liveness detection.
2122
+ - The size of the Base64-encoded video data can be up to 8 MB. MP4, AVI, and FLV formats are supported.
2123
+ -Use standard Base64 encoding (with = padding), following RFC4648.
2132
2124
  :rtype: str
2133
2125
  """
2134
2126
  return self._VideoBase64
@@ -2139,9 +2131,11 @@ Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
2139
2131
 
2140
2132
  @property
2141
2133
  def LivenessType(self):
2142
- """The liveness detection type. Valid values: `ACTION`, and `SILENT`.
2143
- `ACTION`: Motion mode; `SILENT`: silent mode. Select one of them.
2144
- Example value: "SILENT"
2134
+ """Liveness detection type.
2135
+ -Values:
2136
+ ACTION is action mode.
2137
+ SILENT is silent mode.
2138
+ -Choose one of the two modes to pass in.
2145
2139
  :rtype: str
2146
2140
  """
2147
2141
  return self._LivenessType
@@ -2152,17 +2146,11 @@ Example value: "SILENT"
2152
2146
 
2153
2147
  @property
2154
2148
  def ValidateData(self):
2155
- """When the "LivenessType" parameter is "ACTION", it must be specified.
2156
- It is used to control the action sequence. Action types:
2157
- 1 (open mouth)
2158
- 2 (blink)
2159
- 3 (nod)
2160
- 4 (shake head).
2161
- Select one or two from the four actions.
2162
- Example of passing single action parameter: "1".
2163
- Example of passing multiple action parameters: "4,2".
2164
- When the "LivenessType" parameter value is "SILENT", it shall be unspecified.
2165
- Example value: ""
2149
+ """Control the action sequence. Action types include: 1 (open mouth), 2 (blink), 3 (nod), 4 (shake head). Supports one or two actions.
2150
+ -Required when the LivenessType parameter is set to ACTION.
2151
+ -Single action example: "1".
2152
+ -Multiple actions parameter passing example: "4,2".
2153
+ -When the LivenessType parameter is set to SILENT, leave it blank.
2166
2154
  :rtype: str
2167
2155
  """
2168
2156
  return self._ValidateData
@@ -2194,17 +2182,19 @@ class CompareFaceLivenessResponse(AbstractModel):
2194
2182
 
2195
2183
  def __init__(self):
2196
2184
  r"""
2197
- :param _Result: Service error code. When the return value is "Success", it indicates that the liveness detection and face comparison succeeded. It is determined that they are the same person. When the return value is "FailedOperation.CompareLowSimilarity", it indicates that the liveness detection succeeded, and the face comparison similarity is lower than 70 points. It is determined that they are not the same person. For other error cases, please refer to Liveness Face Comparison (Pure API) Error Code (https://www.tencentcloud.com/document/product/1061/55390).
2198
- Example Value: "Success".
2185
+ :param _Result: Business Error Codes.
2186
+ -When the return value is "Success", it indicates that liveness detection and face comparison passed. Determined to be the same person.
2187
+ -When the return value is "FailedOperation.CompareLowSimilarity", it indicates that liveness detection passed, but face comparison similarity is below 70. Determined not to be the same person.
2188
+ -For other error cases, please refer to [Liveness Face Comparison (API only) Error Codes](https://www.tencentcloud.com/zh/document/product/1061/55390?lang=zh&pg=#97df7537-87fe-4266-87e9-02c816d41ee2)
2199
2189
  :type Result: str
2200
- :param _Description: Description of business results.
2201
- Example value: "Success"
2190
+ :param _Description: The service result description
2202
2191
  :type Description: str
2203
- :param _Sim: This value is valid when the "Result" parameter is "Success" or "FailedOperation.CompareLowSimilarity."
2204
- This value indicates the similarity of face comparison. Value range: [0.00, 100.00]. The false pass rate for threshold 70 is 1 in 1,000, and the false pass rate for threshold 80 is 1 in 10,000.
2205
- Example value: 80.00
2192
+ :param _Sim: This value indicates the similarity of face comparison. Value range: 0.00-100.00.
2193
+ - The false acceptance rate for a threshold of 70 is 0.1%, and for a threshold of 80, it is 0.01%.
2194
+ - This value is valid when the Result parameter is "Success" or "FailedOperation.CompareLowSimilarity".
2206
2195
  :type Sim: float
2207
- :param _BestFrameBase64: The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format.
2196
+ :param _BestFrameBase64: The best screenshot photo from the video after verification, encoded in BASE64, in jpg format.
2197
+ The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format.
2208
2198
  Note: This field may return "null", indicating that no valid value can be obtained.
2209
2199
  Example values: "/9j/4AAQSk... (total length:142036)s97n//2Q=="
2210
2200
  :type BestFrameBase64: str
@@ -2219,8 +2209,10 @@ Example values: "/9j/4AAQSk... (total length:142036)s97n//2Q=="
2219
2209
 
2220
2210
  @property
2221
2211
  def Result(self):
2222
- """Service error code. When the return value is "Success", it indicates that the liveness detection and face comparison succeeded. It is determined that they are the same person. When the return value is "FailedOperation.CompareLowSimilarity", it indicates that the liveness detection succeeded, and the face comparison similarity is lower than 70 points. It is determined that they are not the same person. For other error cases, please refer to Liveness Face Comparison (Pure API) Error Code (https://www.tencentcloud.com/document/product/1061/55390).
2223
- Example Value: "Success".
2212
+ """Business Error Codes.
2213
+ -When the return value is "Success", it indicates that liveness detection and face comparison passed. Determined to be the same person.
2214
+ -When the return value is "FailedOperation.CompareLowSimilarity", it indicates that liveness detection passed, but face comparison similarity is below 70. Determined not to be the same person.
2215
+ -For other error cases, please refer to [Liveness Face Comparison (API only) Error Codes](https://www.tencentcloud.com/zh/document/product/1061/55390?lang=zh&pg=#97df7537-87fe-4266-87e9-02c816d41ee2)
2224
2216
  :rtype: str
2225
2217
  """
2226
2218
  return self._Result
@@ -2231,8 +2223,7 @@ Example Value: "Success".
2231
2223
 
2232
2224
  @property
2233
2225
  def Description(self):
2234
- """Description of business results.
2235
- Example value: "Success"
2226
+ """The service result description
2236
2227
  :rtype: str
2237
2228
  """
2238
2229
  return self._Description
@@ -2243,9 +2234,9 @@ Example value: "Success"
2243
2234
 
2244
2235
  @property
2245
2236
  def Sim(self):
2246
- """This value is valid when the "Result" parameter is "Success" or "FailedOperation.CompareLowSimilarity."
2247
- This value indicates the similarity of face comparison. Value range: [0.00, 100.00]. The false pass rate for threshold 70 is 1 in 1,000, and the false pass rate for threshold 80 is 1 in 10,000.
2248
- Example value: 80.00
2237
+ """This value indicates the similarity of face comparison. Value range: 0.00-100.00.
2238
+ - The false acceptance rate for a threshold of 70 is 0.1%, and for a threshold of 80, it is 0.01%.
2239
+ - This value is valid when the Result parameter is "Success" or "FailedOperation.CompareLowSimilarity".
2249
2240
  :rtype: float
2250
2241
  """
2251
2242
  return self._Sim
@@ -2256,7 +2247,8 @@ Example value: 80.00
2256
2247
 
2257
2248
  @property
2258
2249
  def BestFrameBase64(self):
2259
- """The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format.
2250
+ """The best screenshot photo from the video after verification, encoded in BASE64, in jpg format.
2251
+ The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format.
2260
2252
  Note: This field may return "null", indicating that no valid value can be obtained.
2261
2253
  Example values: "/9j/4AAQSk... (total length:142036)s97n//2Q=="
2262
2254
  :rtype: str
@@ -3738,7 +3730,7 @@ class GenerateReflectSequenceResponse(AbstractModel):
3738
3730
 
3739
3731
  def __init__(self):
3740
3732
  r"""
3741
- :param _ReflectSequenceUrl: The resource URL of the light sequence, which needs to be downloaded and passed through to the SDK to start the identity verification process.
3733
+ :param _ReflectSequenceUrl: The resource URL of the light sequence, which needs to be downloaded and passed through to the SDK to start the eKYC process.
3742
3734
  :type ReflectSequenceUrl: str
3743
3735
  :param _ReflectSequenceMd5: The MD5 hash value of the light sequence, which is used to check whether the light sequence is altered.
3744
3736
  :type ReflectSequenceMd5: str
@@ -3751,7 +3743,7 @@ class GenerateReflectSequenceResponse(AbstractModel):
3751
3743
 
3752
3744
  @property
3753
3745
  def ReflectSequenceUrl(self):
3754
- """The resource URL of the light sequence, which needs to be downloaded and passed through to the SDK to start the identity verification process.
3746
+ """The resource URL of the light sequence, which needs to be downloaded and passed through to the SDK to start the eKYC process.
3755
3747
  :rtype: str
3756
3748
  """
3757
3749
  return self._ReflectSequenceUrl
@@ -3993,14 +3985,14 @@ class GetFaceIdResultIntlRequest(AbstractModel):
3993
3985
 
3994
3986
  def __init__(self):
3995
3987
  r"""
3996
- :param _SdkToken: The ID of the SDK-based liveness detection and face comparison process, which is generated when the `GetFaceIdTokenIntl` API is called.
3988
+ :param _SdkToken: The ID of the SDK-based selfie verification process, which is generated when the `GetFaceIdTokenIntl` API is called.
3997
3989
  :type SdkToken: str
3998
3990
  """
3999
3991
  self._SdkToken = None
4000
3992
 
4001
3993
  @property
4002
3994
  def SdkToken(self):
4003
- """The ID of the SDK-based liveness detection and face comparison process, which is generated when the `GetFaceIdTokenIntl` API is called.
3995
+ """The ID of the SDK-based selfie verification process, which is generated when the `GetFaceIdTokenIntl` API is called.
4004
3996
  :rtype: str
4005
3997
  """
4006
3998
  return self._SdkToken
@@ -4032,7 +4024,7 @@ class GetFaceIdResultIntlResponse(AbstractModel):
4032
4024
  :param _Result: The return code of the verification result.
4033
4025
  0: Succeeded.
4034
4026
  1001: System error.
4035
- 1004: Liveness detection and face comparison failed.
4027
+ 1004: Selfie verification comparison failed.
4036
4028
  2004: The image passed in is too large or too small.
4037
4029
  2012: Several faces were detected.
4038
4030
  2013: No face was detected, or the face detected was incomplete.
@@ -4047,7 +4039,7 @@ class GetFaceIdResultIntlResponse(AbstractModel):
4047
4039
  :type BestFrame: str
4048
4040
  :param _Video: The video file (Base64) for verification.
4049
4041
  :type Video: str
4050
- :param _Similarity: The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (liveness detection and face comparison) mode.
4042
+ :param _Similarity: The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (selfie verification) mode.
4051
4043
  Note: This field may return `null`, indicating that no valid values can be obtained.
4052
4044
  :type Similarity: float
4053
4045
  :param _Extra: The pass-through parameter.
@@ -4069,7 +4061,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
4069
4061
  """The return code of the verification result.
4070
4062
  0: Succeeded.
4071
4063
  1001: System error.
4072
- 1004: Liveness detection and face comparison failed.
4064
+ 1004: Selfie verification comparison failed.
4073
4065
  2004: The image passed in is too large or too small.
4074
4066
  2012: Several faces were detected.
4075
4067
  2013: No face was detected, or the face detected was incomplete.
@@ -4120,7 +4112,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
4120
4112
 
4121
4113
  @property
4122
4114
  def Similarity(self):
4123
- """The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (liveness detection and face comparison) mode.
4115
+ """The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (selfie verification) mode.
4124
4116
  Note: This field may return `null`, indicating that no valid values can be obtained.
4125
4117
  :rtype: float
4126
4118
  """
@@ -4173,7 +4165,7 @@ class GetFaceIdTokenIntlRequest(AbstractModel):
4173
4165
  r"""
4174
4166
  :param _CheckMode: The detection mode. Valid values:
4175
4167
  `liveness`: Liveness detection only.
4176
- `compare`: Liveness detection and face comparison.
4168
+ `compare`: Selfie verification.
4177
4169
  Default value: `liveness`.
4178
4170
  :type CheckMode: str
4179
4171
  :param _SecureLevel: The verification security level. Valid values:
@@ -4209,7 +4201,7 @@ The default value is blink. The different action types passed in this parameter
4209
4201
  def CheckMode(self):
4210
4202
  """The detection mode. Valid values:
4211
4203
  `liveness`: Liveness detection only.
4212
- `compare`: Liveness detection and face comparison.
4204
+ `compare`: Selfie verification.
4213
4205
  Default value: `liveness`.
4214
4206
  :rtype: str
4215
4207
  """
@@ -4673,7 +4665,7 @@ class GetWebVerificationResultIntlResponse(AbstractModel):
4673
4665
  def __init__(self):
4674
4666
  r"""
4675
4667
  :param _ErrorCode: The final result of this verification. `0` indicates that the person is the same as that in the photo.
4676
- For other error codes, see <a href="https://www.tencentcloud.com/document/product/1061/55390?lang=en&pg=#8a960e1e-39c0-42cb-b181-b3164d77f81e">Liveness Detection and Face Comparison (Mobile HTML5) Error Codes</a>
4668
+ For other error codes, see <a href="https://www.tencentcloud.com/document/product/1061/55390?lang=en&pg=#8a960e1e-39c0-42cb-b181-b3164d77f81e">Selfie Verification (Mobile HTML5) Error Codes</a>
4677
4669
  Note: This field may return null, indicating that no valid values can be obtained.
4678
4670
  :type ErrorCode: int
4679
4671
  :param _ErrorMsg: The description of the final verification result.
@@ -4708,7 +4700,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
4708
4700
  @property
4709
4701
  def ErrorCode(self):
4710
4702
  """The final result of this verification. `0` indicates that the person is the same as that in the photo.
4711
- For other error codes, see <a href="https://www.tencentcloud.com/document/product/1061/55390?lang=en&pg=#8a960e1e-39c0-42cb-b181-b3164d77f81e">Liveness Detection and Face Comparison (Mobile HTML5) Error Codes</a>
4703
+ For other error codes, see <a href="https://www.tencentcloud.com/document/product/1061/55390?lang=en&pg=#8a960e1e-39c0-42cb-b181-b3164d77f81e">Selfie Verification (Mobile HTML5) Error Codes</a>
4712
4704
  Note: This field may return null, indicating that no valid values can be obtained.
4713
4705
  :rtype: int
4714
4706
  """
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-intl-en
3
- Version: 3.0.1118
3
+ Version: 3.0.1120
4
4
  Summary: Tencent Cloud SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python-intl-en
6
6
  Author: Tencent Cloud
@@ -1,4 +1,4 @@
1
- tencentcloud/__init__.py,sha256=Sqz5gcHphQ4aKYqlq5KuGq2f23_eK1o67zC_O08KIok,630
1
+ tencentcloud/__init__.py,sha256=lyaXW0PeYAMq7DWHJiHa1-Jx55uvLypVABJ3wKCC7RE,630
2
2
  tencentcloud/advisor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
3
  tencentcloud/advisor/v20200721/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
4
  tencentcloud/advisor/v20200721/advisor_client.py,sha256=b5pLP_oF5HZHo4xbn-hI4dkpnirhcHB2rNDWvGf4q1Y,2919
@@ -159,9 +159,9 @@ tencentcloud/common/profile/client_profile.py,sha256=sSL6GthiTm_OL2nOWX4ekfby71F
159
159
  tencentcloud/common/profile/http_profile.py,sha256=gGWNo7x2zu3QnjMyDrGAIrBaihQv1hQkw55KovqhB1I,1893
160
160
  tencentcloud/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
161
161
  tencentcloud/config/v20220802/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
162
- tencentcloud/config/v20220802/config_client.py,sha256=S7xhR8ZOVJ04baep74nS6Om3BRNCOC_l4EeMHVYaNG0,5603
163
- tencentcloud/config/v20220802/errorcodes.py,sha256=cgRCmFno23j--AHZfyuOE9_NCxMcLFitbiSevicdyd0,1027
164
- tencentcloud/config/v20220802/models.py,sha256=ne7ue7ZYKmaT5ZPiSKoynpCqbSg-2yYBQEslzu3bz9k,72733
162
+ tencentcloud/config/v20220802/config_client.py,sha256=EqNS0_dxCC84CccXu8d-oFyUPmgwkn_hua3peHfG4QY,6593
163
+ tencentcloud/config/v20220802/errorcodes.py,sha256=CCQqDWvDIh72Z0PZDMfaPAWrW38afRsrwDD_g8Z1khY,1078
164
+ tencentcloud/config/v20220802/models.py,sha256=v6T41o0EgiYl8rnUdtWedjuZJiF_RyKkVWhXccFvf6g,85344
165
165
  tencentcloud/controlcenter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
166
166
  tencentcloud/controlcenter/v20230110/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
167
167
  tencentcloud/controlcenter/v20230110/controlcenter_client.py,sha256=brsNDrz2WCSmIRGCg2Zne0GN9mQfKtTVQpmVQ67y4Cw,2030
@@ -282,9 +282,9 @@ tencentcloud/facefusion/v20220927/facefusion_client.py,sha256=s2jNN_ZTuxh-RV9Wh4
282
282
  tencentcloud/facefusion/v20220927/models.py,sha256=dNoH82457_skQb1UgUc92iIIdSRpObCBCv3575Z-Crc,44203
283
283
  tencentcloud/faceid/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
284
284
  tencentcloud/faceid/v20180301/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
285
- tencentcloud/faceid/v20180301/errorcodes.py,sha256=QIZO_mdFiPmYrWS3wGMlLnNKTnV_6vVmB61ec6QSymE,9715
286
- tencentcloud/faceid/v20180301/faceid_client.py,sha256=Vk2Eu8CyYFpOudu1-hHbcBI6PkCTsrK1VPsVBzJcynk,24217
287
- tencentcloud/faceid/v20180301/models.py,sha256=QgtsZjHQLgrcnXoEZ4URQ5XJX1hIm5aPG2t3rYklXg4,383070
285
+ tencentcloud/faceid/v20180301/errorcodes.py,sha256=if59ahLlNuG4TVb3s0bhJCMW1xLyzLjogKgDud_YkTA,9962
286
+ tencentcloud/faceid/v20180301/faceid_client.py,sha256=Zto1akPPCqRbpysgrABFKtz3f-x0Rb-G8pfnPe15RtU,24130
287
+ tencentcloud/faceid/v20180301/models.py,sha256=DkJg2NuUFck4XONGyu6pY5BdyA5oZFcVzo6b0iGCzE8,382368
288
288
  tencentcloud/gaap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
289
289
  tencentcloud/gaap/v20180529/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
290
290
  tencentcloud/gaap/v20180529/errorcodes.py,sha256=hco_fu2P-boFi-3-kcpWCYfaay9RrwmhwHLqzvry2xM,11142
@@ -614,7 +614,7 @@ tencentcloud/yunjing/v20180228/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5
614
614
  tencentcloud/yunjing/v20180228/errorcodes.py,sha256=VEqwMbMBe7F2oAW6ZDu3vAivBr60lbo7FWduFqRTEVg,3195
615
615
  tencentcloud/yunjing/v20180228/models.py,sha256=0rnsJ4JkA5aCTV1cVwCuKnzooe6IhQ0NS3ij6tJ22uw,330670
616
616
  tencentcloud/yunjing/v20180228/yunjing_client.py,sha256=GA7Fo5GmpEJ2kufV2upw-ZpMZxznsPZ3NKDKDDAI4Ao,67384
617
- tencentcloud_sdk_python_intl_en-3.0.1118.dist-info/METADATA,sha256=6KRnz4UumDodXPFS7_ZDDPq6Q2jreSP3CVA5StdSH0I,1628
618
- tencentcloud_sdk_python_intl_en-3.0.1118.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
619
- tencentcloud_sdk_python_intl_en-3.0.1118.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
620
- tencentcloud_sdk_python_intl_en-3.0.1118.dist-info/RECORD,,
617
+ tencentcloud_sdk_python_intl_en-3.0.1120.dist-info/METADATA,sha256=s8wzH3UC_QDrshd9N5HX2LX5AWhLDeiII0z8c94df-4,1628
618
+ tencentcloud_sdk_python_intl_en-3.0.1120.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
619
+ tencentcloud_sdk_python_intl_en-3.0.1120.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
620
+ tencentcloud_sdk_python_intl_en-3.0.1120.dist-info/RECORD,,