1、接口描述
用于自动识别并纠正一段文本中的音似字、形似字错误。
2、请求方法
POST
3、接口要求
- 文本长度不超过1000个字符
- 仅支持简体中文和繁体中文文本，如果文本内容超过50%非中文，则返回错误，具体见错误码4005对应内容
- 对于未超过50%的非中文，自动略过，不予纠错
- 不支持空字符串或者全为空格以及转义字符等
4、URI
/v1/aiop/api/2grogewxrdwk/nlp/text-correct
5、请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | json格式 | application/json | |
| appkey | 是 | String | 平台应用appkey | 562b89493b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪。 详见文档：Python3调用示例 |
33dfa732-b27b-464f-b15a-21ed6845afd5 | |
| eop-date | 是 | String | 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ。 详见文档：Python3调用示例 |
20211221T163014Z | |
| host | 是 | String | 终端节点域名，固定字段 | ai-global.ctapi.ctyun.cn | |
| Eop-Authorization | 是 | String | 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、平台应用的appkey（非必须），用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 签名逻辑详见文档：认证鉴权和Python3调用示例 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| data | 是 | String | 待处理文本 | 测试文本 |
6、请求代码示例
Curl -X POST
"https://ai-global.ctapi.ctyun.cn/v1/aiop/api/2grogewxrdwk/nlp/text-correct"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "appkey:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:ai-global.ctapi.ctyun.cn"
--data '{"data": "我门是中国点信的源工"}'
7、返回值说明
请求成功返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Int | 返回状态，返回 0 表示成功，返回错误代码参考下面的错误代码列表 | 0 | |
| message | 是 | String | 如果statusCode 为 0，返回 success；如果 statusCode非 0，则返回对应的可读错误信息 | success | |
| returnObj | 是 | List | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| corrected | 是 | String | 纠正后的文本 | 我们是中国电信的员工 | |
| details | 是 | List | 具体错误词以及对应索引区间和正确词 | [['我门', '我们', 0, 2], ['点信', '电信', 5, 7], ['源工', '员工', 8, 10]]}] |
请求失败返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Int | 错误码，放置API对应的错误码 | 5000 | |
| message | 是 | String | 返回对应的错误信息 | error | |
| details | 是 | String | 返回对应的错误描述 | 服务内部错误 | |
| error | 是 | String | 返回对应的错误码 | AI_OP_5000 |
8、返回值示例
请求成功返回值示例
{
"statusCode": 0,
"message": "success",
"returnObj": [
{
"corrected": "我们是中国电信的员工",
"details": [
[
"我门",
"我们",
0,
2
],
[
"点信",
"电信",
5,
7
],
[
"源工",
"员工",
8,
10
]
]
}
]
}
请求失败返回值示例
{
"statusCode": 4001,
"message": "error",
"details": "请求未包含内容",
"error":"AI_OP_4001"
}
9、状态码
| http状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
10、错误码说明
4 位错误码，4 开头为业务错误码，5 开头为服务错误码。
| 错误码 | 错误信息 | 错误描述 |
|---|---|---|
| AI_OP_4001 | 请求未包含内容 | 请求体中存在空字符串或者全为空格等转义字符 |
| AI_OP_4002 | 请求参数异常 | 请求的参数格式不正确或者参数名错误 |
| AI_OP_4003 | 单次批量请求数量超过指定数目 | 传入了多段文本，目前仅支持单段文本 |
| AI_OP_4004 | 单条文本长度超过限度 | 传递的文本中存在超过规定最大长度的文本，最大长度为1000 |
| AI_OP_4005 | 请求文本为非法字符串 | 传递的文本中存在大量的非中文字符，非中文字符占比不能超过50% |
| AI_OP_5000 | 服务内部错误 | 服务内部发生错误，需要联系管理员处理 |
