智能纠错接口
October 21, 2022About 6 min
智能纠错接口
接口描述
智能纠错接口在通过超大语言模型对文本语义进行深度理解后,能够识别出文本中错误的或有待改进的文本片段,并提供修改建议。
例如输入文本:“河北省赵县的洨河上,有一座世界文明的石拱桥,叫安济桥,又叫赵州桥。它是隋朝的石匠李春涉及和参加建造的,到现在已经有一千三百多年了。”
纠错结果:1、用“闻名”替换“文明”,2、用“设计”替换“涉及”
URL
https://apicheck.xiezuocat.com/api/text_check
HTTP Method
POST
HTTP Header
Content-Type
application/json
Accept
application/json
secret-key
{your-secretKey} (需要替换成您自己的secretKey)
HTTP请求Body
{
"texts":["河北省赵县的洨河上,有一座世界文明的石拱桥,叫安济桥,又叫赵州桥。", "它是隋朝的石匠李春涉及和参加建造的,到现在已经有一千三百多年了。"]
}
texts为需要纠错的文本列表。为了避免一次调用文字过长,影响反应速度,每次文本纠错最长限制为1万字,如果请求超出1万字,将返回错误代码。
HTTP返回Body示例
{
"errCode" : 0,
"errMsg" : "",
"data" : null,
"alerts" : [ [ {
"alertType" : 4,
"alertMessage" : "建议用“闻名”替换“文明”。",
"sourceText" : "文明",
"replaceText" : "闻名",
"start" : 15,
"end" : 16,
"errorType" : 1,
"advancedTip" : false
} ], [ {
"alertType" : 4,
"alertMessage" : "建议用“设计”替换“涉及”。“涉及”指关联到,牵涉到。“设计”指根据一定要求﹐对某项工作预先制定图样﹑方案。",
"sourceText" : "涉及",
"replaceText" : "设计",
"start" : 9,
"end" : 10,
"errorType" : 1,
"advancedTip" : false
} ] ],
"checkLimitInfo" : {
"checkWordCountLeftToday" : "997085",
"totalCheckWordCountLeft" : "997084",
"expireDate" : "2024-02-02 00:00:00"
}
}
alert字段说明
字段 | 说明 | 一定存在 |
alertType | 操作类型(1:sourceText前新增,2:sourceText后新增,3:删除,4:替换,16:没有操作) | 是 |
errorType | 错误类型(1:字词错误,2:标点误用,3:语序问题,5:语法问题,6:敏感词错误,101:日期错误,102:金额错误,103:专用名词错误,104:重复定义,105:序标错误,201:领导人职位称呼错误,202: 行政区划变更) | 是 |
sourceText | 错误文本 | 是 |
replaceText | 替换文本 | 否 |
alertMessage | 错误提示信息是 | 是 |
start | 错误文本第一个字符在全文的坐标(从0开始) | 是 |
end | 错误文本最后一个字符在全文的坐标(从0开始) | 是 |
advancedTip | 当errorType > 100时,该字段返回true。其他情况返回false。 | 是 |
errCode字段说明
值 | 说明 |
0 | 纠错成功 |
-1 | 暂无权限(比如:已过期) |
-6 | 请求过载,请降低调用量 |
401 | 认证失败(secretKey错误) |
413 | 字数已超过一万字,不予检查 |
500 | 纠错失败 |
errorType值说明
值 | 错误类型 | 说明 | 例句 |
1 | 字词错误 | 错别字或当前词不符合当前语境,包括一些专有名词错误 | 常年累月 |
2 | 标点误用 | 比如英文句子中用中文标点。 | How are you? |
3 | 语序问题 | 两个词位置需要对换 | 这是时期不同的思维变革 |
5 | 语法问题 | 表示此句是有语法问题的病句 | 我常去餐厅走火了 |
6 | 敏感词错误 | 比如文章中含有违禁词、脏话等 | |
101 | 日期错误 | 比如2月31号 | 2月31日 |
102 | 金额错误 | 阿拉伯数字和大写人民币金额不一致,合同里面常见 | 五百万元整500000元 |
104 | 重复定义 | 表示在文章中含有多个意思相同但使用的词语不同的名词 | 你是我的员工,他也是我的职工。 |
105 | 序标错误 | 序号不连续 | 1.这是第一段。 2.这是第二段。 4.这是第三段 |
201 | 领导人职位称呼错误 | 例如将党和国家重要领导人姓名或职务写错。 | |
202 | 行政区划变更 | 比如郫县->郫都区 | 我家在郫县 |
请求示例
写作猫官方在 GitHub 上提供 JAVA SDK、 JavaScript SDK 和 Python SDK,能让你轻松使用 JAVA、JavaScript 和 Python 语言调用纠错接口。