相似文本添加接口
2025.03.07 17:59:47
接口说明
通过该接口将相似文本添加到易盾，用于后续文本相似度检测
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature参数），以验证用户身份，防止信息被恶意篡改。目前支持MD5，SHA1，SHA256，SM3几种加密算法，详细信息，请参见接口鉴权
接口要求
- 单次添加不超过200条文本
接口耗时
相似文本添加接口建议超时时间1s
请求
请求地址
| 名称 | 值 |
|---|---|
| HTTP URL | http://as.dun.163.com/v1/similar-text/submit |
| HTTP Method | POST |
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
| Content-Type | String | 固定值："application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成
公共参数
公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数
业务参数
| 名称 | 类型 | 是否必传 | 最大长度 | 描述 |
|---|---|---|---|---|
| version | String | 是 | 4 | 接口版本号，可选值v1 |
| similarText | String | 是 | 1-200条相似文本数据 | 文本数据，json格式对象数组 |
| ∟ content | String | 是 | 10000 | 相似文本内容 |
| ∟ description | String | 否 | 1000 | 文本描述 |
| ∟ dataId | String | 是 | 128 | 数据唯一标识，用于定位数据 |
请求体示例
version=v1&similarText=[{"content":"测试文本内容1","description":"描述1","dataId":"123456"},{"content":"测试文本内容2","description":"描述2","dataId":"123457"}]&signature=c855fbdcb8efa0cc44fafc435708a9a7&businessId=xxxxxxx&secretId=xxxxxxxx&signatureMethod=MD5&nonce=-427093960×tamp=1662011085201
响应结果
| 名称 | 类型 | 是否返回 | 描述 |
|---|---|---|---|
| result | Object[] | 是 | 响应结果 |
| ∟ dataId | String | 是 | 提交的数据ID |
响应体示例
{
"code": 200,
"msg": "ok",
"result": [
{
"dataId": "123456"
},
{
"dataId": "123457"
}
]
}
响应返回码
响应返回码见：响应返回码
示例代码
服务端 SDK 接入
推荐使用我们提供的服务端 SDK 进行接入（目前支持 Java 和 Go 两种语言），不但可以节省接入成本，实现更快速的集成，并享有灵活的请求配置选项，同时 SDK 内置了错误重试、熔断降级等功能，提升服务可用性。点击 服务端 SDK 接入指引 了解更多。
