推送ImageOcr和ImageClassify消息
更新时间：2021-12-29
接口说明
将ImageOcr和ImageClassify两种产品处理后的事件消息推送到app设置的url上，内容包含BOS的事件信息和AI处理的结果。
如果规则中配置了encryption字段，那么请求中会包含Authorization的签名，保证消息不会被伪造或篡改。
注意：
- Status Code: 200 OK才会认为消息推送成功，否则将会重试；
- 对于过载保护的情况，支持Status Code: 429 Too Many Requests返回值，会间隔一段时间再重试；
请求URI
POST /v1/{bucketName}/?result
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| bucketName | String | 是 | "bucketName_example" | Path |
请求体参数
请求体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| events | List<Events> | 是 |
Events字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| version | String | 否 | 事件版本，当前为1.0 | 1.0 |
| eventType | String | 否 | 事件类型 | PutObject |
| eventTime | String | 是 | 事件发生时间(GMT格式) | 2009-10-28T22:32:00Z |
| content | Content | 是 | 事件具体信息 | |
| imageOcr | ImageOcr | 是 | ||
| imageClassify | ImageClassify | 是 |
Content字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| domain | String | 是 | 所属的domain | bj.bcebos.com |
| bucket | String | 是 | 所属的bucket | bucket-test |
| object | String | 是 | object名字 | images/test.jpg |
| eTag | String | 是 | object的eTag，如果object可能被覆盖，则需要用eTag判断是哪个版本的object触发的事件 | 977b9623a15e520c663ac5ff6647e881 |
ImageOcr字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| log_id | Integer | 是 | 153673668620866 | |
| result | String | 是 | 根据实际的事件为imageOcr和imageClassify，具体内容参见AI通用文字识别和AI通用图像分析 |
ImageClassify字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| log_id | Integer | 是 | 6353842115261500000 | |
| result_num | Integer | 是 | 1 | |
| result | List<Result> | 是 |
响应体参数
响应体字段数据结构说明
请求示例
JSON
1POST /v1/bucketName_example/?result
2<公共请求头>
3
4
5{
6 "events" : [ {
7 "imageOcr" : {
8 "result" : "result",
9 "log_id" : 153673668620866
10 },
11 "eventTime" : "2009-10-28T22:32:00Z",
12 "imageClassify" : {
13 "result" : [ {
14 "score" : 0.566877,
15 "root" : "人物-人物特写",
16 "keyword" : "马尾辫"
17 } ],
18 "log_id" : 6353842115261500000,
19 "result_num" : 1
20 },
21 "eventType" : "PutObject",
22 "version" : "1.0",
23 "content" : {
24 "bucket" : "bucket-test",
25 "domain" : "bj.bcebos.com",
26 "eTag" : "977b9623a15e520c663ac5ff6647e881",
27 "object" : "images/test.jpg"
28 }
29 } ]
30}响应示例
JSON
1HTTP/1.1 200 OK
2<公共响应头>
3
4{ }错误码
请参考通用错误码