图片摘要分析接口
更新时间：2024-10-11
图片摘要接口正在邀测阶段，如有需求，请与我们联系。
提交图片摘要分析
- 用户提供图片BOS或URL路径，进行图片分析。
- 该接口为同步接口，即直接在HTTP response body中返回图片分析结果。
- 提交图片摘要分析接口每个账号只支持1QPS。
请求语法
PUT /v1/abstract HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json请求体
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| source | String | 图片路径，支持BOS或URL两种格式（图片大小需要小于10M且宽高都要小于10000） | 是 |
说明：
- 对于BOS图片，
source="bos://<bos-bucket>/<bos-object>”，例如"bos://testbucket/dir/image.jpg”，用户需要确保BOS路径可访问。- 对于URL图片，
source="http://domain.com/dir/image.jpg"，目前仅支持http协议URL，用户需要确保该URL外网可访问。- 图片缩放说明：图片大于4M或宽大于1920 或高大于1920时，分析会对原图进行缩放分析。
请求示例
提供图片BOS路径进行分析：
PUT /v1/abstract HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
"source": "bos://demo_bucket/demo_image.jpg
}提供图片URL进行分析：
PUT /v1/abstract HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
"source": "http://domain.com/dir/image.jpg"
}响应头域
无
响应体
响应示例
图片摘要分析结果查询
用户提供图片BOS或URL路径，进行30天以内的图片分析结果查询。
请求语法
GET /v1/abstract HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| source | String | 图片路径，支持BOS或URL两种格式 | 是 |
请求体
无
请求示例
提供图片进行分析结果查询：
GET /v1/abstract?source=bos%3a%2f%2ftestbucket%2fdir%2fdemo_image.jpg HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
无
响应体
响应示例
图片分析结果说明
分析结果
每个图片的分析结果格式为：
| 参数 | 类型 | 描述 |
|---|---|---|
| source | String | 图片url |
| status | String | 分析状态 |
| results | List | 结果列表，仅仅当status=FINISHED时返回 |
| + type | 枚举，ABSTRACT | 结果类型 |
| + data | String | 结果详情 |
| publishTime | date | 完成时间（UTC时间） |
| error | Object | 失败结果，仅仅当status=Error时返回 |
| + code | String | 失败码 |
| + message | String | 失败详情 |
分析结果示例
分析成功时返回：
HTTP/1.1 200 OK
{
"source": "bos://test-bucket-10/14kvwmszjrs.jpg",
"status": "FINISHED",
"results": [
{
"type": "ABSTRACT",
"data": "图片的内容是一幅古色古香的卷轴，上面写着一首诗。诗的内容是关于秋天的，提到了唐刘禹锡的诗句，以及秋日胜春朝的景象。画面中还描绘了天空上的一鹤排云上，以及引诗情到碧霄的意境。"
}
],
"publishTime": "2024-09-20T02:48:09Z"
}分析失败时返回：
HTTP/1.1 200 OK
{
"error": {
"code": "InternalError",
"message": "subtask video_abstract internal error, please retry"
},
"source": "http://domain.com/dir/image.jpg",
"status": "ERROR"
}