文本分类API调用文档
更新时间:2023-01-18
本文档主要说明定制化模型发布后获得的API如何使用,如有疑问可以通过以下方式联系我们:
接口描述
基于自定义训练出的文本分类模型,实现个性化文本分类。模型训练完毕后发布可获得定制化文本分类API
接口鉴权
1、在BML——控制台创建应用
2、应用列表页获取AK SK
请求说明
请求示例
HTTP 方法:POST
请求URL: 请首先进行自定义模型训练,完成训练后可在服务列表中查看并获取url。
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
注意:如果出现336001的错误码很可能是因为请求方式错误,需以json方式请求。
Body请求示例:
{
"text": "<UTF-8编码数据>",
"top_num": 5
}
Body中放置请求参数,参数详情如下:
请求参数
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
text | 是 | string | - | 文本数据,UTF-8编码。最大长度4096汉字 |
top_num | 否 | number | - | 返回分类数量,默认为6个 |
返回说明
返回参数
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | number | 唯一的log id,用于问题定位 |
results | 否 | array(object) | 分类结果数组 |
+name | 否 | string | 分类名称 |
+score | 否 | number | 置信度 |
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
- error_code:错误码。
- error_msg:错误描述信息,帮助理解和解决发生的错误。
例如Access Token失效返回:
{
"error_code": 110,
"error_msg": "Access token invalid or no longer valid"
}
需要重新获取新的Access Token再次请求即可。
错误码 | 错误信息 | 描述 |
---|---|---|
1 | Unknown error | 服务器内部错误,请再次请求, 如果持续出现此类错误,请通过QQ群(649285136)或工单联系技术支持团队。 |
2 | Service temporarily unavailable | 服务暂不可用,请再次请求, 如果持续出现此类错误,请通过QQ群(649285136)或工单联系技术支持团队。 |
3 | Unsupported openapi method | 调用的API不存在,请检查后重新尝试 |
4 | Open api request limit reached | 集群超限额 |
6 | No permission to access data | 无权限访问该用户数据 |
13 | Get service token failed | 获取token失败 |
14 | IAM Certification failed | IAM鉴权失败 |
15 | app not exists or create failed | 应用不存在或者创建失败 |
17 | Open api daily request limit reached | 每天请求量超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请通过QQ群(649285136)联系群管手动提额 |
18 | Open api qps request limit reached | QPS超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请通过QQ群(649285136)联系群管手动提额 |
19 | Open api total request limit reached | 请求总量超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请通过QQ群(649285136)联系群管手动提额 |
100 | Invalid parameter | 无效的access_token参数,请检查后重新尝试 |
110 | Access token invalid or no longer valid | access_token无效 |
111 | Access token expired | access token过期 |
336000 | Internal error | 服务器内部错误,请再次请求, 如果持续出现此类错误,请通过QQ群(868826008)或工单联系技术支持团队 |
336001 | Invalid Argument | 入参格式有误,比如缺少必要参数、文本编码错误等等,可检查下文本编码、代码格式是否有误。有疑问请通过QQ群(868826008)或工单联系技术支持团队 |
336002 | JSON不合法 | 入参格式或调用方式有误,比如缺少必要参数或者代码格式有误。有疑问请通过QQ群(868826008)或工单联系技术支持团队 |
336003 | Base64解码失败 | 图片/音频/文本格式有误或base64编码有误,请根据接口文档检查格式,base64编码请求时注意要去掉头部。有疑问请通过QQ群(868826008)或工单联系技术支持团队 |
336004 | 输入文件大小不合法 | 文本超出大小限制,文本限4M以内,请根据接口文档检查入参格式,有疑问请通过QQ群(868826008)或工单联系技术支持团队 |
336005 | 文本解码失败 | 文本编码错误,请检查并修改文本格式 |
336006 | 缺失必要参数 | text字段缺失(未上传文本) |
336100 | model temporarily unavailable | 遇到该错误码请等待1分钟后再次请求,可恢复正常,若反复重试依然报错或有疑问请通过QQ群(868826008)或工单联系技术支持团队 |