黑白名单上传
POST
http[s]: //evo-gen.xfyun.cn/individuation/gen/upload接口说明
- 黑白名单自定义功能,包括:黑名单 (违禁词替换) 和白名单 (免审词设置) 。
- 接口demo:
黑白名单上传 demo python3语言
黑白名单上传 demo java语言 - 接口要求:
内容 | 说明 |
---|---|
传输方式 | http[s] (为提高安全性,强烈推荐https) |
请求地址 | http[s]: //evo-gen.xfyun.cn/individuation/gen/upload 注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用 |
请求行 | POST /individuation/gen/upload HTTP/1.1 |
字符编码 | UTF-8 |
响应格式 | 统一采用JSON格式 |
开发语言 | 任意,只要可以向讯飞云服务发起HTTP请求的均可 |
适用范围 | 任意操作系统,但因不支持跨域不适用于浏览器,请在后端调用接口 |
文本大小 | base64编码后大小不得超过4M |
data参数具体信息
参数名 | 类型 | 必传 | 描述 |
---|---|---|---|
white_list | string | 否 | 白名单 (免审词设置),免审词之间用逗号隔开 |
black_list | string | 否 | 黑名单 (违禁词替换),违禁词和替换词之间用空格隔开,违禁词之间用逗号隔开 |
base64编码前的data示例:
{
"white_list": "衣据,鱿鱼圈",
"black_list": "战士 展示,支撑 职称,规饭 鬼范,轮到 论道"
}
常见问题
#文本纠错的主要功能是什么?
答:对输入文本进行校对,校对包括拼写、语法、搭配、实体纠错、标点、领导人职称、政治用语及数字纠错等。
#文本纠错支持什么应用平台?
答:目前支持Web API应用平台。
#文本纠错对文本有什么要求吗?
答:最大支持7000字节,请注意中文要控制在2000个字符之内。
请求参数
Body 参数application/json
common
object
必需
公共参数,请求时放在body中上传
app_id
string
必需
在平台申请的appid信息
uid
string
必需
自定义uid,用于区分同一个appid下的不同用户,由字母、数字或下划线组成 注:调用文本纠错时的uid需要与上传黑白名单时的uid一致
business
object
必需
业务参数,请求时放在body中上传
res_id
string
必需
自定义res_id,用于区分同一个appid下的不同资源,由字母、数字或下划线组成 注:调用文本纠错时的res_id需要与上传黑白名单时的res_id一致
data
string
必需
业务数据流参数,上传json格式的黑白名单经过base64编码后的数据,大小不超过 4m
示例
{
"common": {
"app_id": "your_appid",
"uid": "your_uid"
},
"business": {
"res_id": "your_uid"
},
"data": "eyJ3aGl0ZV9saXN0I..."
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
code
integer
错误码,0表示成功
message
string
信息描述
sid
string
每次会话的唯一标识
示例
{
"code": 0,
"message": "success",
"sid": "ctm0001e33f@hu1806f505b94020c902"
}
最后修改时间: 1 年前