检索相关接口
更新时间：2022-08-25
视频检索视频
接口描述
本接口使用视频来检索库中存在的相似视频。
- 检索视频路径支持BOS、HTTP(S) URL路径；
- 本接口为异步接口，可通过查询视频检索结果接口查询检索结果。或通过通知服务回调结果。
请求结构
Plain Text
1POST /v{version}/videolib/{libName}?searchByVideo
2host: mms.bj.baidubce.com
3Authorization: <bce-authorization-string>
4{
5 "source": videoUrl,
6 "description": desc,
7 "notification": notificationName
8}请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| libName | String | 是 | URL参数 | 用户的视频库名称 |
| source | String | 是 | Body参数 | 检索视频的URL |
| description | String | 否 | Body参数 | 用户对此次请求的描述 |
| notification | String | 否 | Body参数 | 检索结果通知的名称 |
- 注：如使用notification参数，需提前配置通知名称及对应的回调地址。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | String | 请求结果 |
| taskId | String | 视频检索任务ID |
请求示例
Plain Text
1POST /v2/videolib/baiduyun_test?searchByVideo
2host: mms.bj.baidubce.com
3Authorization: <bce-authorization-string>
4{
5 "source": "https://test.mp4",
6 "description": "test",
7 "notification": "notification_name"
8}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3{
4 "status": "success",
5 "taskId": "VkcZDXIBrTeiQx_QrcXT"
6}通知服务回调结果示例
Plain Text
1{
2"messageId": "360d15ea-14ae-440e-9be1-f1f431beae19",
3"messageBody": "{\"taskId\":\"ybjMcnIBFaqg3FXUVQrA\",\"status\":\"success\",\"lib\":\"video_lib\",\"source\":\"https://bj.bcebos.com/v1/bucket/test.mp4\",\"duration\":6.5,\"description\":\"\",\"createTime\":\"2020-06-02T02:11:33Z\",\"startTime\":\"2020-06-02T02:12:05Z\",\"updateTime\":\"2020-06-02T02:12:08Z\",\"finishTime\":\"2020-06-02T02:12:08Z\",\"results\":[{\"id\":\"n7CCcHIBTmikKXpp-AS8\",\"name\":\"search_hit.mp4\",\"source\":\"http://bj.bcebos.com/v1/bucket/search_hit.mp4\",\"duration\":6.5,\"description\":\"\",\"type\":\"SEARCH_VIDEO_BY_VIDEO\",\"score\":100,\"clips\":[{\"inputStartTime\":0.0,\"inputEndTime\":6.5,\"outputStartTime\":0.0,\"outputEndTime\":6.5}]}]}"
4}查询视频检索视频结果
接口描述
本接口用于查询视频检索视频任务的结果。
请求结构
Plain Text
1GET /v{version}/videolib/{libName}?getSearchResponseByTaskId&taskId={taskId}
2host: mms.bj.baidubce.com
3Authorization: <bce-authorization-string>请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| libName | String | 是 | URL参数 | 用户的视频库名称 |
| taskId | String | 是 | URL参数 | 检索任务ID |
| getSearchResponseByTaskId | String | 是 | URL参数 | 标识参数，无内容 |
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | String | 任务状态，取值为processing/success/failed，分别为处理中/成功/失败 |
| lib | String | 检索的视频库名称 |
| source | String | 检索视频的URL |
| description | String | 用户传入的请求描述信息 |
| results | List | 检索视频的结果 |
| +score | Double | 检索视频的相似度，取值范围为[0, 100] |
| +source | String | 结果视频的URL |
| +description | String | 结果视频的描述 |
| +clips | List | 请求成功时才会有此值 |
| ++inputStartTime | Double | 检索视频片段的开始时间，单位：秒 |
| ++inputEndTime | Double | 检索视频片段的结束时间，单位：秒 |
| ++outputStartTime | Double | 底库视频片段的开始时间，单位：秒 |
| ++outputEndTime | Double | 底库视频片段的结束时间，单位：秒 |
| error | Object | 请求失败时才会有此值 |
| +code | String | 请求失败时才会有此值，表示错误码 |
| +message | String | 请求失败时才会有此值，表示错误信息 |
请求示例
Plain Text
1GET /v2/videolib/baiduyun_test?getSearchResponseByTaskId&taskId={taskId}
2host: mms.bj.baidubce.com
3Authorization: <bce-authorization-string>响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3{
4 "status":"success",
5 "lib":"baiduyun_test",
6 "source":"https://test.mp4",
7 "description":"test",
8 "results":[
9 {
10 "source":"https://test.mp4",
11 "description":"test",
12 "score":100,
13 "clips":[
14 {
15 "inputStartTime":0.08,
16 "inputEndTime":20.16,
17 "outputStartTime":0.08,
18 "outputEndTime":20.16
19 }
20 ]
21 }
22 ]
23}图片检索图片
接口描述
本接口使用图片来检索库中存在的相似图片。
- 图片路径支持BOS、HTTP(S) URL路径；
- 图片格式支持jpg、JPG、png、PNG、jpeg、JEPG格式；
请求结构
Plain Text
1POST /v{version}/imagelib/{libName}?searchByImage
2host: mms.bj.baidubce.com
3Authorization: <bce-authorization-string>
4{
5 "source": imageUrl,
6 "description": desc
7}请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| libName | String | 是 | URL参数 | 用户的图片库名称 |
| source | String | 是 | Body参数 | 检索图片的URL |
| description | String | 否 | Body参数 | 用户对此次请求的描述 |
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | String | 请求结果 |
| lib | String | 检索的图片库名称 |
| source | String | 用户传入的图片URL |
| description | String | 用户传入的请求描述信息 |
| results | List | 检索图片的结果 |
| +distance | Double | 检索图片的相似度，取值范围为[0, 1]，越小越相似 |
| +source | String | 结果图片的URL |
| +description | String | 结果图片的描述 |
| error | Object | 请求失败时才会有此值 |
| +code | String | 请求失败时才会有此值，表示错误码 |
| +message | String | 请求失败时才会有此值，表示错误信息 |
请求示例
Plain Text
1POST /v2/imagelib/baiduyun_test?searchByImage
2host: mms.bj.baidubce.com
3Authorization: <bce-authorization-string>
4{
5 "source": "http://bj.bcebos.com/test.jpg",
6 "description": "nothing to desc"
7}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3{
4 "status": "success",
5 "lib":" baiduyun_test",
6 "source": "http://bj.bcebos.com/test.jpg",
7 "description": "nothing to desc",
8 "results": [
9 {
10 "distance": 0.12,
11 "source": "http://bj.bcebos.com/test2.jpg",
12 "description":"nothing to desc"
13 }
14 ]
15}图片检索视频
接口描述
本接口使用图片来检索库中存在的包含相似图片的视频。
- 图片路径支持BOS、HTTP(S) URL路径；
- 图片格式支持jpg、JPG、png、PNG、jpeg、JEPG格式；
请求结构
Plain Text
1POST /v{version}/videolib/{libName}?searchByImage
2host: mms.bj.baidubce.com
3Authorization: <bce-authorization-string>
4{
5 "source": imageUrl,
6 "description": desc
7}请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| libName | String | 是 | URL参数 | 用户的视频库名称 |
| source | String | 是 | Body参数 | 检索图片的URL |
| description | String | 否 | Body参数 | 用户对此次请求的描述 |
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | String | 请求结果 |
| lib | String | 检索的视频库名称 |
| source | String | 用户传入的图片URL |
| description | String | 用户传入的请求描述信息 |
| results | List | 检索视频的结果 |
| +source | String | 结果视频的URL |
| +distance | Double | 结果视频中命中最相似图片的相似度，取值范围为[0, 1] |
| +description | String | 结果视频的描述 |
| +frames | List | 结果视频中对应的图片 |
| ++distance | Double | 视频中对应图片的相似度，取值范围为[0, 1] |
| ++timestamp | Double | 视频中对应图片的时间戳，单位为秒（s） |
| error | Object | 请求失败时才会有此值 |
| +code | String | 请求失败时才会有此值，表示错误码 |
| +message | String | 请求失败时才会有此值，表示错误信息 |
请求示例
Plain Text
1POST /v2/videolib/baiduyun_test?searchByImage
2host: mms.bj.baidubce.com
3Authorization: <bce-authorization-string>
4{
5 "source": "http://bj.bcebos.com/test.jpg",
6 "description": "nothing to desc"
7}响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3{
4 "status": "success",
5 "lib":" baiduyun_test",
6 "source": "http://bj.bcebos.com/test.jpg",
7 "description": "nothing to desc",
8 "results": [
9 {
10 "source": "http://bj.bcebos.com/test2.jpg",
11 "description": "nothing to desc",
12 "distance": 0.12,
13 "frames": [
14 {
15 "distance": 0.12,
16 "timestamp": 3.4333
17 }
18 ]
19 }
20 ]
21}