自定义忽略词添加接口
2024.11.21 16:52:06
接口说明
通过该接口可以添加自定义的忽略词信息,命中忽略词后会将忽略词部分过滤掉,剩余内容继续进行检测。
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature 参数),以验证用户身份,防止信息被恶意篡改。目前支持MD5,SHA1,SHA256,SM3几种加密算法,详细信息,请参见接口鉴权。
接口要求
- 单次添加不超过200个词。
接口耗时
自定义忽略词添加接口建议超时时间为1s。
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | http://as.dun.163.com/v2/pretreatment/add |
HTTP Method | POST |
请求头
名称 | 类型 | 描述 |
---|---|---|
Content-Type | String | 固定值:"application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成。
公共参数
公共参数包含密钥信息和参数签名信息,公共参数详细见请求公共参数。
业务参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 |
---|---|---|---|---|
version | String | 是 | 4 | 接口版本号,可选值v2 |
description | String | 否 | 128 | 添加描述 |
entitys | String | 是 | 最多200条 | 忽略词列表,逗号分隔 |
请求体示例
entitys=忽略词1,忽略词2&version=v2&description=忽略词添加&signature=xxx&secretId=xxx&businessId=xxx&nonce=420797907×tamp=1662011841562
响应
响应结果
响应字段如下,响应通用字段已省略,详细见响应公共字段:
名称 | 类型 | 是否返回 | 描述 |
---|---|---|---|
result | Object | 是 | 响应结果 |
∟ pretreatmentAddResult | Boolean | 是 | true:添加成功,false:添加失败 |
∟ entityMap | Jsonobject | 是 | 返回格式,忽略词Id:entity |
响应体示例
{
"code":200,
"msg":"ok",
"result":{
"pretreatmentAddResult":true,
"entityMap":{
"1990074":"entity1",
"1990075":"entity2"
}
}
}
响应返回码
响应返回码见:响应返回码
SDK接入方法
为方便开发者调试和接入API,我们提供了配套的开发工具集(SDK),用于简化API接入流程。SDK中各接口调用方式基本相同,接入方式统一,并提供了一些接口调用过程中常见的异常处理方案。以下介绍了SDK的使用流程,以及首次使用SDK的简单示例。
如果您使用的是其他语言,请参考各语言示例demo。
- 准备工作
准备步骤详见通用步骤
- 使用方法
该接口的使用方法可参考以下SDK demo:
Github地址
Java SDK demo
Golang SDK demo
Gitee地址(Github无法访问时选择)
Java SDK demo
Golang SDK demo