tencentcloud-sdk-nodejs 3.0.269 → 3.0.270

package/tencentcloud/tms/v20200713/models.js

@@ -218,13 +218,13 @@ class TextModerationRequest extends  AbstractModel {
         super();
 
         /**
-         * 文本内容Base64编码。原文长度需小于15000字节，即5000个汉字以内。
+         * 文本内容Base64编码。限制原文长度不能超过10000个unicode字符
          * @type {string || null}
          */
         this.Content = null;
 
         /**
-         * 该字段用于标识业务场景。您可以在内容安全控制台创建对应的ID，配置不同的内容审核策略，通过接口调用，默认不填为0，后端使用默认策略。 -- 该字段暂未开放。
+         * 该字段用于标识业务场景。您可以在内容安全控制台创建对应的ID，配置不同的内容审核策略，通过接口调用，默认不填为0，后端使用默认策略
          * @type {string || null}
          */
         this.BizType = null;
@@ -236,13 +236,13 @@ class TextModerationRequest extends  AbstractModel {
         this.DataId = null;
 
         /**
-         * 账号相关信息字段，填入后可识别违规风险账号。
+         * 账号相关信息字段，填入后可识别违规风险账号
          * @type {User || null}
          */
         this.User = null;
 
         /**
-         * 设备相关信息字段，填入后可识别违规风险设备。
+         * 设备相关信息字段，填入后可识别违规风险设备
          * @type {Device || null}
          */
         this.Device = null;
@@ -883,27 +883,25 @@ class TextModerationResponse extends  AbstractModel {
         super();
 
         /**
-         * 您在入参时所填入的Biztype参数。 -- 该字段暂未开放。
+         * 您在入参时所填入的Biztype参数
          * @type {string || null}
          */
         this.BizType = null;
 
         /**
-         * 数据是否属于恶意类型。
- 0：正常 1：可疑
+         * 数据是否属于恶意类型，0：正常 1：可疑
          * @type {number || null}
          */
         this.EvilFlag = null;
 
         /**
-         * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
-以及令人反感、不安全或不适宜的内容类型。
+         * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库，以及令人反感、不安全或不适宜的内容类型
          * @type {string || null}
          */
         this.Label = null;
 
         /**
-         * 建议您拿到判断结果后的执行操作。
+         * 建议您拿到判断结果后的执行操作
 建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
          * @type {string || null}
          */
@@ -911,7 +909,7 @@ class TextModerationResponse extends  AbstractModel {
 
         /**
          * 文本命中的关键词信息，用于提示您文本违规的具体原因，可能会返回多个命中的关键词。（如：加我微信）
-如返回值为空，Score不为空，即识别结果（Label）是来自于语义模型判断的返回值。
+如返回值为空，Score不为空，即识别结果（Label）是来自于语义模型判断的返回值
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {Array.<string> || null}
          */
@@ -925,21 +923,21 @@ class TextModerationResponse extends  AbstractModel {
         this.Score = null;
 
         /**
-         * 接口识别样本后返回的详细结果。
+         * 接口识别样本后返回的详细结果
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {Array.<DetailResults> || null}
          */
         this.DetailResults = null;
 
         /**
-         * 接口识别样本中存在违规账号风险的检测结果。
+         * 接口识别样本中存在违规账号风险的检测结果
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {Array.<RiskDetails> || null}
          */
         this.RiskDetails = null;
 
         /**
-         * 扩展字段，用于特定信息返回，不同客户/Biztype下返回信息不同。
+         * 扩展字段，用于特定信息返回，不同客户/Biztype下返回信息不同
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {string || null}
          */

package/tencentcloud/tms/v20201229/models.js

@@ -25,13 +25,13 @@ class RiskDetails extends  AbstractModel {
         super();
 
         /**
-         * 风险类别，RiskAccount，RiskIP, RiskIMEI
+         * 该字段用于返回账号信息检测对应的风险类别，取值为：**RiskAccount**（账号存在风险）、**RiskIP**（IP地址存在风险）、**RiskIMEI**（移动设备识别码存在风险）。
          * @type {string || null}
          */
         this.Label = null;
 
         /**
-         * 风险等级，1:疑似，2：恶意
+         * 该字段用于返回账号信息检测对应的风险等级，取值为：**1**（疑似存在风险）和**2**（存在恶意风险）。
          * @type {number || null}
          */
         this.Level = null;
@@ -60,31 +60,31 @@ class TextModerationRequest extends  AbstractModel {
         super();
 
         /**
-         * 文本内容Base64编码。原文长度需小于15000字节，即5000个汉字以内。
+         * 该字段表示待检测对象的文本内容，文本需要按utf-8格式编码，长度不能超过10000个字符（按unicode编码计算），并进行 Base64加密
          * @type {string || null}
          */
         this.Content = null;
 
         /**
-         * 该字段用于标识业务场景。您可以在内容安全控制台创建对应的ID，配置不同的内容审核策略，通过接口调用，默认不填为0，后端使用默认策略。 -- 该字段暂未开放。
+         * 该字段表示策略的具体编号，用于接口调度，在内容安全控制台中可配置。若不传入Biztype参数（留空），则代表采用默认的识别策略；传入则会在审核时根据业务场景采取不同的审核策略。<br>备注：Biztype仅为数字、字母与下划线的组合，长度为3-32个字符；不同Biztype关联不同的业务场景与识别能力策略，调用前请确认正确的Biztype
          * @type {string || null}
          */
         this.BizType = null;
 
         /**
-         * 数据ID，英文字母、下划线、-组成，不超过64个字符
+         * 该字段表示您为待检测对象分配的数据ID，传入后可方便您对文件进行标识和管理。<br>取值：由英文字母（大小写均可）、数字及四个特殊符号（_，-，@，#）组成，**长度不超过64个字符**
          * @type {string || null}
          */
         this.DataId = null;
 
         /**
-         * 账号相关信息字段，填入后可识别违规风险账号。
+         * 该字段表示待检测对象对应的用户相关信息，传入后可便于甄别相应违规风险用户
          * @type {User || null}
          */
         this.User = null;
 
         /**
-         * 设备相关信息字段，填入后可识别违规风险设备。
+         * 该字段表示待检测对象对应的设备相关信息，传入后可便于甄别相应违规风险设备
          * @type {Device || null}
          */
         this.Device = null;
@@ -118,7 +118,7 @@ class TextModerationRequest extends  AbstractModel {
 }
 
 /**
- * 文本返回的详细结果
+ * 文本审核返回的详细结果
  * @class
  */
 class DetailResults extends  AbstractModel {
@@ -126,55 +126,60 @@ class DetailResults extends  AbstractModel {
         super();
 
         /**
-         * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
-以及其他令人反感、不安全或不适宜的内容类型。
+         * 该字段用于返回检测结果所对应的全部恶意标签。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告，**Custom**：自定义违规；以及其他令人反感、不安全或不适宜的内容类型。
          * @type {string || null}
          */
         this.Label = null;
 
         /**
-         * 建议您拿到判断结果后的执行操作。
-建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
+         * 该字段用于返回对应当前标签的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {string || null}
          */
         this.Suggestion = null;
 
         /**
-         * 该标签下命中的关键词
+         * 该字段用于返回检测文本命中的关键词信息，用于标注文本违规的具体原因（如：*加我微信*）。该参数可能会有多个返回值，代表命中的多个关键词；如返回值为空且Score不为空，则代表识别结果所对应的恶意标签（Label）是来自于语义模型判断的返回值。
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {Array.<string> || null}
          */
         this.Keywords = null;
 
         /**
-         * 该标签模型命中的分值
+         * 该字段用于返回当前标签（Label）下的置信度，取值范围：0（**置信度最低**）-100（**置信度最高** ），越高代表文本越有可能属于当前返回的标签；如：*色情 99*，则表明该文本非常有可能属于色情内容；*色情 0*，则表明该文本不属于色情内容。
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {number || null}
          */
         this.Score = null;
 
         /**
-         * 仅当Label为Custom自定义关键词时有效，表示自定义关键词库类型，1:黑白库，2：自定义库
+         * 该字段**仅当Label为Custom自定义关键词时有效**，用于返回自定义关键词对应的词库类型，取值为**1**（黑白库）和**2**（自定义关键词库），若未配置自定义关键词库,则默认值为1（黑白库匹配）。
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {number || null}
          */
         this.LibType = null;
 
         /**
-         * 仅当Label为Custom自定义关键词时有效，表示自定义库id
+         * 该字段**仅当Label为Custom：自定义关键词时该参数有效**,用于返回自定义库的ID，以方便自定义库管理和配置。
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {string || null}
          */
         this.LibId = null;
 
         /**
-         * 仅当Labe为Custom自定义关键词时有效，表示自定义库名称
+         * 该字段**仅当Label为Custom：自定义关键词时该参数有效**,用于返回自定义库的名称,以方便自定义库管理和配置。
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {string || null}
          */
         this.LibName = null;
 
+        /**
+         * 该字段用于返回当前标签（Label）下的二级标签。
+注意：此字段可能返回 null，表示取不到有效值。
+         * @type {string || null}
+         */
+        this.SubLabel = null;
+
     }
 
     /**
@@ -191,12 +196,13 @@ class DetailResults extends  AbstractModel {
         this.LibType = 'LibType' in params ? params.LibType : null;
         this.LibId = 'LibId' in params ? params.LibId : null;
         this.LibName = 'LibName' in params ? params.LibName : null;
+        this.SubLabel = 'SubLabel' in params ? params.SubLabel : null;
 
     }
 }
 
 /**
- * 用户相关信息
+ * 用于表示业务用户的账号相关信息
  * @class
  */
 class User extends  AbstractModel {
@@ -204,47 +210,66 @@ class User extends  AbstractModel {
         super();
 
         /**
-         * 用户账号ID，如填写，会根据账号历史恶意情况，判定消息有害结果，特别是有利于可疑恶意情况下的辅助判断。账号可以填写微信uin、QQ号、微信openid、QQopenid、字符串等。该字段和账号类别确定唯一账号。
+         * 该字段表示业务用户ID,填写后，系统可根据账号过往违规历史优化审核结果判定，有利于存在可疑违规风险时的辅助判断。<br>
+备注：该字段可传入微信openid、QQopenid、字符串等账号信息，与账号类别参数（AccountType）配合使用可确定唯一账号。
          * @type {string || null}
          */
         this.UserId = null;
 
         /**
-         * 用户昵称
+         * 该字段表示业务用户对应的账号昵称信息。
          * @type {string || null}
          */
         this.Nickname = null;
 
         /**
-         * 账号类别，"1-微信uin 2-QQ号 3-微信群uin 4-qq群号 5-微信openid 6-QQopenid 7-其它string"
+         * 该字段表示业务用户ID对应的账号类型，取值：**1**-微信uin，**2**-QQ号，**3**-微信群uin，**4**-qq群号，**5**-微信openid，**6**-QQopenid，**7**-其它string。<br>
+该字段与账号ID参数（UserId）配合使用可确定唯一账号。
          * @type {number || null}
          */
         this.AccountType = null;
 
         /**
-         * 性别 默认0 未知 1 男性 2 女性
+         * 该字段表示业务用户对应账号的性别信息。<br>
+取值：**0**（默认值，代表性别未知）、**1**（男性）、**2**（女性）。
          * @type {number || null}
          */
         this.Gender = null;
 
         /**
-         * 年龄 默认0 未知
+         * 该字段表示业务用户对应账号的年龄信息。<br>
+取值：**0**（默认值，代表年龄未知）-（**自定义年龄上限**）之间的整数。
          * @type {number || null}
          */
         this.Age = null;
 
         /**
-         * 用户等级，默认0 未知 1 低 2 中 3 高
+         * 该字段表示业务用户对应账号的等级信息。<br>
+取值：**0**（默认值，代表等级未知）、**1**（等级较低）、**2**（等级中等）、**3**（等级较高），目前**暂不支持自定义等级**。
          * @type {number || null}
          */
         this.Level = null;
 
         /**
-         * 手机号
+         * 该字段表示业务用户对应账号的手机号信息，支持全球各地区手机号的记录。<br>
+备注：请保持手机号格式的统一，如区号格式（086/+86）等。
          * @type {string || null}
          */
         this.Phone = null;
 
+        /**
+         * 该字段表示业务用户头像图片的访问链接(URL)，支持PNG、JPG、JPEG、BMP、GIF、WEBP格式。
+备注：头像图片大小不超过5MB，建议分辨率不低于256x256；图片下载时间限制为3秒，超过则会返回下载超时。
+         * @type {string || null}
+         */
+        this.HeadUrl = null;
+
+        /**
+         * 该字段表示业务用户的简介信息，支持汉字、英文及特殊符号，长度不超过5000个汉字字符。
+         * @type {string || null}
+         */
+        this.Desc = null;
+
     }
 
     /**
@@ -261,12 +286,14 @@ class User extends  AbstractModel {
         this.Age = 'Age' in params ? params.Age : null;
         this.Level = 'Level' in params ? params.Level : null;
         this.Phone = 'Phone' in params ? params.Phone : null;
+        this.HeadUrl = 'HeadUrl' in params ? params.HeadUrl : null;
+        this.Desc = 'Desc' in params ? params.Desc : null;
 
     }
 }
 
 /**
- * 设备信息
+ * 用于表示业务用户对应的设备信息
  * @class
  */
 class Device extends  AbstractModel {
@@ -274,43 +301,45 @@ class Device extends  AbstractModel {
         super();
 
         /**
-         * 用户IP
+         * 该字段表示业务用户对应设备的IP地址。<br>
+备注:目前仅支持IPv4地址记录，不支持IPv6地址记录。
          * @type {string || null}
          */
         this.IP = null;
 
         /**
-         * Mac地址
+         * 该字段表示业务用户对应的MAC地址，以方便设备识别与管理；其格式与取值与标准MAC地址一致。
          * @type {string || null}
          */
         this.Mac = null;
 
         /**
-         * 设备指纹Token
+         * *内测中，敬请期待。*
          * @type {string || null}
          */
         this.TokenId = null;
 
         /**
-         * 设备指纹ID
+         * *内测中，敬请期待。*
          * @type {string || null}
          */
         this.DeviceId = null;
 
         /**
-         * 设备序列号
+         * 该字段表示业务用户对应设备的**IMEI码**（国际移动设备识别码），该识别码可用于识别每一部独立的手机等移动通信设备，方便设备识别与管理。<br>备注：格式为**15-17位纯数字**。
          * @type {string || null}
          */
         this.IMEI = null;
 
         /**
-         * IOS设备，Identifier For Advertising（广告标识符）
+         * **iOS设备专用**，该字段表示业务用户对应的**IDFA**(广告标识符),这是由苹果公司提供的用于标识用户的广告标识符，由一串16进制的32位数字和字母组成。<br>
+备注：苹果公司自2021年iOS14更新后允许用户手动关闭或者开启IDFA，故此字符串标记有效性可能有所降低。
          * @type {string || null}
          */
         this.IDFA = null;
 
         /**
-         * IOS设备，IDFV - Identifier For Vendor（应用开发商标识符）
+         * **iOS设备专用**，该字段表示业务用户对应的**IDFV**(应用开发商标识符),这是由苹果公司提供的用于标注应用开发商的标识符，由一串16进制的32位数字和字母组成，可被用于唯一标识设备。
          * @type {string || null}
          */
         this.IDFV = null;
@@ -344,68 +373,71 @@ class TextModerationResponse extends  AbstractModel {
         super();
 
         /**
-         * 您在入参时所填入的Biztype参数。 -- 该字段暂未开放。
+         * 该字段用于返回请求参数中的BizType参数
          * @type {string || null}
          */
         this.BizType = null;
 
         /**
-         * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
-以及其他令人反感、不安全或不适宜的内容类型。
+         * 该字段用于返回检测结果（DetailResults）中所对应的**优先级最高的恶意标签**，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Normal**：正常，**Porn**：色情，**Abuse**：谩骂，**Ad**：广告，**Custom**：自定义违规；以及其他令人反感、不安全或不适宜的内容类型
          * @type {string || null}
          */
         this.Label = null;
 
         /**
-         * 建议您拿到判断结果后的执行操作。
-建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
+         * 该字段用于返回后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。<br>返回值：**Block**：建议屏蔽，**Review** ：建议人工复审，**Pass**：建议通过
          * @type {string || null}
          */
         this.Suggestion = null;
 
         /**
-         * 文本命中的关键词信息，用于提示您文本违规的具体原因，可能会返回多个命中的关键词。（如：加我微信）
-如返回值为空，Score不为空，即识别结果（Label）是来自于语义模型判断的返回值。
+         * 该字段用于返回当前标签（Label）下被检测文本命中的关键词信息，用于标注文本违规的具体原因（如：*加我微信*）。该参数可能会有多个返回值，代表命中的多个关键词；如返回值为空且Score不为空，则代表识别结果所对应的恶意标签（Label）是来自于语义模型判断的返回值
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {Array.<string> || null}
          */
         this.Keywords = null;
 
         /**
-         * 机器判断当前分类的置信度，取值范围：0.00~100.00。分数越高，表示越有可能属于当前分类。
-（如：色情 99.99，则该样本属于色情的置信度非常高。）
+         * 该字段用于返回当前标签（Label）下的置信度，取值范围：0（**置信度最低**）-100（**置信度最高** ），越高代表文本越有可能属于当前返回的标签；如：*色情 99*，则表明该文本非常有可能属于色情内容；*色情 0*，则表明该文本不属于色情内容
          * @type {number || null}
          */
         this.Score = null;
 
         /**
-         * 接口识别样本后返回的详细结果。
+         * 该字段用于返回基于文本风险库审核的详细结果，返回值信息可参阅对应数据结构（DetailResults）的详细描述
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {Array.<DetailResults> || null}
          */
         this.DetailResults = null;
 
         /**
-         * 接口识别样本中存在违规账号风险的检测结果。
+         * 该字段用于返回文本检测中存在违规风险的账号检测结果，主要包括违规风险类别和风险等级信息，具体内容可参阅对应数据结构（RiskDetails）的详细描述
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {Array.<RiskDetails> || null}
          */
         this.RiskDetails = null;
 
         /**
-         * 扩展字段，用于特定信息返回，不同客户/Biztype下返回信息不同。
+         * 该字段用于返回根据您的需求配置的额外附加信息（Extra），如未配置则默认返回值为空。<br>备注：不同客户或Biztype下返回信息不同，如需配置该字段请提交工单咨询或联系售后专员处理
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {string || null}
          */
         this.Extra = null;
 
         /**
-         * 请求参数中的DataId
+         * 该字段用于返回检测对象对应请求参数中的DataId，与输入的DataId字段中的内容对应
 注意：此字段可能返回 null，表示取不到有效值。
          * @type {string || null}
          */
         this.DataId = null;
 
+        /**
+         * 该字段用于返回当前标签（Label）下的二级标签。
+注意：此字段可能返回 null，表示取不到有效值。
+         * @type {string || null}
+         */
+        this.SubLabel = null;
+
         /**
          * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
          * @type {string || null}
@@ -446,6 +478,7 @@ class TextModerationResponse extends  AbstractModel {
         }
         this.Extra = 'Extra' in params ? params.Extra : null;
         this.DataId = 'DataId' in params ? params.DataId : null;
+        this.SubLabel = 'SubLabel' in params ? params.SubLabel : null;
         this.RequestId = 'RequestId' in params ? params.RequestId : null;
 
     }

package/tencentcloud/tms/v20201229/tms_client.js

@@ -35,7 +35,24 @@ class TmsClient extends AbstractClient {
     }
     
     /**
-     * 文本内容检测（Text Moderation）服务使用了深度学习技术，识别可能令人反感、不安全或不适宜的文本内容，同时支持用户配置词库黑白名单，打击自定义识别类型的图片。
+     * 本接口（Text Moderation）用于提交文本内容进行智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通文本内容安全服务](https://console.cloud.tencent.com/cms/text/package) 并调整好对应的业务配置。
+
+### 接口使用说明
+- 前往“[内容安全控制台-文本内容安全](https://console.cloud.tencent.com/cms/text/package)”开启使用文本内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含**1万条**文本识别额度，有效期为1个月。
+- 该接口为收费接口，计费方式敬请参见 [腾讯云文本内容安全定价](https://cloud.tencent.com/product/tms/pricing)。
+
+### 接口功能说明：
+- 支持对文本文件进行检测，通过深度学习技术，识别可能令人反感、不安全或不适宜的违规文本内容；
+- 支持识别多种违规场景，包括：低俗、谩骂、色情、广告等场景；
+- 支持根据不同的业务场景配置自定义的审核策略，可在控制台文本内容安全-策略管理中配置；
+- 支持用户自定义配置词库黑白名单，打击自定义识别类型的违规文本（目前仅支持黑名单配置）；
+- 支持在审核文本内容时同时关联账号或设备信息，可识别违规风险账号或设备。
+
+### 接口调用说明：
+- 文本内容大小支持：文本原文长度不能超过unicode编码长度10000个字符；
+- 文本审核语言支持：目前支持中文、英文、阿拉伯数字的检测；
+- 默认接口请求频率限制：**1000次/秒**，超过该频率限制则接口会报错。
+
      * @param {TextModerationRequest} req
      * @param {function(string, TextModerationResponse):void} cb
      * @public