1、接口描述
用于判断图片中是否存在打架行为
2、请求方法
POST
3、接口要求
- 目前仅支持 base64 编码方式请求，暂不支持 url 方式请求
- 支持16张以上图像的base64编码字符串构成的list, 单张图片识别score不准确。图片数量最多不超过64张
- 图片格式限制：目前仅支持 png，jpg，jpeg，bmp格式
4、URI
/v1/aiop/api/2gm1xzigc2kg/action/fight/images
5、请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | json格式 | application/json | |
| appkey | 是 | String | 平台应用appkey | 562b89493b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪 详见文档：Python3调用示例 |
33dfa732-b27b-464f-b15a-21ed6845afd5 | |
| eop-date | 是 | String | 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ 详见文档：Python3调用示例 |
20211221T163014Z | |
| host | 是 | String | 终端节点域名，固定字段 | ai-global.ctapi.ctyun.cn | |
| Eop-Authorization | 是 | String | 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、平台应用的appkey（非必须），用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容 签名逻辑详见文档：认证鉴权和Python3调用示例 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| images | 是 | List | 多个图像的Base64编码字符串构成的list。支持jpg/jpeg/png/bmp格式。多张图片须为连续的视频帧数据，图片数量不超过64 | AAAAAAAAA.... |
6、请求代码示例
Curl -X POST
"https://ai-global.ctapi.ctyun.cn/v1/aiop/api/2gm1xzigc2kg/action/fight/images"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "appkey:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:ai-global.ctapi.ctyun.cn"
--data '{"images":["AAAAAAAAA...."]}'
7、返回值说明
请求成功返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Int | 返回状态，返回 0 表示成功，返回错误代码参考下面的错误代码列表 | 0 | |
| message | 是 | String | 如果statusCode 为 0，返回 success；如果 statusCode非 0，则返回对应的可读错误信息 | success | |
| returnObj | 是 | Object | 返回结果 | returnObj |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| score | 是 | Float | 图片序列包含打架行为的概率, 在0-1之间,科学计数法表示 | 0.001 |
请求失败返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Int | 错误码，放置API对应的错误码 | 4015 | |
| message | 是 | String | 请求失败时返回值固定为"error" | error | |
| details | 是 | String | 返回对应的错误信息 | 请求参数内容错误，图像解析失败 | |
| error | 是 | String | 返回对应的错误码 | AI_OP_4015 |
8、返回值示例
请求成功返回值示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"score" : 0.001
}
}
请求失败返回值示例
{
"statusCode": 4015,
"message": "error",
"details": "图像解析失败",
"error":"AI_OP_4015"
}
9、状态码
| http状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
10、错误码说明
4 位错误码。4 开头为业务错误码，5 开头为服务错误码。
| 错误码 | 错误信息 | 错误描述 |
|---|---|---|
| AI_OP_4003 | 请求体json解析错误，请求必须为json字典 | 请求体json解析错误，请求必须为json字典 |
| AI_OP_4010 | 请求参数缺少images | 请求参数缺少images |
| AI_OP_4012 | 请求类型错误，仅支持list | 请求类型错误，仅支持list |
| AI_OP_4013 | 图片数量不合法，应大于0且小于等于64 | 图片数量不合法，应大于0且小于等于64 |
| AI_OP_4015 | 图像解析失败 | 图像解析失败 |
| AI_OP_5000 | 请求异常，请联系管理员 | 请求异常，请联系管理员 |
| AI_OP_5001 | 推理接口异常，请联系管理员 | 推理接口异常，请联系管理员 |
11、base64 编码规则：使用常规的 safe base64 编码方式
- python 中推荐使用
base64.urlsafe_b64encode()函数进行编码 - java 中推荐使用
BASE64.getUrlEncoder().encodeToString()函数进行编码
