API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 文本内容安全 > 数据结构

数据结构

最近更新时间：2024-01-12 01:25:59

我的收藏

本页目录：

DetailResults

文本审核返回的详细结果

被如下接口引用：TextModeration。

名称 类型 描述
Label String 该字段用于返回检测结果所对应的全部恶意标签。
返回值：Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告；以及其他令人反感、不安全或不适宜的内容类型。
Suggestion String 该字段用于返回对应当前标签的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。
返回值：Block：建议屏蔽，Review ：建议人工复审，Pass：建议通过
注意：此字段可能返回 null，表示取不到有效值。
Keywords Array of String 该字段用于返回检测文本命中的关键词信息，用于标注文本违规的具体原因（如：加我微信）。该参数可能会有多个返回值，代表命中的多个关键词；如返回值为空且Score不为空，则代表识别结果所对应的恶意标签（Label）是来自于语义模型判断的返回值。
注意：此字段可能返回 null，表示取不到有效值。
Score Integer 该字段用于返回当前标签（Label）下的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表文本越有可能属于当前返回的标签；如：色情 99，则表明该文本非常有可能属于色情内容；色情 0，则表明该文本不属于色情内容。
注意：此字段可能返回 null，表示取不到有效值。
LibType Integer 该字段用于返回自定义关键词对应的词库类型，取值为1（黑白库）和2（自定义关键词库），若未配置自定义关键词库,则默认值为1（黑白库匹配）。
注意：此字段可能返回 null，表示取不到有效值。
LibId String 该字段用于返回自定义库的ID，以方便自定义库管理和配置。
注意：此字段可能返回 null，表示取不到有效值。
LibName String 该字段用于返回自定义库的名称,以方便自定义库管理和配置。
注意：此字段可能返回 null，表示取不到有效值。
SubLabel String 该字段用于返回当前标签（Label）下的二级标签。
注意：此字段可能返回 null，表示取不到有效值。
Tags Array of Tag 该字段用于返回当前一级标签（Label）下的关键词、子标签及分数。
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"Keyword":"约炮","Score":100,"SubLabel":"Sexy"}
HitInfos Array of HitInfo 该字段用于返回违规文本命中信息
注意：此字段可能返回 null，表示取不到有效值。

Device

用于表示业务用户对应的设备信息

被如下接口引用：ModerateText, TextModeration。

名称 类型 必选 描述
IP String 否 该字段表示业务用户对应设备的IP地址。

备注:目前仅支持IPv4地址记录，不支持IPv6地址记录。
Mac String 否 该字段表示业务用户对应的MAC地址，以方便设备识别与管理；其格式与取值与标准MAC地址一致。
TokenId String 否 内测中，敬请期待。
DeviceId String 否 内测中，敬请期待。
IMEI String 否 该字段表示业务用户对应设备的IMEI码（国际移动设备识别码），该识别码可用于识别每一部独立的手机等移动通信设备，方便设备识别与管理。
备注：格式为15-17位纯数字。
IDFA String 否 iOS设备专用，该字段表示业务用户对应的IDFA(广告标识符),这是由苹果公司提供的用于标识用户的广告标识符，由一串16进制的32位数字和字母组成。

备注：苹果公司自2021年iOS14更新后允许用户手动关闭或者开启IDFA，故此字符串标记有效性可能有所降低。
IDFV String 否 iOS设备专用，该字段表示业务用户对应的IDFV(应用开发商标识符),这是由苹果公司提供的用于标注应用开发商的标识符，由一串16进制的32位数字和字母组成，可被用于唯一标识设备。

HitInfo

关键词命中位置信息

被如下接口引用：TextModeration。

名称 类型 描述
Type String 标识模型命中还是关键词命中
注意：此字段可能返回 null，表示取不到有效值。
示例值：Model
Keyword String 命中关键词
注意：此字段可能返回 null，表示取不到有效值。
示例值：啦啦
LibName String 自定义词库名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：测试词库1
Positions Array of Positions 位置信息
注意：此字段可能返回 null，表示取不到有效值。

LabelGrade

内容审核多级标签结构

被如下接口引用：ModerateText。

名称 类型 描述
Code String 内容审核结果客户定制标签码
注意：此字段可能返回 null，表示取不到有效值。
示例值：20001
Grade1 String 内容审核结果客户定制一级标签
注意：此字段可能返回 null，表示取不到有效值。
示例值：违法
Grade2 String 内容审核结果客户定制二级标签
注意：此字段可能返回 null，表示取不到有效值。
示例值：违法直播
Grade3 String 内容审核结果客户定制三级标签
注意：此字段可能返回 null，表示取不到有效值。
示例值：开车直播

LibCheckResult

库检测结果

被如下接口引用：ModerateText。

名称 类型 描述
LibId String 库ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：dg2a89a9hjfdkx0lc
LibName String 库名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：辱骂词汇库
LibType Integer 库类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
Keyword String 命中的关键词
注意：此字段可能返回 null，表示取不到有效值。
示例值：卧槽
Positions Array of Positions 命中的关键词在送审文本的位置，可能存在多个位置，每个位置显示开始位置和结束位置
注意：此字段可能返回 null，表示取不到有效值。

ModelResult

模型检测结果

被如下接口引用：ModerateText。

名称 类型 描述
Content String 模型检测出的违规内容
注意：此字段可能返回 null，表示取不到有效值。
Positions Array of Positions 模型检测出的违规内容的位置
注意：此字段可能返回 null，表示取不到有效值。

