创建分组
一、接口描述
1. 功能描述
创建一个人脸分组,用于存储人脸。一个分组存储的人脸个数不限,一个用户的分组最多不能超过 10 个。
2. 接口使用
平台为每个API提供试用体验服务,您在AI市场选择“免费试用”规格下单后,即可开始体验业内领先的人工智能API服务。 免费试用服务具有调用量、QPS限制,如需更高性能的API服务,可以提交咨询工单,联系京东AI扩容购买。
在获得使用权限后,您可使用已经封装好的SDK/参照接口鉴权规则进行相应开发,整体流程详见 接入流程。
二、请求说明
1. 接口地址:
https://aiapi.jd.com/jdai/groupCreateV1
2. 请求方式:
POST
3. 请求参数
(1)query请求参数
公共请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
appkey | string | 是 | 80d2b762ecb86593f9668526920f46c | 您的appkey,可在买家中心控制台中获 |
timestamp | long | 是 | 1541491668060 | 请求的时间(neuhubUserId戳,精确到毫秒,timestamp有效期5分钟 |
sign | string | 是 | 2e148773a0337a8f2200ba90d445f083 | 签名,根据规则MD5(sectetkey,timestamp) |
(2)body请求参数
业务请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
groupName | string | 是 | 东门 | 分组名称, 可重复,最长为 1000 个字符,超过长度的部分将自动舍弃 |
customInfo | string | 否 | {} | 自定义信息,可用于扩展字段,最长为 100000 个字符,超过长度的部分将自动舍弃 |
返回说明
1、返回参数
(1)公共返回参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | string | 1000 | 参见下方错误码-系统级错误码 |
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)业务返回参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | int | 0 | 状态码,0 为成功,非 0 请参考以下 业务错误码 |
msg | string | Accept | 状态码对应的说明 |
processTimeInMs | long | 34 | 从接收请求到处理结束的耗时,毫秒 |
timestamp | long | 1576728627956 | 返回时的时间戳 |
groupId | string | 5dfaf50087887258d81e4709 | 人脸组的唯一 id |
groupName | string | 东门 | 请求时的 groupName |
customInfo | string | {} | 请求时的 customInfo |
2、返回示例
{
"status": 0,
"charge": false,
"remain": 97,
"msg": "查询成功",
"result": {
"code" : 0,
"msg" : "Accept",
"processTimeInMs" : "34",
"timestamp" : "1576727808390",
"groupId" : "5dfaf50087887258d81e4709",
"groupName" : "g2",
"customInfo" : "{}"
}
}
四、错误码
1.系统级错误码
2.业务错误码
业务错误码(code) | 对应msg | 说明 |
1 | NoRequiredFields | 参数缺失 |
20 | GroupCountHitLimit | 人脸分组个数超过上线 |
31 | RequestBodyIsNotJson | 请求的 body 需要 json 字符串 |
41 | TimeoutException | 处理超时(> 10秒的处理立即返回) |