{
  "name": "cms",
  "display_name": "内容安全",
  "description": "识别有害内容，节省审核人力。",
  "domain": "other",
  "api_version": "2019-03-21",
  "endpoint": "cms.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateKeywordsSamples",
      "description": "创建关键词接口",
      "status": "online",
      "parameters": [
        {
          "name": "UserKeywords",
          "type": "array",
          "required": true,
          "description": "关键词库信息：单次限制写入2000个，词库总容量不可超过10000个。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Content",
              "type": "string",
              "required": true,
              "description": "关键词内容：最多40个字符，并且符合词类型的规则",
              "example": "违法"
            },
            {
              "name": "Label",
              "type": "string",
              "required": true,
              "description": "关键词类型，取值范围为：\"Normal\",\"Polity\",\"Porn\",\"Ad\",\"Illegal\",\"Abuse\",\"Terror\",\"Spam\"",
              "example": "Illegal"
            },
            {
              "name": "Remark",
              "type": "string",
              "required": false,
              "description": "关键词备注：最多100个字符。",
              "example": "xxx"
            },
            {
              "name": "WordType",
              "type": "string",
              "required": false,
              "description": "词类型：Default,Pinyin,English,CompoundWord,ExclusionWord,AffixWord",
              "example": "Default"
            }
          ]
        },
        {
          "name": "LibID",
          "type": "string",
          "required": false,
          "description": "词库ID",
          "example": "xxx-xxx-xxx"
        }
      ],
      "required": [
        "UserKeywords"
      ]
    },
    {
      "name": "DeleteLibSamples",
      "description": "删除关键词接口",
      "status": "online",
      "parameters": [
        {
          "name": "SampleIDs",
          "type": "array",
          "required": true,
          "description": "关键词ID列表",
          "example": "[\"123\",\"456\"]",
          "item_type": "string"
        },
        {
          "name": "LibID",
          "type": "string",
          "required": false,
          "description": "词库ID",
          "example": "xxx-xxx-xxx"
        },
        {
          "name": "SampleContents",
          "type": "array",
          "required": false,
          "description": "关键词内容列表",
          "example": "[\"违规\",\"告警\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "SampleIDs"
      ]
    },
    {
      "name": "DescribeKeywordsLibs",
      "description": "获取用户词库列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "单页条数，最大为100条",
          "example": "100"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "条数偏移量",
          "example": "300"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤器(支持LibName模糊查询,CustomLibIDs词库id列表过滤)",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "查询字段",
              "example": "1"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "查询值",
              "example": "[\"1\"]",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "DescribeLibSamples",
      "description": "获取关键词接口",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "单页条数，最大为100条",
          "example": "100"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "条数偏移量",
          "example": "300"
        },
        {
          "name": "LibID",
          "type": "string",
          "required": false,
          "description": "词库ID",
          "example": "xxx-xxx-xxx"
        },
        {
          "name": "Content",
          "type": "string",
          "required": false,
          "description": "词内容过滤",
          "example": "敏感"
        },
        {
          "name": "EvilTypeList",
          "type": "array",
          "required": false,
          "description": "违规类型列表过滤",
          "example": "[20001,20002]",
          "item_type": "integer"
        },
        {
          "name": "SampleIDs",
          "type": "array",
          "required": false,
          "description": "样本词ID列表过滤",
          "example": "[\"23231\",\"232133\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "ImageModeration",
      "description": "图片内容检测服务（Image Moderation, IM）能自动扫描图片，识别涉黄、涉恐、涉政、涉毒等有害内容，同时支持用户配置图片黑名单，打击自定义的违规图片。",
      "status": "online",
      "parameters": [
        {
          "name": "FileUrl",
          "type": "string",
          "required": false,
          "description": "文件地址",
          "example": "http://123.jpg"
        },
        {
          "name": "FileMD5",
          "type": "string",
          "required": false,
          "description": "文件MD5值",
          "example": "无"
        },
        {
          "name": "FileContent",
          "type": "string",
          "required": false,
          "description": "文件内容 Base64,与FileUrl必须二填一",
          "example": "无"
        }
      ],
      "required": []
    },
    {
      "name": "TextModeration",
      "description": "文本内容检测（Text Moderation）服务使用了深度学习技术，识别涉黄、涉政、涉恐等有害内容，同时支持用户配置词库，打击自定义的违规文本。",
      "status": "online",
      "parameters": [
        {
          "name": "Content",
          "type": "string",
          "required": true,
          "description": "文本内容Base64编码。原文长度需小于15000字节，即5000个汉字以内。"
        },
        {
          "name": "DataId",
          "type": "string",
          "required": false,
          "description": "数据ID，英文字母、下划线、-组成，不超过64个字符"
        },
        {
          "name": "BizType",
          "type": "integer",
          "required": false,
          "description": "该字段用于标识业务场景。您可以在内容安全控制台创建对应的ID，配置不同的内容审核策略，通过接口调用，默认不填为0，后端使用默认策略"
        },
        {
          "name": "User",
          "type": "object",
          "required": false,
          "description": "用户相关信息",
          "children": [
            {
              "name": "Level",
              "type": "integer",
              "required": false,
              "description": "用户等级，默认0 未知 1 低 2 中 3 高"
            },
            {
              "name": "Gender",
              "type": "integer",
              "required": false,
              "description": "性别 默认0 未知 1 男性 2 女性"
            },
            {
              "name": "Age",
              "type": "integer",
              "required": false,
              "description": "年龄 默认0 未知"
            },
            {
              "name": "UserId",
              "type": "string",
              "required": false,
              "description": "用户账号ID，如填写，会根据账号历史恶意情况，判定消息有害结果，特别是有利于可疑恶意情况下的辅助判断。账号可以填写微信uin、QQ号、微信openid、QQopenid、字符串等。该字段和账号类别确定唯一账号。"
            },
            {
              "name": "Phone",
              "type": "string",
              "required": false,
              "description": "手机号"
            },
            {
              "name": "AccountType",
              "type": "integer",
              "required": false,
              "description": "账号类别，\"1-微信uin 2-QQ号 3-微信群uin 4-qq群号 5-微信openid 6-QQopenid 7-其它string\""
            },
            {
              "name": "Nickname",
              "type": "string",
              "required": false,
              "description": "用户昵称"
            }
          ]
        },
        {
          "name": "SdkAppId",
          "type": "integer",
          "required": false,
          "description": "业务应用ID"
        },
        {
          "name": "Device",
          "type": "object",
          "required": false,
          "description": "设备相关信息",
          "children": [
            {
              "name": "IDFV",
              "type": "string",
              "required": false,
              "description": "IOS设备，IDFV - Identifier For Vendor（应用开发商标识符）"
            },
            {
              "name": "TokenId",
              "type": "string",
              "required": false,
              "description": "设备指纹Token"
            },
            {
              "name": "IP",
              "type": "string",
              "required": false,
              "description": "用户IP"
            },
            {
              "name": "Mac",
              "type": "string",
              "required": false,
              "description": "Mac地址"
            },
            {
              "name": "IDFA",
              "type": "string",
              "required": false,
              "description": "IOS设备，Identifier For Advertising（广告标识符）"
            },
            {
              "name": "DeviceId",
              "type": "string",
              "required": false,
              "description": "设备指纹ID"
            },
            {
              "name": "IMEI",
              "type": "string",
              "required": false,
              "description": "设备序列号"
            }
          ]
        }
      ],
      "required": [
        "Content"
      ]
    }
  ]
}