ModerationDetail

文本审核明细结果

被如下接口引用：ModerateText。

名称 类型 描述
Suggestion String 审核建议，Block表示建议拦截，Review表示建议人工复审，Pass表示建议放行
注意：此字段可能返回 null，表示取不到有效值。
示例值：Block
Label LabelGrade 命中标签，含标签码和一二三级标签名
注意：此字段可能返回 null，表示取不到有效值。
Score Integer 标签得分
注意：此字段可能返回 null，表示取不到有效值。
示例值：98
TcLabelCodes Array of String label对应腾讯侧命中标签码
注意：此字段可能返回 null，表示取不到有效值。
示例值：[20001002,20001003]
LibResults Array of LibCheckResult 库检测命中详情
注意：此字段可能返回 null，表示取不到有效值。
ModelResults Array of ModelResult 模型检测详情
注意：此字段可能返回 null，表示取不到有效值。
SentimentResult SentimentDetail 情绪正负向检测结果
注意：此字段可能返回 null，表示取不到有效值。

Positions

标识命中的违规关键词位置信息

被如下接口引用：ModerateText, TextModeration。

名称 类型 描述
Start Integer 关键词起始位置
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
End Integer 关键词结束位置
注意：此字段可能返回 null，表示取不到有效值。
示例值：10

RiskDetails

账号风险检测结果

被如下接口引用：TextModeration。

名称 类型 描述
Label String 该字段用于返回账号信息检测对应的风险类别，取值为：RiskAccount（账号存在风险）、RiskIP（IP地址存在风险）、RiskIMEI（移动设备识别码存在风险）。
Level Integer 该字段用于返回账号信息检测对应的风险等级，取值为：1（疑似存在风险）和2（存在恶意风险）。

SentimentAnalysis

情感分析结果

被如下接口引用：TextModeration。

名称 类型 描述
Label String 情感标签
注意：此字段可能返回 null，表示取不到有效值。
示例值：Positive
Score Integer 标签分数，取值范围0到100
注意：此字段可能返回 null，表示取不到有效值。
示例值：50
Detail SentimentDetail 情感分析明细
注意：此字段可能返回 null，表示取不到有效值。
Code String 响应码，成功为"OK"，失败为"InternalError"
示例值：OK
Message String 异常信息
注意：此字段可能返回 null，表示取不到有效值。

SentimentDetail

情感分析明细

被如下接口引用：ModerateText, TextModeration。

名称 类型 描述
Positive Integer 正向分数，取值范围0到100
注意：此字段可能返回 null，表示取不到有效值。
示例值：50
Negative Integer 负向分数，取值范围0到100
注意：此字段可能返回 null，表示取不到有效值。
示例值：50

Tag

该字段用于返回审核结果明细字段的标签及分数

被如下接口引用：TextModeration。

名称 类型 描述
Keyword String 该字段用于返回命中的关键词
注意：此字段可能返回 null，表示取不到有效值。
示例值：习近平
SubLabel String 该字段用于返回子标签
注意：此字段可能返回 null，表示取不到有效值。
示例值：ChinesePresident
Score Integer 该字段用于返回子标签对应的分数
注意：此字段可能返回 null，表示取不到有效值。
示例值：100

User

用于表示业务用户的账号相关信息

被如下接口引用：ModerateText, TextModeration。

名称 类型 必选 描述
UserId String 否 该字段表示业务用户ID,填写后，系统可根据账号过往违规历史优化审核结果判定，有利于存在可疑违规风险时的辅助判断。

备注：该字段可传入微信openid、QQopenid、字符串等账号信息，与账号类别参数（AccountType）配合使用可确定唯一账号。
Nickname String 否 该字段表示业务用户对应的账号昵称信息。
AccountType Integer 否 该字段表示业务用户ID对应的账号类型，取值：1-微信uin，2-QQ号，3-微信群uin，4-qq群号，5-微信openid，6-QQopenid，7-其它string。

该字段与账号ID参数（UserId）配合使用可确定唯一账号。
Gender Integer 否 该字段表示业务用户对应账号的性别信息。

取值：0（默认值，代表性别未知）、1（男性）、2（女性）。
Age Integer 否 该字段表示业务用户对应账号的年龄信息。

取值：0（默认值，代表年龄未知）-（自定义年龄上限）之间的整数。
Level Integer 否 该字段表示业务用户对应账号的等级信息。

取值：0（默认值，代表等级未知）、1（等级较低）、2（等级中等）、3（等级较高），目前暂不支持自定义等级。
Phone String 否 该字段表示业务用户对应账号的手机号信息，支持全球各地区手机号的记录。

备注：请保持手机号格式的统一，如区号格式（086/+86）等。
HeadUrl String 否 该字段表示业务用户头像图片的访问链接(URL)，支持PNG、JPG、JPEG、BMP、GIF、WEBP格式。
备注：头像图片大小不超过5MB，建议分辨率不低于256x256；图片下载时间限制为3秒，超过则会返回下载超时。
Desc String 否 该字段表示业务用户的简介信息，支持汉字、英文及特殊符号，长度不超过5000个汉字字符。
RoomId String 否 该字段表示业务群聊场景时的房间ID。
ReceiverId String 否 该字段表示消息接受者ID
SendTime Integer 否 消息生成时间，精确到毫秒
中国站