菜品识别
一、接口描述
1. 功能描述
菜品识别(food classification)API为用户提供菜品识别功能,输入一张菜品图片,返回识别结果。
2. 能力说明:
输入图像限定为菜品图像,不能提供其他类别图像的识别能力。
3. 接口数据要求:
- 图片格式:base64编码
- 图片类型:JPEG,BMP,PNG,GIF
- 图片像素尺寸:最小 50*50 像素,最大 2048*2048 像素
- 图片文件大小:小于2M
4. 接口使用:
使用接口前,需要先完成API的下单购买,然后可使用已经封装好的SDK/参照接口鉴权规则进行相应开发,整体流程详见 接入流程
二、请求说明
1. 接口地址 :
https://aiapi.jd.com/jdai/FoodApi
2. 请求方式:
post
3. 请求参数
(1)query请求参数
公共请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
appkey | string | 是 | 80d2b762ecb86593f9668526920f46c | 您的appkey,可在买家中心控制台中获 |
timestamp | long | 是 | 1541491668060 | 请求的时间戳,精确到毫秒,timestamp有效期5分钟 |
sign | string | 是 | 2e148773a0337a8f2200ba90d445f083 | 签名,根据规则MD5(sectetkey+timestamp) |
(2)body请求参数
业务请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
image | string | 是 | 图像Base64编码值,去掉图片头"data:image/png;base64,", {"image":"4AAQSk..."}(由于过长,不给出示例) | 图像base64编码 |
4、请求代码示例
建议您使用我们提供的SDK进行调用,SDK获取及调用方式详见本页一接口描述中的4接口使用
三、返回说明
1、返回参数
(1)公共返回参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | string | 10000 | 参见下方错误码-系统级错误码 |
charge | boolean | false 或 true | false:不扣费, true:扣费 |
remainTimes | long | 1305 | 剩余调用次数;免费api:每天剩余调用次数;收费api:剩余次数;无限制时为-1 |
remainSeconds | long | 1223456 | 剩余调用时间(s);免费api:-1;收费api:剩余调用时间;无限制时为-1 |
msg | string | 查询成功 | 参见下方错误码-系统级错误码数 |
result | object | {...} | 查询结果 |
(2)业务返回参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
status | int | 1000 | 参照四、错误码-业务错误码 |
message | string | OK | 参照四、错误码-业务错误码 |
result | string | 红烧肉 | 返回菜品识别结果 |
used_time | int | 606 | 整个请求花费的时间,单位为毫秒 |
2、返回示例
{
"code": "10000",
"charge": false,
"remainTimes": 4998,
"remainSeconds": -1,
"msg": "查询成功",
"result": {
"message":"ok ",
"status": 1000,
"used_time": 606
"result": "红烧肉"
}
}
四、错误码
1.系统级错误码
2.业务错误码
业务错误码(status) | message | 说明 |
---|---|---|
1001 | "only post method is allowed" | 错误的访问方法,仅支持post请求 |
1002 | "parameter error, "image" is required" | 缺少必要参数 |
1003 | "invalid image base64 data" | base64图像解析失败 |
1004 | "incorrect image size" | 图像大小超过限制 |
1005 | "not valid json string" | 非法的json字符串 |
1006 | "other error" | 其他错误 |