# -*- coding: utf8 -*-
# Copyright (c) 2017-2021 THL A29 Limited, a Tencent company. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import warnings
from tencentcloud.common.abstract_model import AbstractModel
class CreateImageModerationAsyncTaskRequest(AbstractModel):
"""CreateImageModerationAsyncTask请求参数结构体
"""
def __init__(self):
r"""
:param _CallbackUrl: 接收审核信息回调地址，审核过程中产生的所有结果发送至此地址。
:type CallbackUrl: str
:param _BizType: 该字段表示策略的具体编号，用于接口调度，在内容安全控制台中可配置。若不传入Biztype参数（留空），则代表采用默认的识别策略；传入则会在审核时根据业务场景采取不同的审核策略。<br>备注：Biztype仅为数字、字母与下划线的组合，长度为3-32个字符；不同Biztype关联不同的业务场景与识别能力策略，调用前请确认正确的Biztype。
:type BizType: str
:param _DataId: 该字段表示您为待检测对象分配的数据ID，传入后可方便您对文件进行标识和管理。<br>取值：由英文字母（大小写均可）、数字及四个特殊符号（_，-，@，#）组成，**长度不超过64个字符**。
:type DataId: str
:param _FileContent: 该字段表示待检测图片文件内容的Base64编码，图片**大小不超过10MB**，建议**分辨率不低于256x256**，否则可能会影响识别效果。<br>备注： **该字段与FileUrl必须选择输入其中一个**。
:type FileContent: str
:param _FileUrl: 该字段表示待检测图片文件的访问链接，图片支持PNG、JPG、JPEG、BMP、GIF、WEBP格式，**大小不超过100MB**，建议**分辨率不低于256x256**；图片下载时间限制为3秒，超过则会返回下载超时；由于网络安全策略，**送审带重定向的链接，可能引起下载失败**，请尽量避免，比如Http返回302状态码的链接，可能导致接口返回ResourceUnavailable.ImageDownloadError。<br>备注：**该字段与FileContent必须选择输入其中一个**。
:type FileUrl: str
:param _Interval: **GIF/长图检测专用**，用于表示GIF截帧频率（每隔多少张图片抽取一帧进行检测），长图则按照长边：短边取整计算要切割的总图数；默认值为0，此时只会检测GIF的第一帧或对长图不进行切分处理。<br>备注：Interval与MaxFrames参数需要组合使用。例如，Interval=3, MaxFrames=400，则代表在检测GIF/长图时，将每间隔2帧检测一次且最多检测400帧。
:type Interval: int
:param _MaxFrames: **GIF/长图检测专用**，用于标识最大截帧数量；默认值为1，此时只会检测输入GIF的第一帧或对长图不进行切分处理（可能会造成处理超时）。<br>备注：Interval与MaxFrames参数需要组合使用。例如，Interval=3, MaxFrames=400，则代表在检测GIF/长图时，将每间隔2帧检测一次且最多检测400帧。
:type MaxFrames: int
:param _User: 该字段表示待检测对象对应的用户相关信息，若填入则可甄别相应违规风险用户。
:type User: :class:`tencentcloud.ims.v20201229.models.User`
:param _Device: 该字段表示待检测对象对应的设备相关信息，若填入则可甄别相应违规风险设备。
:type Device: :class:`tencentcloud.ims.v20201229.models.Device`
"""
self._CallbackUrl = None
self._BizType = None
self._DataId = None
self._FileContent = None
self._FileUrl = None
self._Interval = None
self._MaxFrames = None
self._User = None
self._Device = None
@property
def CallbackUrl(self):
"""接收审核信息回调地址，审核过程中产生的所有结果发送至此地址。
:rtype: str
"""
return self._CallbackUrl
@CallbackUrl.setter
def CallbackUrl(self, CallbackUrl):
self._CallbackUrl = CallbackUrl
@property
def BizType(self):
"""该字段表示策略的具体编号，用于接口调度，在内容安全控制台中可配置。若不传入Biztype参数（留空），则代表采用默认的识别策略；传入则会在审核时根据业务场景采取不同的审核策略。<br>备注：Biztype仅为数字、字母与下划线的组合，长度为3-32个字符；不同Biztype关联不同的业务场景与识别能力策略，调用前请确认正确的Biztype。
:rtype: str
"""
return self._BizType
@BizType.setter
def BizType(self, BizType):
self._BizType = BizType
@property
def DataId(self):
"""该字段表示您为待检测对象分配的数据ID，传入后可方便您对文件进行标识和管理。<br>取值：由英文字母（大小写均可）、数字及四个特殊符号（_，-，@，#）组成，**长度不超过64个字符**。
:rtype: str
"""
return self._DataId
@DataId.setter
def DataId(self, DataId):
self._DataId = DataId
@property
def FileContent(self):
"""该字段表示待检测图片文件内容的Base64编码，图片**大小不超过10MB**，建议**分辨率不低于256x256**，否则可能会影响识别效果。<br>备注： **该字段与FileUrl必须选择输入其中一个**。
:rtype: str
"""
return self._FileContent
@FileContent.setter
def FileContent(self, FileContent):
self._FileContent = FileContent
@property
def FileUrl(self):
"""该字段表示待检测图片文件的访问链接，图片支持PNG、JPG、JPEG、BMP、GIF、WEBP格式，**大小不超过100MB**，建议**分辨率不低于256x256**；图片下载时间限制为3秒，超过则会返回下载超时；由于网络安全策略，**送审带重定向的链接，可能引起下载失败**，请尽量避免，比如Http返回302状态码的链接，可能导致接口返回ResourceUnavailable.ImageDownloadError。<br>备注：**该字段与FileContent必须选择输入其中一个**。
:rtype: str
"""
return self._FileUrl
@FileUrl.setter
def FileUrl(self, FileUrl):
self._FileUrl = FileUrl
@property
def Interval(self):
"""**GIF/长图检测专用**，用于表示GIF截帧频率（每隔多少张图片抽取一帧进行检测），长图则按照长边：短边取整计算要切割的总图数；默认值为0，此时只会检测GIF的第一帧或对长图不进行切分处理。<br>备注：Interval与MaxFrames参数需要组合使用。例如，Interval=3, MaxFrames=400，则代表在检测GIF/长图时，将每间隔2帧检测一次且最多检测400帧。
:rtype: int
"""
return self._Interval
@Interval.setter
def Interval(self, Interval):
self._Interval = Interval
@property
def MaxFrames(self):
"""**GIF/长图检测专用**，用于标识最大截帧数量；默认值为1，此时只会检测输入GIF的第一帧或对长图不进行切分处理（可能会造成处理超时）。<br>备注：Interval与MaxFrames参数需要组合使用。例如，Interval=3, MaxFrames=400，则代表在检测GIF/长图时，将每间隔2帧检测一次且最多检测400帧。
:rtype: int
"""
return self._MaxFrames
@MaxFrames.setter
def MaxFrames(self, MaxFrames):
self._MaxFrames = MaxFrames
@property
def User(self):
"""该字段表示待检测对象对应的用户相关信息，若填入则可甄别相应违规风险用户。
:rtype: :class:`tencentcloud.ims.v20201229.models.User`
"""
return self._User
@User.setter
def User(self, User):
self._User = User
@property
def Device(self):
"""该字段表示待检测对象对应的设备相关信息，若填入则可甄别相应违规风险设备。
:rtype: :class:`tencentcloud.ims.v20201229.models.Device`
"""
return self._Device
@Device.setter
def Device(self, Device):
self._Device = Device
def _deserialize(self, params):
self._CallbackUrl = params.get("CallbackUrl")
self._BizType = params.get("BizType")
self._DataId = params.get("DataId")
self._FileContent = params.get("FileContent")
self._FileUrl = params.get("FileUrl")
self._Interval = params.get("Interval")
self._MaxFrames = params.get("MaxFrames")
if params.get("User") is not None:
self._User = User()
self._User._deserialize(params.get("User"))
if params.get("Device") is not None:
self._Device = Device()
self._Device._deserialize(params.get("Device"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class CreateImageModerationAsyncTaskResponse(AbstractModel):
"""CreateImageModerationAsyncTask返回参数结构体
"""
def __init__(self):
r"""
:param _DataId: 该字段用于返回检测对象对应请求参数中的DataId。
:type DataId: str
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._DataId = None
self._RequestId = None
@property
def DataId(self):
"""该字段用于返回检测对象对应请求参数中的DataId。
:rtype: str
"""
return self._DataId
@DataId.setter
def DataId(self, DataId):
self._DataId = DataId
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._DataId = params.get("DataId")
self._RequestId = params.get("RequestId")
class Device(AbstractModel):
"""用于表示业务用户对应的设备信息
"""
def __init__(self):
r"""
:param _Ip: 该字段表示业务用户对应设备的IP地址，同时**支持IPv4和IPv6**地址的记录；需要与IpType参数配合使用。
:type Ip: str
:param _Mac: 该字段表示业务用户对应的MAC地址，以方便设备识别与管理；其格式与取值与标准MAC地址一致。
:type Mac: str
:param _TokenId: *内测中，敬请期待。*
:type TokenId: str
:param _DeviceId: *内测中，敬请期待。*
:type DeviceId: str
:param _IMEI: 该字段表示业务用户对应设备的**IMEI码**（国际移动设备识别码），该识别码可用于识别每一部独立的手机等移动通信设备，方便设备识别与管理。<br>备注：格式为**15-17位纯数字**。
:type IMEI: str
:param _IDFA: **iOS设备专用**，该字段表示业务用户对应的**IDFA**(广告标识符),这是由苹果公司提供的用于标识用户的广告标识符，由一串16进制的32位数字和字母组成。<br>
备注：苹果公司自2021年iOS14更新后允许用户手动关闭或者开启IDFA，故此字符串标记有效性可能有所降低。
:type IDFA: str
:param _IDFV: **iOS设备专用**，该字段表示业务用户对应的**IDFV**(应用开发商标识符),这是由苹果公司提供的用于标注应用开发商的标识符，由一串16进制的32位数字和字母组成，可被用于唯一标识设备。
:type IDFV: str
:param _IpType: 该字段表示记录的IP地址的类型，取值：**0**（代表IPv4地址）、**1**（代表IPv6地址）；需要与IpType参数配合使用。
:type IpType: int
"""
self._Ip = None
self._Mac = None
self._TokenId = None
self._DeviceId = None
self._IMEI = None
self._IDFA = None
self._IDFV = None
self._IpType = None
@property
def Ip(self):
"""该字段表示业务用户对应设备的IP地址，同时**支持IPv4和IPv6**地址的记录；需要与IpType参数配合使用。
:rtype: str
"""
return self._Ip
@Ip.setter
def Ip(self, Ip):
self._Ip = Ip
@property
def Mac(self):
"""该字段表示业务用户对应的MAC地址，以方便设备识别与管理；其格式与取值与标准MAC地址一致。
:rtype: str
"""
return self._Mac
@Mac.setter
def Mac(self, Mac):
self._Mac = Mac
@property
def TokenId(self):
"""*内测中，敬请期待。*
:rtype: str
"""
return self._TokenId
@TokenId.setter
def TokenId(self, TokenId):
self._TokenId = TokenId
@property
def DeviceId(self):
"""*内测中，敬请期待。*
:rtype: str
"""
return self._DeviceId
@DeviceId.setter
def DeviceId(self, DeviceId):
self._DeviceId = DeviceId
@property
def IMEI(self):
"""该字段表示业务用户对应设备的**IMEI码**（国际移动设备识别码），该识别码可用于识别每一部独立的手机等移动通信设备，方便设备识别与管理。<br>备注：格式为**15-17位纯数字**。
:rtype: str
"""
return self._IMEI
@IMEI.setter
def IMEI(self, IMEI):
self._IMEI = IMEI
@property
def IDFA(self):
"""**iOS设备专用**，该字段表示业务用户对应的**IDFA**(广告标识符),这是由苹果公司提供的用于标识用户的广告标识符，由一串16进制的32位数字和字母组成。<br>
备注：苹果公司自2021年iOS14更新后允许用户手动关闭或者开启IDFA，故此字符串标记有效性可能有所降低。
:rtype: str
"""
return self._IDFA
@IDFA.setter
def IDFA(self, IDFA):
self._IDFA = IDFA
@property
def IDFV(self):
"""**iOS设备专用**，该字段表示业务用户对应的**IDFV**(应用开发商标识符),这是由苹果公司提供的用于标注应用开发商的标识符，由一串16进制的32位数字和字母组成，可被用于唯一标识设备。
:rtype: str
"""
return self._IDFV
@IDFV.setter
def IDFV(self, IDFV):
self._IDFV = IDFV
@property
def IpType(self):
"""该字段表示记录的IP地址的类型，取值：**0**（代表IPv4地址）、**1**（代表IPv6地址）；需要与IpType参数配合使用。
:rtype: int
"""
return self._IpType
@IpType.setter
def IpType(self, IpType):
self._IpType = IpType
def _deserialize(self, params):
self._Ip = params.get("Ip")
self._Mac = params.get("Mac")
self._TokenId = params.get("TokenId")
self._DeviceId = params.get("DeviceId")
self._IMEI = params.get("IMEI")
self._IDFA = params.get("IDFA")
self._IDFV = params.get("IDFV")
self._IpType = params.get("IpType")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ImageModerationRequest(AbstractModel):
"""ImageModeration请求参数结构体
"""
def __init__(self):
r"""
:param _BizType: 该字段表示策略的具体编号，用于接口调度，在内容安全控制台中可配置。若不传入Biztype参数（留空），则代表采用默认的识别策略；传入则会在审核时根据业务场景采取不同的审核策略。<br>备注：Biztype仅为数字、字母与下划线的组合，长度为3-32个字符；不同Biztype关联不同的业务场景与识别能力策略，调用前请确认正确的Biztype。
:type BizType: str
:param _DataId: 该字段表示您为待检测对象分配的数据ID，传入后可方便您对文件进行标识和管理。<br>取值：由英文字母（大小写均可）、数字及四个特殊符号（_，-，@，#）组成，**长度不超过64个字符**。
:type DataId: str
:param _FileContent: 该字段表示待检测图片文件内容的Base64编码，由于云API对请求包体有大小限制，图片的**Base64编码内容大小不得超过10MB**。<br/>备注：**该字段与FileUrl必须选择输入其中一个**。
:type FileContent: str
:param _FileUrl: 该字段表示待检测图片文件的访问链接，URL源图**大小不超过30MB**。<br />备注：该字段与FileContent必须选择输入其中一个。
:type FileUrl: str
:param _Interval: **GIF检测专用**，用于表示GIF截帧频率（每隔多少张图片抽取一帧进行检测）；默认值为0，此时只会检测GIF的第一帧或不进行切分处理。<br>备注：Interval与MaxFrames参数需要组合使用。例如，Interval=3, MaxFrames=400，则代表在检测GIF时，将每间隔2帧检测一次且最多检测400帧。
:type Interval: int
:param _MaxFrames: **GIF检测专用**，用于标识最大截帧数量；默认值为1，此时只会检测输入GIF的第一帧不进行切分处理（可能会造成处理超时）。<br>备注：Interval与MaxFrames参数需要组合使用。例如，Interval=3, MaxFrames=400，则代表在检测GIF时，将每间隔2帧检测一次且最多检测400帧。
:type MaxFrames: int
:param _User: 该字段表示待检测对象对应的用户相关信息，若填入则可甄别相应违规风险用户。
:type User: :class:`tencentcloud.ims.v20201229.models.User`
:param _Device: 该字段表示待检测对象对应的设备相关信息，若填入则可甄别相应违规风险设备。
:type Device: :class:`tencentcloud.ims.v20201229.models.Device`
"""
self._BizType = None
self._DataId = None
self._FileContent = None
self._FileUrl = None
self._Interval = None
self._MaxFrames = None
self._User = None
self._Device = None
@property
def BizType(self):
"""该字段表示策略的具体编号，用于接口调度，在内容安全控制台中可配置。若不传入Biztype参数（留空），则代表采用默认的识别策略；传入则会在审核时根据业务场景采取不同的审核策略。<br>备注：Biztype仅为数字、字母与下划线的组合，长度为3-32个字符；不同Biztype关联不同的业务场景与识别能力策略，调用前请确认正确的Biztype。
:rtype: str
"""
return self._BizType
@BizType.setter
def BizType(self, BizType):
self._BizType = BizType
@property
def DataId(self):
"""该字段表示您为待检测对象分配的数据ID，传入后可方便您对文件进行标识和管理。<br>取值：由英文字母（大小写均可）、数字及四个特殊符号（_，-，@，#）组成，**长度不超过64个字符**。
:rtype: str
"""
return self._DataId
@DataId.setter
def DataId(self, DataId):
self._DataId = DataId
@property
def FileContent(self):
"""该字段表示待检测图片文件内容的Base64编码，由于云API对请求包体有大小限制，图片的**Base64编码内容大小不得超过10MB**。<br/>备注：**该字段与FileUrl必须选择输入其中一个**。
:rtype: str
"""
return self._FileContent
@FileContent.setter
def FileContent(self, FileContent):
self._FileContent = FileContent
@property
def FileUrl(self):
"""该字段表示待检测图片文件的访问链接，URL源图**大小不超过30MB**。<br />备注：该字段与FileContent必须选择输入其中一个。
:rtype: str
"""
return self._FileUrl
@FileUrl.setter
def FileUrl(self, FileUrl):
self._FileUrl = FileUrl
@property
def Interval(self):
"""**GIF检测专用**，用于表示GIF截帧频率（每隔多少张图片抽取一帧进行检测）；默认值为0，此时只会检测GIF的第一帧或不进行切分处理。<br>备注：Interval与MaxFrames参数需要组合使用。例如，Interval=3, MaxFrames=400，则代表在检测GIF时，将每间隔2帧检测一次且最多检测400帧。
:rtype: int
"""
return self._Interval
@Interval.setter
def Interval(self, Interval):
self._Interval = Interval
@property
def MaxFrames(self):
"""**GIF检测专用**，用于标识最大截帧数量；默认值为1，此时只会检测输入GIF的第一帧不进行切分处理（可能会造成处理超时）。<br>备注：Interval与MaxFrames参数需要组合使用。例如，Interval=3, MaxFrames=400，则代表在检测GIF时，将每间隔2帧检测一次且最多检测400帧。
:rtype: int
"""
return self._MaxFrames
@MaxFrames.setter
def MaxFrames(self, MaxFrames):
self._MaxFrames = MaxFrames
@property
def User(self):
"""该字段表示待检测对象对应的用户相关信息，若填入则可甄别相应违规风险用户。
:rtype: :class:`tencentcloud.ims.v20201229.models.User`
"""
return self._User
@User.setter
def User(self, User):
self._User = User
@property
def Device(self):
"""该字段表示待检测对象对应的设备相关信息，若填入则可甄别相应违规风险设备。
:rtype: :class:`tencentcloud.ims.v20201229.models.Device`
"""
return self._Device
@Device.setter
def Device(self, Device):
self._Device = Device
def _deserialize(self, params):
self._BizType = params.get("BizType")
self._DataId = params.get("DataId")
self._FileContent = params.get("FileContent")
self._FileUrl = params.get("FileUrl")
self._Interval = params.get("Interval")
self._MaxFrames = params.get("MaxFrames")
if params.get("User") is not None:
self._User = User()
self._User._deserialize(params.get("User"))
if params.get("Device") is not None:
self._Device = Device()
self._Device._deserialize(params.get("Device"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ImageModerationResponse(AbstractModel):
"""ImageModeration返回参数结构体
"""
def __init__(self):
r"""
:param _Suggestion: 该字段用于返回Label标签下的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
:type Suggestion: str
:param _Label: 该字段用于返回检测结果（LabelResults）中所对应的**优先级最高的恶意标签**，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:type Label: str
:param _SubLabel: 该字段用于返回检测结果所命中优先级最高的恶意标签下的子标签名称，如：*色情--性行为*；若未命中任何子标签则返回空字符串。
:type SubLabel: str
:param _Score: 该字段用于返回当前标签（Label）下的置信度，取值范围：0（**置信度最低**）-100（**置信度最高** ），越高代表图片越有可能属于当前返回的标签；如：*色情 99*，则表明该图片非常有可能属于色情内容；*色情 0*，则表明该图片不属于色情内容。
:type Score: int
:param _LabelResults: 该字段用于返回分类模型命中的恶意标签的详细识别结果，包括涉黄、广告等令人反感、不安全或不适宜的内容类型识别结果。
注意：此字段可能返回 null，表示取不到有效值。
:type LabelResults: list of LabelResult
:param _ObjectResults: 该字段用于返回物体检测模型的详细检测结果；包括：实体、广告台标、二维码等内容命中的标签名称、标签分数、坐标信息、场景识别结果、建议操作等内容审核信息；详细返回值信息可参阅对应的数据结构（ObjectResults）描述。
注意：此字段可能返回 null，表示取不到有效值。
:type ObjectResults: list of ObjectResult
:param _OcrResults: 该字段用于返回OCR文本识别的详细检测结果；包括：文本坐标信息、文本识别结果、建议操作等内容审核信息；详细返回值信息可参阅对应的数据结构（OcrResults）描述。
注意：此字段可能返回 null，表示取不到有效值。
:type OcrResults: list of OcrResult
:param _LibResults: 该字段用于返回基于图片风险库（风险黑库与正常白库）识别的结果,详细返回值信息可参阅对应的数据结构（LibResults）描述。<br>备注：图片风险库目前**暂不支持自定义库**。
注意：此字段可能返回 null，表示取不到有效值。
:type LibResults: list of LibResult
:param _DataId: 该字段用于返回检测对象对应请求参数中的DataId。
:type DataId: str
:param _BizType: 该字段用于返回检测对象对应请求参数中的BizType。
:type BizType: str
:param _Extra: 该字段用于返回根据您的需求配置的额外附加信息（Extra），如未配置则默认返回值为空。<br>备注：不同客户或Biztype下返回信息不同，如需配置该字段请提交工单咨询或联系售后专员处理。
注意：此字段可能返回 null，表示取不到有效值。
:type Extra: str
:param _FileMD5: 该字段用于返回检测对象对应的MD5校验值，以方便校验文件完整性。
:type FileMD5: str
:param _RecognitionResults: 该字段用于返回仅识别图片元素的模型结果；包括：场景模型命中的标签、置信度和位置信息
注意：此字段可能返回 null，表示取不到有效值。
:type RecognitionResults: list of RecognitionResult
:param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:type RequestId: str
"""
self._Suggestion = None
self._Label = None
self._SubLabel = None
self._Score = None
self._LabelResults = None
self._ObjectResults = None
self._OcrResults = None
self._LibResults = None
self._DataId = None
self._BizType = None
self._Extra = None
self._FileMD5 = None
self._RecognitionResults = None
self._RequestId = None
@property
def Suggestion(self):
"""该字段用于返回Label标签下的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
:rtype: str
"""
return self._Suggestion
@Suggestion.setter
def Suggestion(self, Suggestion):
self._Suggestion = Suggestion
@property
def Label(self):
"""该字段用于返回检测结果（LabelResults）中所对应的**优先级最高的恶意标签**，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:rtype: str
"""
return self._Label
@Label.setter
def Label(self, Label):
self._Label = Label
@property
def SubLabel(self):
"""该字段用于返回检测结果所命中优先级最高的恶意标签下的子标签名称，如：*色情--性行为*；若未命中任何子标签则返回空字符串。
:rtype: str
"""
return self._SubLabel
@SubLabel.setter
def SubLabel(self, SubLabel):
self._SubLabel = SubLabel
@property
def Score(self):
"""该字段用于返回当前标签（Label）下的置信度，取值范围：0（**置信度最低**）-100（**置信度最高** ），越高代表图片越有可能属于当前返回的标签；如：*色情 99*，则表明该图片非常有可能属于色情内容；*色情 0*，则表明该图片不属于色情内容。
:rtype: int
"""
return self._Score
@Score.setter
def Score(self, Score):
self._Score = Score
@property
def LabelResults(self):
"""该字段用于返回分类模型命中的恶意标签的详细识别结果，包括涉黄、广告等令人反感、不安全或不适宜的内容类型识别结果。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of LabelResult
"""
return self._LabelResults
@LabelResults.setter
def LabelResults(self, LabelResults):
self._LabelResults = LabelResults
@property
def ObjectResults(self):
"""该字段用于返回物体检测模型的详细检测结果；包括：实体、广告台标、二维码等内容命中的标签名称、标签分数、坐标信息、场景识别结果、建议操作等内容审核信息；详细返回值信息可参阅对应的数据结构（ObjectResults）描述。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of ObjectResult
"""
return self._ObjectResults
@ObjectResults.setter
def ObjectResults(self, ObjectResults):
self._ObjectResults = ObjectResults
@property
def OcrResults(self):
"""该字段用于返回OCR文本识别的详细检测结果；包括：文本坐标信息、文本识别结果、建议操作等内容审核信息；详细返回值信息可参阅对应的数据结构（OcrResults）描述。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of OcrResult
"""
return self._OcrResults
@OcrResults.setter
def OcrResults(self, OcrResults):
self._OcrResults = OcrResults
@property
def LibResults(self):
"""该字段用于返回基于图片风险库（风险黑库与正常白库）识别的结果,详细返回值信息可参阅对应的数据结构（LibResults）描述。<br>备注：图片风险库目前**暂不支持自定义库**。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of LibResult
"""
return self._LibResults
@LibResults.setter
def LibResults(self, LibResults):
self._LibResults = LibResults
@property
def DataId(self):
"""该字段用于返回检测对象对应请求参数中的DataId。
:rtype: str
"""
return self._DataId
@DataId.setter
def DataId(self, DataId):
self._DataId = DataId
@property
def BizType(self):
"""该字段用于返回检测对象对应请求参数中的BizType。
:rtype: str
"""
return self._BizType
@BizType.setter
def BizType(self, BizType):
self._BizType = BizType
@property
def Extra(self):
"""该字段用于返回根据您的需求配置的额外附加信息（Extra），如未配置则默认返回值为空。<br>备注：不同客户或Biztype下返回信息不同，如需配置该字段请提交工单咨询或联系售后专员处理。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: str
"""
return self._Extra
@Extra.setter
def Extra(self, Extra):
self._Extra = Extra
@property
def FileMD5(self):
"""该字段用于返回检测对象对应的MD5校验值，以方便校验文件完整性。
:rtype: str
"""
return self._FileMD5
@FileMD5.setter
def FileMD5(self, FileMD5):
self._FileMD5 = FileMD5
@property
def RecognitionResults(self):
"""该字段用于返回仅识别图片元素的模型结果；包括：场景模型命中的标签、置信度和位置信息
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of RecognitionResult
"""
return self._RecognitionResults
@RecognitionResults.setter
def RecognitionResults(self, RecognitionResults):
self._RecognitionResults = RecognitionResults
@property
def RequestId(self):
"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
:rtype: str
"""
return self._RequestId
@RequestId.setter
def RequestId(self, RequestId):
self._RequestId = RequestId
def _deserialize(self, params):
self._Suggestion = params.get("Suggestion")
self._Label = params.get("Label")
self._SubLabel = params.get("SubLabel")
self._Score = params.get("Score")
if params.get("LabelResults") is not None:
self._LabelResults = []
for item in params.get("LabelResults"):
obj = LabelResult()
obj._deserialize(item)
self._LabelResults.append(obj)
if params.get("ObjectResults") is not None:
self._ObjectResults = []
for item in params.get("ObjectResults"):
obj = ObjectResult()
obj._deserialize(item)
self._ObjectResults.append(obj)
if params.get("OcrResults") is not None:
self._OcrResults = []
for item in params.get("OcrResults"):
obj = OcrResult()
obj._deserialize(item)
self._OcrResults.append(obj)
if params.get("LibResults") is not None:
self._LibResults = []
for item in params.get("LibResults"):
obj = LibResult()
obj._deserialize(item)
self._LibResults.append(obj)
self._DataId = params.get("DataId")
self._BizType = params.get("BizType")
self._Extra = params.get("Extra")
self._FileMD5 = params.get("FileMD5")
if params.get("RecognitionResults") is not None:
self._RecognitionResults = []
for item in params.get("RecognitionResults"):
obj = RecognitionResult()
obj._deserialize(item)
self._RecognitionResults.append(obj)
self._RequestId = params.get("RequestId")
class LabelDetailItem(AbstractModel):
"""用于返回分类模型命中子标签的详细结果
"""
def __init__(self):
r"""
:param _Id: 该字段用于返回识别对象的ID以方便识别和区分。
注意：此字段可能返回 null，表示取不到有效值。
:type Id: int
:param _Name: 该字段用于返回识命中的子标签名称。
注意：此字段可能返回 null，表示取不到有效值。
:type Name: str
:param _Score: 该字段用于返回对应子标签命中的分值，取值为**0-100**，如：*Porn-SexBehavior 99* 则代表相应识别内容命中色情-性行为标签的分值为99。
注意：此字段可能返回 null，表示取不到有效值。
:type Score: int
"""
self._Id = None
self._Name = None
self._Score = None
@property
def Id(self):
"""该字段用于返回识别对象的ID以方便识别和区分。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: int
"""
return self._Id
@Id.setter
def Id(self, Id):
self._Id = Id
@property
def Name(self):
"""该字段用于返回识命中的子标签名称。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Score(self):
"""该字段用于返回对应子标签命中的分值，取值为**0-100**，如：*Porn-SexBehavior 99* 则代表相应识别内容命中色情-性行为标签的分值为99。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: int
"""
return self._Score
@Score.setter
def Score(self, Score):
self._Score = Score
def _deserialize(self, params):
self._Id = params.get("Id")
self._Name = params.get("Name")
self._Score = params.get("Score")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class LabelResult(AbstractModel):
"""分类模型命中结果
"""
def __init__(self):
r"""
:param _Scene: 该字段用于返回模型识别出的场景结果，如广告、色情、有害内容等场景。
:type Scene: str
:param _Suggestion: 该字段用于返回针对当前恶意标签的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
:type Suggestion: str
:param _Label: 该字段用于返回检测结果所对应的恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:type Label: str
:param _SubLabel: 该字段用于返回对应恶意标签下的子标签的检测结果，如：*Porn-SexBehavior*等子标签。
:type SubLabel: str
:param _Score: 该字段用于返回当前标签（Label）下的置信度，取值范围：0（**置信度最低**）-100（**置信度最高** ），越高代表图片越有可能属于当前返回的标签；如：*色情 99*，则表明该图片非常有可能属于色情内容；*色情 0*，则表明该图片不属于色情内容。
:type Score: int
:param _Details: 该字段用于返回分类模型命中子标签的详细信息，如：序号、命中标签名称、分数等信息。
注意：此字段可能返回 null，表示取不到有效值。
:type Details: list of LabelDetailItem
"""
self._Scene = None
self._Suggestion = None
self._Label = None
self._SubLabel = None
self._Score = None
self._Details = None
@property
def Scene(self):
"""该字段用于返回模型识别出的场景结果，如广告、色情、有害内容等场景。
:rtype: str
"""
return self._Scene
@Scene.setter
def Scene(self, Scene):
self._Scene = Scene
@property
def Suggestion(self):
"""该字段用于返回针对当前恶意标签的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
:rtype: str
"""
return self._Suggestion
@Suggestion.setter
def Suggestion(self, Suggestion):
self._Suggestion = Suggestion
@property
def Label(self):
"""该字段用于返回检测结果所对应的恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:rtype: str
"""
return self._Label
@Label.setter
def Label(self, Label):
self._Label = Label
@property
def SubLabel(self):
"""该字段用于返回对应恶意标签下的子标签的检测结果，如：*Porn-SexBehavior*等子标签。
:rtype: str
"""
return self._SubLabel
@SubLabel.setter
def SubLabel(self, SubLabel):
self._SubLabel = SubLabel
@property
def Score(self):
"""该字段用于返回当前标签（Label）下的置信度，取值范围：0（**置信度最低**）-100（**置信度最高** ），越高代表图片越有可能属于当前返回的标签；如：*色情 99*，则表明该图片非常有可能属于色情内容；*色情 0*，则表明该图片不属于色情内容。
:rtype: int
"""
return self._Score
@Score.setter
def Score(self, Score):
self._Score = Score
@property
def Details(self):
"""该字段用于返回分类模型命中子标签的详细信息，如：序号、命中标签名称、分数等信息。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of LabelDetailItem
"""
return self._Details
@Details.setter
def Details(self, Details):
self._Details = Details
def _deserialize(self, params):
self._Scene = params.get("Scene")
self._Suggestion = params.get("Suggestion")
self._Label = params.get("Label")
self._SubLabel = params.get("SubLabel")
self._Score = params.get("Score")
if params.get("Details") is not None:
self._Details = []
for item in params.get("Details"):
obj = LabelDetailItem()
obj._deserialize(item)
self._Details.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class LibDetail(AbstractModel):
"""用于返回自定义库/黑白库的明细信息
"""
def __init__(self):
r"""
:param _Id: 该字段用于返回识别对象的ID以方便识别和区分。
:type Id: int
:param _LibId: 该字段用于返回自定义库的ID，以方便自定义库管理和配置。
:type LibId: str
:param _LibName: 该字段用于返回自定义库的名称,以方便自定义库管理和配置。
注意：此字段可能返回 null，表示取不到有效值。
:type LibName: str
:param _ImageId: 该字段用于返回识别图像对象的ID以方便文件管理。
:type ImageId: str
:param _Label: 该字段用于返回检测结果所对应的恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:type Label: str
:param _Tag: 该字段用于返回其他自定义标签以满足您的定制化场景需求，若无需求则可略过。
注意：此字段可能返回 null，表示取不到有效值。
:type Tag: str
:param _Score: 该字段用于返回对应模型命中的分值，取值为**0-100**，如：*Porn 99* 则代表相应识别内容命中色情标签的分值为99。
:type Score: int
"""
self._Id = None
self._LibId = None
self._LibName = None
self._ImageId = None
self._Label = None
self._Tag = None
self._Score = None
@property
def Id(self):
"""该字段用于返回识别对象的ID以方便识别和区分。
:rtype: int
"""
return self._Id
@Id.setter
def Id(self, Id):
self._Id = Id
@property
def LibId(self):
"""该字段用于返回自定义库的ID，以方便自定义库管理和配置。
:rtype: str
"""
return self._LibId
@LibId.setter
def LibId(self, LibId):
self._LibId = LibId
@property
def LibName(self):
"""该字段用于返回自定义库的名称,以方便自定义库管理和配置。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: str
"""
return self._LibName
@LibName.setter
def LibName(self, LibName):
self._LibName = LibName
@property
def ImageId(self):
"""该字段用于返回识别图像对象的ID以方便文件管理。
:rtype: str
"""
return self._ImageId
@ImageId.setter
def ImageId(self, ImageId):
self._ImageId = ImageId
@property
def Label(self):
"""该字段用于返回检测结果所对应的恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:rtype: str
"""
return self._Label
@Label.setter
def Label(self, Label):
self._Label = Label
@property
def Tag(self):
"""该字段用于返回其他自定义标签以满足您的定制化场景需求，若无需求则可略过。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: str
"""
return self._Tag
@Tag.setter
def Tag(self, Tag):
self._Tag = Tag
@property
def Score(self):
"""该字段用于返回对应模型命中的分值，取值为**0-100**，如：*Porn 99* 则代表相应识别内容命中色情标签的分值为99。
:rtype: int
"""
return self._Score
@Score.setter
def Score(self, Score):
self._Score = Score
def _deserialize(self, params):
self._Id = params.get("Id")
self._LibId = params.get("LibId")
self._LibName = params.get("LibName")
self._ImageId = params.get("ImageId")
self._Label = params.get("Label")
self._Tag = params.get("Tag")
self._Score = params.get("Score")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class LibResult(AbstractModel):
"""用于返回黑白库比对结果的详细信息
"""
def __init__(self):
r"""
:param _Scene: 该字段表示模型的场景识别结果，默认取值为Similar。
:type Scene: str
:param _Suggestion: 该字段用于返回后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
:type Suggestion: str
:param _Label: 该字段用于返回检测结果所对应的恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:type Label: str
:param _SubLabel: 该字段用于返回恶意标签下对应的子标签的检测结果，如：*Porn-SexBehavior*等子标签。
注意：此字段可能返回 null，表示取不到有效值。
:type SubLabel: str
:param _Score: 该字段用于返回图片检索模型识别的分值，取值为**0-100**，表示该审核图片**与库中样本的相似分值**，得分越高，代表当前内容越有可能命中相似图库内的样本。
:type Score: int
:param _Details: 该字段用于返回黑白库比对结果的详细信息，如：序号、库名称、恶意标签等信息；详细返回信息敬请参考对应数据结构（[LibDetail](https://cloud.tencent.com/document/product/1125/53274#LibDetail)）的描述文档
注意：此字段可能返回 null，表示取不到有效值。
:type Details: list of LibDetail
"""
self._Scene = None
self._Suggestion = None
self._Label = None
self._SubLabel = None
self._Score = None
self._Details = None
@property
def Scene(self):
"""该字段表示模型的场景识别结果，默认取值为Similar。
:rtype: str
"""
return self._Scene
@Scene.setter
def Scene(self, Scene):
self._Scene = Scene
@property
def Suggestion(self):
"""该字段用于返回后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
:rtype: str
"""
return self._Suggestion
@Suggestion.setter
def Suggestion(self, Suggestion):
self._Suggestion = Suggestion
@property
def Label(self):
"""该字段用于返回检测结果所对应的恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:rtype: str
"""
return self._Label
@Label.setter
def Label(self, Label):
self._Label = Label
@property
def SubLabel(self):
"""该字段用于返回恶意标签下对应的子标签的检测结果，如：*Porn-SexBehavior*等子标签。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: str
"""
return self._SubLabel
@SubLabel.setter
def SubLabel(self, SubLabel):
self._SubLabel = SubLabel
@property
def Score(self):
"""该字段用于返回图片检索模型识别的分值，取值为**0-100**，表示该审核图片**与库中样本的相似分值**，得分越高，代表当前内容越有可能命中相似图库内的样本。
:rtype: int
"""
return self._Score
@Score.setter
def Score(self, Score):
self._Score = Score
@property
def Details(self):
"""该字段用于返回黑白库比对结果的详细信息，如：序号、库名称、恶意标签等信息；详细返回信息敬请参考对应数据结构（[LibDetail](https://cloud.tencent.com/document/product/1125/53274#LibDetail)）的描述文档
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of LibDetail
"""
return self._Details
@Details.setter
def Details(self, Details):
self._Details = Details
def _deserialize(self, params):
self._Scene = params.get("Scene")
self._Suggestion = params.get("Suggestion")
self._Label = params.get("Label")
self._SubLabel = params.get("SubLabel")
self._Score = params.get("Score")
if params.get("Details") is not None:
self._Details = []
for item in params.get("Details"):
obj = LibDetail()
obj._deserialize(item)
self._Details.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class Location(AbstractModel):
"""坐标
"""
def __init__(self):
r"""
:param _X: 该参数用于返回检测框**左上角位置的横坐标**（x）所在的像素位置，结合剩余参数可唯一确定检测框的大小和位置。
:type X: float
:param _Y: 该参数用于返回检测框**左上角位置的纵坐标**（y）所在的像素位置，结合剩余参数可唯一确定检测框的大小和位置。
:type Y: float
:param _Width: 该参数用于返回**检测框的宽度**（由左上角出发在x轴向右延伸的长度），结合剩余参数可唯一确定检测框的大小和位置。
:type Width: float
:param _Height: 该参数用于返回**检测框的高度**（由左上角出发在y轴向下延伸的长度），结合剩余参数可唯一确定检测框的大小和位置。
:type Height: float
:param _Rotate: 该参数用于返回**检测框的旋转角度**，该参数结合X和Y两个坐标参数可唯一确定检测框的具体位置；取值：**0-360**（**角度制**），方向为**逆时针旋转**。
:type Rotate: float
"""
self._X = None
self._Y = None
self._Width = None
self._Height = None
self._Rotate = None
@property
def X(self):
"""该参数用于返回检测框**左上角位置的横坐标**（x）所在的像素位置，结合剩余参数可唯一确定检测框的大小和位置。
:rtype: float
"""
return self._X
@X.setter
def X(self, X):
self._X = X
@property
def Y(self):
"""该参数用于返回检测框**左上角位置的纵坐标**（y）所在的像素位置，结合剩余参数可唯一确定检测框的大小和位置。
:rtype: float
"""
return self._Y
@Y.setter
def Y(self, Y):
self._Y = Y
@property
def Width(self):
"""该参数用于返回**检测框的宽度**（由左上角出发在x轴向右延伸的长度），结合剩余参数可唯一确定检测框的大小和位置。
:rtype: float
"""
return self._Width
@Width.setter
def Width(self, Width):
self._Width = Width
@property
def Height(self):
"""该参数用于返回**检测框的高度**（由左上角出发在y轴向下延伸的长度），结合剩余参数可唯一确定检测框的大小和位置。
:rtype: float
"""
return self._Height
@Height.setter
def Height(self, Height):
self._Height = Height
@property
def Rotate(self):
"""该参数用于返回**检测框的旋转角度**，该参数结合X和Y两个坐标参数可唯一确定检测框的具体位置；取值：**0-360**（**角度制**），方向为**逆时针旋转**。
:rtype: float
"""
return self._Rotate
@Rotate.setter
def Rotate(self, Rotate):
self._Rotate = Rotate
def _deserialize(self, params):
self._X = params.get("X")
self._Y = params.get("Y")
self._Width = params.get("Width")
self._Height = params.get("Height")
self._Rotate = params.get("Rotate")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ObjectDetail(AbstractModel):
"""实体检测结果明细，当检测场景为实体、广告台标、二维码时表示模型检测目标框的标签名称、标签值、标签分数以及检测框的位置信息。
"""
def __init__(self):
r"""
:param _Id: 该参数用于返回识别对象的ID以方便识别和区分。
:type Id: int
:param _Name: 该参数用于返回命中的实体标签。
:type Name: str
:param _Value: 该参数用于返回对应实体标签所对应的值或内容。如：当标签为*二维码(QrCode)*时，该字段为识别出的二维码对应的URL地址。
:type Value: str
:param _Score: 该参数用于返回对应实体标签命中的分值，取值为**0-100**，如：*QrCode 99* 则代表相应识别内容命中二维码场景标签的概率非常高。
:type Score: int
:param _Location: 该字段用于返回实体检测框的坐标位置（左上角xy坐标、长宽、旋转角度）以方便快速定位实体的相关信息。
:type Location: :class:`tencentcloud.ims.v20201229.models.Location`
:param _SubLabel: 该参数用于返回命中的实体二级标签。
:type SubLabel: str
:param _ObjectId: 该参数用于返回命中的人脸id
注意：此字段可能返回 null，表示取不到有效值。
:type ObjectId: str
"""
self._Id = None
self._Name = None
self._Value = None
self._Score = None
self._Location = None
self._SubLabel = None
self._ObjectId = None
@property
def Id(self):
"""该参数用于返回识别对象的ID以方便识别和区分。
:rtype: int
"""
return self._Id
@Id.setter
def Id(self, Id):
self._Id = Id
@property
def Name(self):
"""该参数用于返回命中的实体标签。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Value(self):
"""该参数用于返回对应实体标签所对应的值或内容。如：当标签为*二维码(QrCode)*时，该字段为识别出的二维码对应的URL地址。
:rtype: str
"""
return self._Value
@Value.setter
def Value(self, Value):
self._Value = Value
@property
def Score(self):
"""该参数用于返回对应实体标签命中的分值，取值为**0-100**，如：*QrCode 99* 则代表相应识别内容命中二维码场景标签的概率非常高。
:rtype: int
"""
return self._Score
@Score.setter
def Score(self, Score):
self._Score = Score
@property
def Location(self):
"""该字段用于返回实体检测框的坐标位置（左上角xy坐标、长宽、旋转角度）以方便快速定位实体的相关信息。
:rtype: :class:`tencentcloud.ims.v20201229.models.Location`
"""
return self._Location
@Location.setter
def Location(self, Location):
self._Location = Location
@property
def SubLabel(self):
"""该参数用于返回命中的实体二级标签。
:rtype: str
"""
return self._SubLabel
@SubLabel.setter
def SubLabel(self, SubLabel):
self._SubLabel = SubLabel
@property
def ObjectId(self):
"""该参数用于返回命中的人脸id
注意：此字段可能返回 null，表示取不到有效值。
:rtype: str
"""
return self._ObjectId
@ObjectId.setter
def ObjectId(self, ObjectId):
self._ObjectId = ObjectId
def _deserialize(self, params):
self._Id = params.get("Id")
self._Name = params.get("Name")
self._Value = params.get("Value")
self._Score = params.get("Score")
if params.get("Location") is not None:
self._Location = Location()
self._Location._deserialize(params.get("Location"))
self._SubLabel = params.get("SubLabel")
self._ObjectId = params.get("ObjectId")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class ObjectResult(AbstractModel):
"""用于返回实体检测结果详情
"""
def __init__(self):
r"""
:param _Scene: 该字段用于返回实体识别出的实体场景结果，如二维码、logo、图片OCR等场景。
:type Scene: str
:param _Suggestion: 该字段用于返回针对当前恶意标签的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
:type Suggestion: str
:param _Label: 该字段用于返回检测结果所对应的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:type Label: str
:param _SubLabel: 该字段用于返回当前恶意标签下对应的子标签的检测结果，如：*Porn-SexBehavior* 等子标签。
:type SubLabel: str
:param _Score: 该字段用于返回命中当前恶意标签下子标签的分值，取值为**0-100**，如：*Porn-SexBehavior 99* 则代表相应识别内容命中色情-性行为标签的分值为99。
:type Score: int
:param _Names: 该标签用于返回所识别出的实体名称。
注意：此字段可能返回 null，表示取不到有效值。
:type Names: list of str
:param _Details: 该标签用于返回所识别出实体的详细信息，如：序号、命中标签名称、位置坐标等信息，详细返回内容敬请参考相应数据结构（[ObjectDetail
](https://cloud.tencent.com/document/api/1125/53274#ObjectDetail)）。
注意：此字段可能返回 null，表示取不到有效值。
:type Details: list of ObjectDetail
"""
self._Scene = None
self._Suggestion = None
self._Label = None
self._SubLabel = None
self._Score = None
self._Names = None
self._Details = None
@property
def Scene(self):
"""该字段用于返回实体识别出的实体场景结果，如二维码、logo、图片OCR等场景。
:rtype: str
"""
return self._Scene
@Scene.setter
def Scene(self, Scene):
self._Scene = Scene
@property
def Suggestion(self):
"""该字段用于返回针对当前恶意标签的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
:rtype: str
"""
return self._Suggestion
@Suggestion.setter
def Suggestion(self, Suggestion):
self._Suggestion = Suggestion
@property
def Label(self):
"""该字段用于返回检测结果所对应的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:rtype: str
"""
return self._Label
@Label.setter
def Label(self, Label):
self._Label = Label
@property
def SubLabel(self):
"""该字段用于返回当前恶意标签下对应的子标签的检测结果，如：*Porn-SexBehavior* 等子标签。
:rtype: str
"""
return self._SubLabel
@SubLabel.setter
def SubLabel(self, SubLabel):
self._SubLabel = SubLabel
@property
def Score(self):
"""该字段用于返回命中当前恶意标签下子标签的分值，取值为**0-100**，如：*Porn-SexBehavior 99* 则代表相应识别内容命中色情-性行为标签的分值为99。
:rtype: int
"""
return self._Score
@Score.setter
def Score(self, Score):
self._Score = Score
@property
def Names(self):
"""该标签用于返回所识别出的实体名称。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of str
"""
return self._Names
@Names.setter
def Names(self, Names):
self._Names = Names
@property
def Details(self):
"""该标签用于返回所识别出实体的详细信息，如：序号、命中标签名称、位置坐标等信息，详细返回内容敬请参考相应数据结构（[ObjectDetail
](https://cloud.tencent.com/document/api/1125/53274#ObjectDetail)）。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of ObjectDetail
"""
return self._Details
@Details.setter
def Details(self, Details):
self._Details = Details
def _deserialize(self, params):
self._Scene = params.get("Scene")
self._Suggestion = params.get("Suggestion")
self._Label = params.get("Label")
self._SubLabel = params.get("SubLabel")
self._Score = params.get("Score")
self._Names = params.get("Names")
if params.get("Details") is not None:
self._Details = []
for item in params.get("Details"):
obj = ObjectDetail()
obj._deserialize(item)
self._Details.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class OcrHitInfo(AbstractModel):
"""ocr关键词命中位置信息
"""
def __init__(self):
r"""
:param _Type: 标识模型命中还是关键词命中
:type Type: str
:param _Keyword: 命中关键词
:type Keyword: str
:param _LibName: 自定义词库名称
:type LibName: str
:param _Positions: 位置信息
:type Positions: list of Positions
"""
self._Type = None
self._Keyword = None
self._LibName = None
self._Positions = None
@property
def Type(self):
"""标识模型命中还是关键词命中
:rtype: str
"""
return self._Type
@Type.setter
def Type(self, Type):
self._Type = Type
@property
def Keyword(self):
"""命中关键词
:rtype: str
"""
return self._Keyword
@Keyword.setter
def Keyword(self, Keyword):
self._Keyword = Keyword
@property
def LibName(self):
"""自定义词库名称
:rtype: str
"""
return self._LibName
@LibName.setter
def LibName(self, LibName):
self._LibName = LibName
@property
def Positions(self):
"""位置信息
:rtype: list of Positions
"""
return self._Positions
@Positions.setter
def Positions(self, Positions):
self._Positions = Positions
def _deserialize(self, params):
self._Type = params.get("Type")
self._Keyword = params.get("Keyword")
self._LibName = params.get("LibName")
if params.get("Positions") is not None:
self._Positions = []
for item in params.get("Positions"):
obj = Positions()
obj._deserialize(item)
self._Positions.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class OcrResult(AbstractModel):
"""用于返回OCR结果检测详情
"""
def __init__(self):
r"""
:param _Scene: 该字段表示识别场景，取值默认为OCR（图片OCR识别）。
:type Scene: str
:param _Suggestion: 该字段用于返回优先级最高的恶意标签对应的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
:type Suggestion: str
:param _Label: 该字段用于返回OCR检测结果所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:type Label: str
:param _SubLabel: 该字段用于返回当前标签（Label）下对应的子标签的检测结果，如：*Porn-SexBehavior*等子标签。
:type SubLabel: str
:param _Score: 该字段用于返回当前标签（Label）下的置信度，取值范围：0（**置信度最低**）-100（**置信度最高** ），越高代表文本越有可能属于当前返回的标签；如：*色情 99*，则表明该文本非常有可能属于色情内容；*色情 0*，则表明该文本不属于色情内容。
:type Score: int
:param _Details: 该字段用于返回OCR识别出的结果的详细内容，如：文本内容、对应标签、识别框位置等信息。
注意：此字段可能返回 null，表示取不到有效值。
:type Details: list of OcrTextDetail
:param _Text: 该字段用于返回OCR识别出的文字信息。
:type Text: str
"""
self._Scene = None
self._Suggestion = None
self._Label = None
self._SubLabel = None
self._Score = None
self._Details = None
self._Text = None
@property
def Scene(self):
"""该字段表示识别场景，取值默认为OCR（图片OCR识别）。
:rtype: str
"""
return self._Scene
@Scene.setter
def Scene(self, Scene):
self._Scene = Scene
@property
def Suggestion(self):
"""该字段用于返回优先级最高的恶意标签对应的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
:rtype: str
"""
return self._Suggestion
@Suggestion.setter
def Suggestion(self, Suggestion):
self._Suggestion = Suggestion
@property
def Label(self):
"""该字段用于返回OCR检测结果所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:rtype: str
"""
return self._Label
@Label.setter
def Label(self, Label):
self._Label = Label
@property
def SubLabel(self):
"""该字段用于返回当前标签（Label）下对应的子标签的检测结果，如：*Porn-SexBehavior*等子标签。
:rtype: str
"""
return self._SubLabel
@SubLabel.setter
def SubLabel(self, SubLabel):
self._SubLabel = SubLabel
@property
def Score(self):
"""该字段用于返回当前标签（Label）下的置信度，取值范围：0（**置信度最低**）-100（**置信度最高** ），越高代表文本越有可能属于当前返回的标签；如：*色情 99*，则表明该文本非常有可能属于色情内容；*色情 0*，则表明该文本不属于色情内容。
:rtype: int
"""
return self._Score
@Score.setter
def Score(self, Score):
self._Score = Score
@property
def Details(self):
"""该字段用于返回OCR识别出的结果的详细内容，如：文本内容、对应标签、识别框位置等信息。
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of OcrTextDetail
"""
return self._Details
@Details.setter
def Details(self, Details):
self._Details = Details
@property
def Text(self):
"""该字段用于返回OCR识别出的文字信息。
:rtype: str
"""
return self._Text
@Text.setter
def Text(self, Text):
self._Text = Text
def _deserialize(self, params):
self._Scene = params.get("Scene")
self._Suggestion = params.get("Suggestion")
self._Label = params.get("Label")
self._SubLabel = params.get("SubLabel")
self._Score = params.get("Score")
if params.get("Details") is not None:
self._Details = []
for item in params.get("Details"):
obj = OcrTextDetail()
obj._deserialize(item)
self._Details.append(obj)
self._Text = params.get("Text")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class OcrTextDetail(AbstractModel):
"""用于返回OCR文本结果详情，图片中的文本越多，可能导致接口返回时间增加。
"""
def __init__(self):
r"""
:param _Text: 该字段用于返回OCR识别出的文本内容。<br>备注：OCR文本识别上限在**5000字节内**。
:type Text: str
:param _Label: 该字段用于返回检测结果所对应的恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:type Label: str
:param _LibId: 该字段用于返回自定义库的ID，以方便自定义库管理和配置。
:type LibId: str
:param _LibName: 该字段用于返回自定义库的名称，以方便自定义库管理和配置。
:type LibName: str
:param _Keywords: 该参数用于返回在当前label下命中的关键词。
:type Keywords: list of str
:param _Score: 该参数用于返回在当前恶意标签下模型命中的分值，取值为**0-100**；分数越高，代表当前场景越符合该恶意标签所对应的场景。
:type Score: int
:param _Location: 该参数用于返回OCR检测框在图片中的位置（左上角xy坐标、长宽、旋转角度），以方便快速定位识别文字的相关信息。
:type Location: :class:`tencentcloud.ims.v20201229.models.Location`
:param _Rate: 该参数用于返回OCR文本识别结果的置信度，取值在**0**（**置信度最低**）-**100**（**置信度最高**），越高代表对应图像越有可能是识别出的文字；如：*你好 99*，则表明OCR识别框内的文字大概率是”你好“。
:type Rate: int
:param _SubLabel: 该字段用于返回检测结果所对应的恶意二级标签。
:type SubLabel: str
:param _HitInfos: 关键词命中位置信息
:type HitInfos: list of OcrHitInfo
"""
self._Text = None
self._Label = None
self._LibId = None
self._LibName = None
self._Keywords = None
self._Score = None
self._Location = None
self._Rate = None
self._SubLabel = None
self._HitInfos = None
@property
def Text(self):
"""该字段用于返回OCR识别出的文本内容。<br>备注：OCR文本识别上限在**5000字节内**。
:rtype: str
"""
return self._Text
@Text.setter
def Text(self, Text):
self._Text = Text
@property
def Label(self):
"""该字段用于返回检测结果所对应的恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告；以及其他令人反感、不安全或不适宜的内容类型。
:rtype: str
"""
return self._Label
@Label.setter
def Label(self, Label):
self._Label = Label
@property
def LibId(self):
"""该字段用于返回自定义库的ID，以方便自定义库管理和配置。
:rtype: str
"""
return self._LibId
@LibId.setter
def LibId(self, LibId):
self._LibId = LibId
@property
def LibName(self):
"""该字段用于返回自定义库的名称，以方便自定义库管理和配置。
:rtype: str
"""
return self._LibName
@LibName.setter
def LibName(self, LibName):
self._LibName = LibName
@property
def Keywords(self):
"""该参数用于返回在当前label下命中的关键词。
:rtype: list of str
"""
return self._Keywords
@Keywords.setter
def Keywords(self, Keywords):
self._Keywords = Keywords
@property
def Score(self):
"""该参数用于返回在当前恶意标签下模型命中的分值，取值为**0-100**；分数越高，代表当前场景越符合该恶意标签所对应的场景。
:rtype: int
"""
return self._Score
@Score.setter
def Score(self, Score):
self._Score = Score
@property
def Location(self):
"""该参数用于返回OCR检测框在图片中的位置（左上角xy坐标、长宽、旋转角度），以方便快速定位识别文字的相关信息。
:rtype: :class:`tencentcloud.ims.v20201229.models.Location`
"""
return self._Location
@Location.setter
def Location(self, Location):
self._Location = Location
@property
def Rate(self):
"""该参数用于返回OCR文本识别结果的置信度，取值在**0**（**置信度最低**）-**100**（**置信度最高**），越高代表对应图像越有可能是识别出的文字；如：*你好 99*，则表明OCR识别框内的文字大概率是”你好“。
:rtype: int
"""
return self._Rate
@Rate.setter
def Rate(self, Rate):
self._Rate = Rate
@property
def SubLabel(self):
"""该字段用于返回检测结果所对应的恶意二级标签。
:rtype: str
"""
return self._SubLabel
@SubLabel.setter
def SubLabel(self, SubLabel):
self._SubLabel = SubLabel
@property
def HitInfos(self):
"""关键词命中位置信息
:rtype: list of OcrHitInfo
"""
return self._HitInfos
@HitInfos.setter
def HitInfos(self, HitInfos):
self._HitInfos = HitInfos
def _deserialize(self, params):
self._Text = params.get("Text")
self._Label = params.get("Label")
self._LibId = params.get("LibId")
self._LibName = params.get("LibName")
self._Keywords = params.get("Keywords")
self._Score = params.get("Score")
if params.get("Location") is not None:
self._Location = Location()
self._Location._deserialize(params.get("Location"))
self._Rate = params.get("Rate")
self._SubLabel = params.get("SubLabel")
if params.get("HitInfos") is not None:
self._HitInfos = []
for item in params.get("HitInfos"):
obj = OcrHitInfo()
obj._deserialize(item)
self._HitInfos.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class Positions(AbstractModel):
"""标识命中的违规关键词位置信息
"""
def __init__(self):
r"""
:param _Start: 关键词起始位置
:type Start: int
:param _End: 关键词结束位置
:type End: int
"""
self._Start = None
self._End = None
@property
def Start(self):
"""关键词起始位置
:rtype: int
"""
return self._Start
@Start.setter
def Start(self, Start):
self._Start = Start
@property
def End(self):
"""关键词结束位置
:rtype: int
"""
return self._End
@End.setter
def End(self, End):
self._End = End
def _deserialize(self, params):
self._Start = params.get("Start")
self._End = params.get("End")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class RecognitionResult(AbstractModel):
"""识别类型标签结果信息
"""
def __init__(self):
r"""
:param _Label: 当前可能的取值：Scene（图片场景模型）
注意：此字段可能返回 null，表示取不到有效值。
:type Label: str
:param _Tags: Label对应模型下的识别标签信息
注意：此字段可能返回 null，表示取不到有效值。
:type Tags: list of RecognitionTag
"""
self._Label = None
self._Tags = None
@property
def Label(self):
"""当前可能的取值：Scene（图片场景模型）
注意：此字段可能返回 null，表示取不到有效值。
:rtype: str
"""
return self._Label
@Label.setter
def Label(self, Label):
self._Label = Label
@property
def Tags(self):
"""Label对应模型下的识别标签信息
注意：此字段可能返回 null，表示取不到有效值。
:rtype: list of RecognitionTag
"""
return self._Tags
@Tags.setter
def Tags(self, Tags):
self._Tags = Tags
def _deserialize(self, params):
self._Label = params.get("Label")
if params.get("Tags") is not None:
self._Tags = []
for item in params.get("Tags"):
obj = RecognitionTag()
obj._deserialize(item)
self._Tags.append(obj)
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class RecognitionTag(AbstractModel):
"""识别类型标签信息
"""
def __init__(self):
r"""
:param _Name: 标签名称
注意：此字段可能返回 null，表示取不到有效值。
:type Name: str
:param _Score: 置信分：0～100，数值越大表示置信度越高
注意：此字段可能返回 null，表示取不到有效值。
:type Score: int
:param _Location: 标签位置信息，若模型无位置信息，则可能为零值
注意：此字段可能返回 null，表示取不到有效值。
:type Location: :class:`tencentcloud.ims.v20201229.models.Location`
"""
self._Name = None
self._Score = None
self._Location = None
@property
def Name(self):
"""标签名称
注意：此字段可能返回 null，表示取不到有效值。
:rtype: str
"""
return self._Name
@Name.setter
def Name(self, Name):
self._Name = Name
@property
def Score(self):
"""置信分：0～100，数值越大表示置信度越高
注意：此字段可能返回 null，表示取不到有效值。
:rtype: int
"""
return self._Score
@Score.setter
def Score(self, Score):
self._Score = Score
@property
def Location(self):
"""标签位置信息，若模型无位置信息，则可能为零值
注意：此字段可能返回 null，表示取不到有效值。
:rtype: :class:`tencentcloud.ims.v20201229.models.Location`
"""
return self._Location
@Location.setter
def Location(self, Location):
self._Location = Location
def _deserialize(self, params):
self._Name = params.get("Name")
self._Score = params.get("Score")
if params.get("Location") is not None:
self._Location = Location()
self._Location._deserialize(params.get("Location"))
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
class User(AbstractModel):
"""用于表示业务用户的账号相关信息
"""
def __init__(self):
r"""
:param _UserId: 该字段表示业务用户ID,填写后，系统可根据账号过往违规历史优化审核结果判定，有利于存在可疑违规风险时的辅助判断。<br>
备注：该字段可传入微信openid、QQopenid、字符串等账号信息，与账号类别参数（AccountType）配合使用可确定唯一账号。
:type UserId: str
:param _Nickname: 该字段表示业务用户对应的账号昵称信息。
:type Nickname: str
:param _AccountType: 该字段表示业务用户ID对应的账号类型，取值：**1**-微信uin，**2**-QQ号，**3**-微信群uin，**4**-qq群号，**5**-微信openid，**6**-QQopenid，**7**-其它string。<br>
该字段与账号ID参数（UserId）配合使用可确定唯一账号。
:type AccountType: str
:param _Gender: 该字段表示业务用户对应账号的性别信息。<br>
取值：**0**（默认值，代表性别未知）、**1**（男性）、**2**（女性）。
:type Gender: int
:param _Age: 该字段表示业务用户对应账号的年龄信息。<br>
取值：**0**（默认值，代表年龄未知）-（**自定义年龄上限**）之间的整数。
:type Age: int
:param _Level: 该字段表示业务用户对应账号的等级信息。<br>
取值：**0**（默认值，代表等级未知）、**1**（等级较低）、**2**（等级中等）、**3**（等级较高），目前**暂不支持自定义等级**。
:type Level: int
:param _Phone: 该字段表示业务用户对应账号的手机号信息，支持全球各地区手机号的记录。<br>
备注：请保持手机号格式的统一，如区号格式（086/+86）等。
:type Phone: str
:param _Desc: 该字段表示业务用户的简介信息，支持汉字、英文及特殊符号，**长度不超过5000个汉字字符**。
:type Desc: str
:param _HeadUrl: 该字段表示业务用户头像图片的访问链接(URL)，支持PNG、JPG、JPEG、BMP、GIF、WEBP格式。<br>备注：头像图片**大小不超过5MB**，建议**分辨率不低于256x256**；图片下载时间限制为3秒，超过则会返回下载超时。
:type HeadUrl: str
"""
self._UserId = None
self._Nickname = None
self._AccountType = None
self._Gender = None
self._Age = None
self._Level = None
self._Phone = None
self._Desc = None
self._HeadUrl = None
@property
def UserId(self):
"""该字段表示业务用户ID,填写后，系统可根据账号过往违规历史优化审核结果判定，有利于存在可疑违规风险时的辅助判断。<br>
备注：该字段可传入微信openid、QQopenid、字符串等账号信息，与账号类别参数（AccountType）配合使用可确定唯一账号。
:rtype: str
"""
return self._UserId
@UserId.setter
def UserId(self, UserId):
self._UserId = UserId
@property
def Nickname(self):
"""该字段表示业务用户对应的账号昵称信息。
:rtype: str
"""
return self._Nickname
@Nickname.setter
def Nickname(self, Nickname):
self._Nickname = Nickname
@property
def AccountType(self):
"""该字段表示业务用户ID对应的账号类型，取值：**1**-微信uin，**2**-QQ号，**3**-微信群uin，**4**-qq群号，**5**-微信openid，**6**-QQopenid，**7**-其它string。<br>
该字段与账号ID参数（UserId）配合使用可确定唯一账号。
:rtype: str
"""
return self._AccountType
@AccountType.setter
def AccountType(self, AccountType):
self._AccountType = AccountType
@property
def Gender(self):
"""该字段表示业务用户对应账号的性别信息。<br>
取值：**0**（默认值，代表性别未知）、**1**（男性）、**2**（女性）。
:rtype: int
"""
return self._Gender
@Gender.setter
def Gender(self, Gender):
self._Gender = Gender
@property
def Age(self):
"""该字段表示业务用户对应账号的年龄信息。<br>
取值：**0**（默认值，代表年龄未知）-（**自定义年龄上限**）之间的整数。
:rtype: int
"""
return self._Age
@Age.setter
def Age(self, Age):
self._Age = Age
@property
def Level(self):
"""该字段表示业务用户对应账号的等级信息。<br>
取值：**0**（默认值，代表等级未知）、**1**（等级较低）、**2**（等级中等）、**3**（等级较高），目前**暂不支持自定义等级**。
:rtype: int
"""
return self._Level
@Level.setter
def Level(self, Level):
self._Level = Level
@property
def Phone(self):
"""该字段表示业务用户对应账号的手机号信息，支持全球各地区手机号的记录。<br>
备注：请保持手机号格式的统一，如区号格式（086/+86）等。
:rtype: str
"""
return self._Phone
@Phone.setter
def Phone(self, Phone):
self._Phone = Phone
@property
def Desc(self):
"""该字段表示业务用户的简介信息，支持汉字、英文及特殊符号，**长度不超过5000个汉字字符**。
:rtype: str
"""
return self._Desc
@Desc.setter
def Desc(self, Desc):
self._Desc = Desc
@property
def HeadUrl(self):
"""该字段表示业务用户头像图片的访问链接(URL)，支持PNG、JPG、JPEG、BMP、GIF、WEBP格式。<br>备注：头像图片**大小不超过5MB**，建议**分辨率不低于256x256**；图片下载时间限制为3秒，超过则会返回下载超时。
:rtype: str
"""
return self._HeadUrl
@HeadUrl.setter
def HeadUrl(self, HeadUrl):
self._HeadUrl = HeadUrl
def _deserialize(self, params):
self._UserId = params.get("UserId")
self._Nickname = params.get("Nickname")
self._AccountType = params.get("AccountType")
self._Gender = params.get("Gender")
self._Age = params.get("Age")
self._Level = params.get("Level")
self._Phone = params.get("Phone")
self._Desc = params.get("Desc")
self._HeadUrl = params.get("HeadUrl")
memeber_set = set(params.keys())
for name, value in vars(self).items():
property_name = name[1:]
if property_name in memeber_set:
memeber_set.remove(property_name)
if len(memeber_set) > 0:
warnings.warn("%s fileds are useless." % ",".join(memeber_set))