资讯 社区 文档
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术

物体检测私有API集成文档

本文档主要说明定制化模型本地部署后,如何使用本地API。如还未训练模型,请先前往BML进行训练。

如有疑问可以通过以下方式联系我们:

  • 在百度智能云控制台内提交工单
  • 进入BML社区交流 ,与其他开发者进行互动
  • 加入BML官方QQ群(群号:868826008)联系群管

部署包使用说明

BML定制化物体检测模型的本地部署通过EasyPack实现,目前提供单机一键部署的方式。

在BML控制台申请、下载部署包后,可以参考EasyPack-单机一键部署将软件包部署在本地服务器上。部署成功后,启动服务,即可调用与在线API功能类似的接口。

授权说明

本地部署包根据服务器硬件(CPU单机或GPU单卡)进行授权,只能在申请时提交的硬件指纹所属的硬件上使用。

部署包测试期为1个月,如需购买永久授权,可提交工单咨询

API参考

请求说明

请求示例

HTTP 方法:POST

请求URL: 请首先在BML进行自定义模型训练,完成训练后申请本地部署,本地部署成功后拼接url。

请求URL: http://{IP}:{PORT}/{DEPLOY_NAME}/ObjectDetection IP:服务本地部署所在机器的ip地址 PORT:服务部署后获取的端口 DEPLOY_NAME:申请时填写的本地服务名称

Header如下:

参数
Content-Type application/json

注意:如果出现336001的错误码很可能是因为请求方式错误,与其他图像识别服务不同的是定制化图像识别服务以json方式请求。

Body请求示例:

{
    "image": "<base64数据>"
}

Body中放置请求参数,参数详情如下:

请求参数

参数 是否必选 类型 可选值范围 说明
image string - 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式 注意请去掉头部
threshold number - 默认值为推荐阈值,请在我的模型列表-模型效果查看推荐阈值

返回说明

返回参数

字段 是否必选 类型 说明
log_id number 唯一的log id,用于问题定位
results array(object) 识别结果数组
+name string 分类名称
+score number 置信度
+location
++left number 检测到的目标主体区域到图片左边界的距离
++top number 检测到的目标主体区域到图片上边界的距离
++width number 检测到的目标主体区域的宽度
++height number 检测到的目标主体区域的高度

错误码

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

  • error_code:错误码。
  • error_msg:错误描述信息,帮助理解和解决发生的错误。

例如缺少必要出入参时返回:

{
  "error_code": 336001,
  "error_msg": "Invalid Argument"
}
错误码 错误信息 描述
336000 Internal error 服务器内部错误,请再次请求, 如果持续出现此类错误,请通过QQ群(868826008)或工单联系技术支持团队
336001 Invalid Argument 入参格式有误,比如缺少必要参数、图片base64编码错误等等,可检查下图片编码、代码格式是否有误。有疑问请通过QQ群(868826008)或工单联系技术支持团队
336002 JSON不合法 入参格式或调用方式有误,比如缺少必要参数代码格式是否有误。有疑问请通过QQ群(868826008)或工单联系技术支持团队
336003 Base64解码失败 图片/音频/文本格式有误或base64编码有误,请根据接口文档检查格式,base64编码请求时注意要去掉头部。有疑问请通过QQ群(868826008)或工单联系技术支持团队
336004 输入文件大小不合法 图片超出大小限制,图片限4M以内,请根据接口文档检查入参格式,有疑问请通过QQ群(868826008)或工单联系技术支持团队
336005 图片解码失败 图片编码错误(非jpg,bmp,png等常见图片格式),请检查并修改图片格式
336006 缺失必要参数 image字段缺失(未上传图片)
336100 model temporarily unavailable 遇到该错误码请等待1分钟后再次请求,可恢复正常,若反复重试依然报错或有疑问请通过QQ群(868826008)或工单联系技术支持团队
337000 Auth check failed 离线鉴权调用失败
上一篇
图像分类-单图多标签私有API集成文档
下一篇
如何发布私有API