调用公有云API
更新时间:2024-01-25
本文档主要说明定制化模型发布后获得的API如何使用,如有疑问可以通过以下方式联系我们:
- 在百度云控制台内提交工单
- 进入EasyDL社区交流 ,与其他开发者进行互动
- 加入EasyDL官方QQ群(群号:868826008)联系群管
接口描述
基于自定义训练出的图文匹配模型,实现个性化图文匹配相似度计算。模型训练完毕后发布可获得定制API
接口鉴权
1、在EasyDL——控制台创建应用
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编码文本>",
"image": "<base64数据>"
}
Body中放置请求参数,参数详情如下:
请求参数
字段名称 | 必须 | 类型 | 说明 |
---|---|---|---|
text | 是 | string | 文本,utf-8编码,支持txt格式,文本长度限制为32个字 |
image | 是 | string | 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式 注意请去掉头部 |
请求示例代码
"""
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】"
# 目标图片的 本地文件路径,支持jpg/png/bmp格式
IMAGE_FILEPATH = "【您的测试图片地址,例如:./example.jpg】"
# 服务详情 中的 接口地址
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】"
PARAMS = {}
print("1. 读取目标文本 '{}'".format(TEXT_FILEPATH))
with open(TEXT_FILEPATH, 'r') as f:
text_str = f.read()
print("将读取的文本填入 PARAMS 的 'text' 字段")
PARAMS["text"] = text_str
print("2. 读取目标图片 '{}'".format(IMAGE_FILEPATH))
with open(IMAGE_FILEPATH, 'rb') as f:
base64_data = base64.b64encode(f.read())
base64_str = base64_data.decode('UTF8')
print("将 BASE64 编码后图片的字符串填入 PARAMS 的 'image' 字段")
PARAMS["image"] = base64_str
if not ACCESS_TOKEN:
print("3. 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("3. 使用已有 ACCESS_TOKEN")
print("4. 向模型接口 '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,用于问题定位 |
error_code | 否 | number | 错误码,当请求错误时返回 |
error_msg | 否 | string | 错误描述信息,当请求错误时返回 |
score | 否 | number | 图像与文本信息的匹配度,数值为0-1之间 |
在线调试
EasyDL零基础开发平台提供了 示例代码中心(API调试平台)-示例代码 ,用于帮助开发者在线调试接口,查看在线调用的请求内容和返回结果、复制和下载示例代码等功能,简单易用。
错误示例
需要重新获取新的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)或工单联系技术支持团队;入参格式有误,比如缺少必要参数、图片base64编码错误等等,可检查下图片编码、代码格式是否有误。有疑问请在百度智能云控制台内提交工单反馈 |
336002 | JSON不合法 | 入参格式或调用方式有误,比如缺少必要参数或者代码格式有误。有疑问请通过QQ群(868826008)或工单联系技术支持团队 |
336003 | Base64解码失败 | 图片/音频/文本格式有误或base64编码有误,请根据接口文档检查格式,base64编码请求时注意要去掉头部。有疑问请在百度智能云控制台内提交工单反馈 |
336004 | 输入文本或图片大小不合法 | 文本超出大小限制,每个文本限制512个字符(包括汉字、字符、数字或字母),有疑问请通过QQ群(868826008)或工单联系技术支持团队 ;图片超出大小限制,图片限4M以内,请根据接口文档检查入参格式,有疑问请在百度智能云控制台内提交工单反馈 |
336005 | 文本或图片解码失败 | 文本编码错误,请检查并修改文本格式;图片编码错误(非jpg,bmp,png等常见图片格式),请检查并修改图片格式 |
336006 | 缺失必要参数 | text字段缺失(未上传文本);image字段缺失(未上传图片) |
336100 | model temporarily unavailable | 遇到该错误码请等待1分钟后再次请求,可恢复正常,若反复重试依然报错或有疑问请通过QQ群(868826008)或工单联系技术支持团队 |