文档简介：
文本纠错接口说明
接口描述
用于自动识别并纠正一段文本中的字词语法错误
接口要求
文本格式：
1. 仅支持单段文本，长度不超过1000
2. 仅支持简体中文和繁体中文文本，如果文本内容超过50%非中文，则返回错误，具体见错误码4005对应内容
3. 对于未超过50%的非中文，自动略过，不予纠错
请求说明
-
请求示例
HTTP方法：POST
请求URL：https://ai.ctyun.cn/v1/aiop/api/[系统生成的服务码]/nlp/text-correct
-
请求头说明
|
参数 |
值(说明) |
|
Content-Type |
application/json |
|
Sign |
MD5(AppKey + AppSecret + Timestamp + Path + Http Body)，32位小写的MD5加密串 |
|
Timestamp |
13位时间戳 |
|
AppKey |
平台分配给应用独立的AppKey |
-
请求参数
|
参数 |
是否必选 |
类型 |
可选值范围 |
说明 |
|
data |
true |
str |
- |
请求参数放置于http body中，支持一段文本的处理 |
-
请求示例代码
Bash：
curl -X POST https://ai.ctyun.cn/v1/aiop/api/[系统生成的服务码]/nlp/text-correct -H "Content-Type: application/json" -H 'Sign: XXXXX' -H 'Timestamp: XXXXX' -H 'AppKey: XXXXX' --data '{"data": "string"}'
Python：
# -*- coding: utf-8 -*-
import requests
import base64
import hashlib
import time
import json
'''
文本纠错
'''
def md5(key):
input_name = hashlib.md5()
input_name.update(key.encode("utf-8"))
return input_name.hexdigest()
request_url = "文本纠错的API URL"
params = {"data": "string"}
app_key = '平台分配的APP Key'
app_secret = '平台分配的APP Secret '
time_stamp = str(int(round(time.time() * 1000)))
headers = {
'content-type': 'application/json',
'Sign': md5(app_key + app_secret + time_stamp + '/v1/aiop/api/[系统生成的服务码]/nlp/text-correct' + json.dumps(params)),
'Timestamp': time_stamp,
'AppKey': app_key
}
response = requests.post(request_url, data=json.dumps(params), headers=headers)
if response:
print(response.json())
返回说明
-
API调用成功返回值
|
返回字段 |
是否必选 |
类型 |
字段说明 |
|
code |
true |
int |
返回状态，返回0表示成功 |
|
message |
true |
string |
返回对应的可读消息，值为success |
|
result |
true |
object |
API具体返回信息 |
|
corrected |
true |
string |
纠正后的文本字符串 |
|
details |
true |
list of list |
错误的详细信息：[[错误字符，纠正字符, 开始索引，结束索引]] |
API调用失败返回值
|
返回字段 |
是否必选 |
类型 |
字段说明 |
|
code |
true |
int |
错误码，参见本文档错误码说明部分 |
|
message |
true |
string |
返回对应的可读消息，值为error |
|
details |
true |
string |
错误消息 |
-
返回示例
HTTP/1.1 200 OK
Content-Type: application/json
{
'code': 0,
'message': 'success',
'result': [
{
'corrected': '我们是中国电信的员工',
'details': [
['我门', '我们', 0, 2],
['中过', '中国', 3, 5],
['点信', '电信', 5, 7],
['源工', '员工', 8, 10]
]
}
]
}
错误码说明
|
错误代码 |
错误消息 |
错误可能原因 |
|
4001 |
请求未包含内容 |
请求体中存在空字符串或者全为空格等转义字符 |
|
4002 |
请求参数异常 |
请求的参数格式不正确或者参数名错误 |
|
4003 |
单次批量请求数量超过指定数目 |
传入了多段文本，目前仅支持单段文本 |
|
4004 |
单条文本长度超过限度 |
传递的文本中存在超过规定最大长度的文本，最大长度为1000 |
|
4005 |
请求文本为非法字符串 |
传递的文本中存在大量的非中文字符，非中文字符占比不能超过50% |
|
4006 |
不支持的请求方法 |
仅支持HTTP POST请求方法 |
|
4007 |
请求的API不存在 |
请求的API路径错误 |
|
5000 |
服务内部错误 |
服务内部发生错误，需要联系管理员处理 |
