调用API

更新时间：2024-01-25

接口描述

基于自定义训练出的文本分类模型，实现个性化文本识别。模型训练完毕后发布可获得定制化文本分类API 详情访问：EasyDL 文本分类-单标签进行训练。

更多训练模型过程中的常见问题请查看常见问题文档。

如有其它问题，请在百度云控制台内提交工单反馈。

请求说明

请求示例

HTTP 方法：POST

请求URL：请首先在EasyDL 文本分类-单标签进行自定义模型训练，完成训练后可在服务列表中查看并获取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": 6
}

Body中放置请求参数，参数详情如下：

请求参数

参数	是否必选	类型	可选值范围	说明
text	是	string	-	文本数据，UTF-8编码。最大长度4096汉字
top_num	否	number	-	返回分类数量，默认为6个

请求示例代码

Python3

"""
EasyDL 文本分类单标签 调用模型公有云API Python3实现
"""

import json
import base64
import requests
"""
使用 requests 库发送请求
使用 pip（或者 pip3）检查我的 python3 环境是否安装了该库，执行命令
  pip freeze | grep requests
若返回值为空，则安装该库
  pip install requests
"""


# 目标文本的 本地文件路径，UTF-8编码，最大长度4096汉字
TEXT_FILEPATH = "【您的测试文本地址，例如：./example.txt】"

# 可选的请求参数
# top_num: 返回的分类数量，不声明的话默认为 6 个
PARAMS = {"top_num": 2}

# 服务详情 中的 接口地址
MODEL_API_URL = "【您的API地址】"

# 调用 API 需要 ACCESS_TOKEN。若已有 ACCESS_TOKEN 则于下方填入该字符串
# 否则，留空 ACCESS_TOKEN，于下方填入 该模型部署的 API_KEY 以及 SECRET_KEY，会自动申请并显示新 ACCESS_TOKEN
ACCESS_TOKEN = "【您的ACCESS_TOKEN】"
API_KEY = "【您的API_KEY】"
SECRET_KEY = "【您的SECRET_KEY】"


print("1. 读取目标文本 '{}'".format(TEXT_FILEPATH))
with open(TEXT_FILEPATH, 'r') as f:
    text_str = f.read()
print("将读取的文本填入 PARAMS 的 'text' 字段")
PARAMS["text"] = text_str


if not ACCESS_TOKEN:
    print("2. ACCESS_TOKEN 为空，调用鉴权接口获取TOKEN")
    auth_url = "https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials"\
               "&client_id={}&client_secret={}".format(API_KEY, SECRET_KEY)
    auth_resp = requests.get(auth_url)
    auth_resp_json = auth_resp.json()
    ACCESS_TOKEN = auth_resp_json["access_token"]
    print("新 ACCESS_TOKEN: {}".format(ACCESS_TOKEN))
else:
    print("2. 使用已有 ACCESS_TOKEN")


print("3. 向模型接口 'MODEL_API_URL' 发送请求")
request_url = "{}?access_token={}".format(MODEL_API_URL, ACCESS_TOKEN)
response = requests.post(url=request_url, json=PARAMS)
response_json = response.json()
response_str = json.dumps(response_json, indent=4, ensure_ascii=False)
print("结果:\n{}".format(response_str))

返回说明

返回参数

字段	是否必选	类型	说明
log_id	是	number	唯一的log id，用于问题定位
results	否	array(object)	分类结果数组
+name	否	string	分类名称
+score	否	number	置信度

在线调试

EasyDL零基础开发平台提供了示例代码中心(API调试平台)-示例代码，用于帮助开发者在线调试接口，查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，简单易用。

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

error_code：错误码。
error_msg：错误描述信息，帮助理解和解决发生的错误。

例如Access Token失效返回：

{
  "error_code": 110,
  "error_msg": "Access token invalid or no longer valid"
}

需要重新获取新的Access Token再次请求即可。

错误码	错误信息	描述
1	Unknown error	服务器内部错误，请再次请求，如果持续出现此类错误，请在百度云控制台内提交工单反馈。
2	Service temporarily unavailable	服务暂不可用，请再次请求，如果持续出现此类错误，请在百度云控制台内提交工单反馈。
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	每天请求量超限额，已上线计费的接口，请直接在控制台开通计费，调用量不受限制，按调用量阶梯计费；未上线计费的接口，请在百度云控制台内提交工单反馈
18	Open api qps request limit reached	QPS超限额，已上线计费的接口，请直接在控制台开通计费，调用量不受限制，按调用量阶梯计费；未上线计费的接口，请在百度云控制台内提交工单反馈
19	Open api total request limit reached	请求总量超限额，已上线计费的接口，请直接在控制台开通计费，调用量不受限制，按调用量阶梯计费；未上线计费的接口，请在百度云控制台内提交工单反馈
100	Invalid parameter	无效的access_token参数，请检查后重新尝试
110	Access token invalid or no longer valid	access_token无效
111	Access token expired	access token过期
336000	Internal error	服务器内部错误，请再次请求，如果持续出现此类错误，请在百度云控制台内提交工单反馈
336001	Invalid Argument	入参格式有误，比如缺少必要参数、文本的编码UTF-8等问题。有疑问请通过QQ群（868826008）或在百度云控制台内提交工单反馈
336002	JSON不合法	入参格式或调用方式有误，比如缺少必要参数或代码格式有误。有疑问请在百度云控制台内提交工单反馈
336003	Base64解码失败	文本格式有误或base64编码有误，请根据接口文档检查格式，base64编码请求时注意要去掉头部。有疑问请在百度云控制台内提交工单反馈
336004	输入文件大小不合法	文本大小不合法，目前支持文本文件类型为支持txt，文本文件大小限制长度最大4096 UTF-8字符。
336005	解码失败	文本编码错误（不是utf-8），目前支持文本文件类型为支持txt。如果遇到请重试，如反复失败，请在百度云控制台内提交工单反馈
336006	缺失必要参数	未上传文本文件
336100	model temporarily unavailable	遇到该错误码请等待1分钟后再次请求，可恢复正常，若反复重试依然报错或有疑问请在百度云控制台内提交工单反馈

调用API

离线API