智能搜索API
功能概述
CleverSee AI搜问平台提供的搜索API接口,支持通过平台搭建搜索应用后,通过应用对应的API调用搜索接口,实现对数据集中图片、文档及音视频内容的精准检索。平台支持文本(自然语言)、图片或图文结合的输入,可快速适配多模态的大规模数据搜索场景,帮助用户高效定位目标内容。
接口说明
当前接口支持CleverSee AI 搜问平台上两类搜索应用的调用,包括图片搜索应用内的文(自然语言)搜图、图搜图、图文混合搜图,以及音视频搜索应用内的文搜音视频、图搜视频、图文混合搜视频。
数据源:
支持音频、视频数据,可通过CleverSee AI 搜问平台的产品界面内或通过数据集数据新增/更新 API完成数据上传及更新。
认证方式
通过 阿里云 SDK 调用 CleverSee - 智能搜索 服务,具体调用指南请参考:AI搜索引擎接口
请求参数
请求参数表
参数名 | 类型 | 必填 | 说明 | 示例值 | |
appId | String | 是 | 应用唯一标识 ID |
| |
query | Object | 是 | 查询条件对象 | (见下级字段) | |
├─ | texts | Array[String] | 否 | 文本查询列表。 |
|
├─ | imageUrl | Array[String] | 否 | 图片查询列表。 • 当前仅支持传入 1 个 图片 URL,单张图大小上限为 10MB;格式支持 JPG/PNG/WEBP/JPEG |
|
├─ | pageSize | Integer | 是 | 每页返回的结果数量 |
|
├─ | pageNo | Integer | 否 | 页码,从 1 开始。 • 默认值: |
|
└─ | excludeIds | Array[String] | 否 | 需要排除的主键 ID 列表。 • 用途: 过滤已浏览过的历史记录 |
|
user | Object | 否 | 用户信息对象(用于后续用户视角分析) | (见下级字段) | |
└─ | userId | String | 否 | 用户唯一标识 ID |
|
请求示例
正常请求示例
JSON格式
curl -X POST 'https://pre-ai-search-engine.aliyun-inc.com/api/v1/engine/search' \
-H 'Content-Type: application/json' \
-H 'X-Acs-Account-Id: 1754376654452940' \
-d '{
"appId": "2048962366415007746",
"query": {
"texts": ["小女孩"],
"imageUrls": ["https://你的图片url"],
"pageSize": 10,
"pageNo": 1,
"excludeIds": []
},
"user": {
"userId": "asdfgnoevnor"
}
}'返回参数
3.1 顶层结构表
参数名 | 类型 | 说明 | 示例值 | |
code | Integer | 状态码,200 表示成功 |
| |
message | String | 响应消息 |
| |
requestId | String | 全局请求 ID,用于排查问题 |
| |
data | Object | 业务数据主体 | (见下级) | |
├─ | size | Integer | 当前页返回数量 |
|
├─ | page | Integer | 搜索分页 |
|
├─ | total | Integer | 总记录数 |
|
├─ | traceInfo | Null | 链路追踪信息 |
|
└─ | extra | Object | 额外元数据 说明 会有 exclude_ids 字段,用于表达实际被排除的 ID 列表,对应格式为
| {exclude_ids: ["id_1", "id_2"]} |
items | Array[Object] | 搜索结果列表(详细结构见下文) | (见 3.2) | |
status | String | 业务状态字符串 |
| |
errorMessage | Null | 错误信息,成功时为 null |
|
3.2 items 元素结构详解
items 数组中的每个对象代表一条搜索结果。根据媒体类型(图片、视频、音频),content 字段内的具体属性会有所不同。以下为通用结构及视频/音频特有字段:
图片搜索items
参数名 | 类型 | 说明 | 示例值 | |
score | Float | 相关性得分 |
| |
content | Object | 内容详情对象 | (见下级) | |
├─ | image_url | String | 图片 URL • 带签名,时效性为数据集创建内24小时 |
|
├─ | s_name | String | 原始文件名 |
|
├─ | pk_id | String | 原始资源的主键 ID |
|
└─ | s_dataset_id | String | 所属数据集 ID |
|
音视频搜索items
参数名 | 类型 | 说明 | 示例值 | |
score | Float | 相关性得分 |
| |
content | Object | 内容详情对象 | (见下级) | |
├─ | s_raw_cover_pic | String | 完整视频封面图 URL。 • 带签名,时效性为数据集创建内24小时 • 音频/纯文本结果为 |
|
├─ | s_segment_cover_pic | String | 视频片段封面图 URL。 • 带签名,时效性为数据集创建内24小时 • 音频/纯文本结果为 |
|
├─ | s_raw_file_path | String | 媒体文件 URL。 • 带签名,时效性为数据集创建内24小时 • 支持 mp4, mp3, jpg 等 |
|
├─ | s_name | String | 原始文件名 |
|
├─ | pk_id | String | 原始资源的主键 ID |
|
├─ | s_dataset_id | String | 所属数据集 ID |
|
├─ | s_segment_start_millisecond | Integer | 片段起始时间(毫秒) • 非视频/音频片段可能为 0 |
|
├─ | s_segment_end_millisecond | Integer | 片段结束时间(毫秒) • 非视频/音频片段可能为 0 |
|
├─ | s_raw_length | Integer | 文件时长 |
|
├─ | s_video_type | String | 视频类型标签 • 视频类别,是AI理解的视频级标签,值类型可枚举,为以下值其中之一:
|
|
├─ | s_video_topic | String | 视频主题标签 • 视频的核心话题,是AI理解的视频级标签,值类型不可枚举 |
|
├─ | s_global_summary | String | 全局摘要标签 • 视频内容的核心总结,是AI理解的视频级标签,值类型不可枚举 |
|
└─ | s_global_keywords | String | 全局关键词标签 • 概括视频内容的2-4个关键词,是AI理解的视频级标签,值类型不可枚举 |
|
返回示例
正常图片搜索返回示例
JSON格式
{
"code": 200,
"message": "success",
"data": {
"size": 1,
"page": 1,
"total": 1,
"traceInfo": null,
"extra": {
"exclude_ids": ["3f95b343xxxxxxxxxxxx"]
},
"items": [
{
"id": "3f95b343xxxxxxxxxxxx",
"score": 0.8029279573006508,
"content": {
"s_name": "sample_image.png",
"image_url": "https://.../image.png?Expires=...",
"pk_id": "3f95b343xxxxxxxxxxxx",
"s_dataset_id": "594"
},
"algorithm": {},
"traceInfo": null
}
],
"status": "200",
"errorMessage": null
},
"requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}正常视频搜索返回示例
JSON格式
{
"code": 200,
"data": {
"total": 1,
"size": 1,
"traceInfo": null,
"extra": {
"exclude_ids": ["01XXXXXXXXXXXXXXX"]
},
"errorMessage": null,
"page": 1,
"items": [{
"score": 0.577594,
"traceInfo": null,
"id": "01XXXXXXXXXXXXXXX",
"content": {
"s_raw_file_path": "https://.../video.mp4?Expires=...",
"s_raw_length": 1036122,
"pk_id": "01XXXXXXXXXXXXXXX",
"s_global_summary": "视频前半段围绕人物之间的冲突与协作展开,通过多段剧情推进呈现复杂关系与情绪变化,包含追逐、对话、调查等情节;后半段切换为舞台表演内容,展示歌手在大型活动中的现场演唱与观众互动,整体内容兼具剧情叙事与音乐演出元素。",
"s_raw_cover_pic": "https://.../frame_1.jpg?Expires=...",
"s_name": "demo_video.mp4",
"s_dataset_id": "833",
"s_global_keywords": "剧情互动,人物关系,调查追逐,音乐表演,舞台演唱",
"s_video_topic": "剧情内容与音乐演出",
"s_video_type": "影视综艺"
},
"algorithm": {}
}],
"status": "200"
},
"requestId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"message": "success"
}错误码
HTTP状态码 | 错误码(枚举名) | 错误 Message(英文) | 中文说明 |
500 |
|
| 系统内部错误 |
403 |
|
| 权限不足,无法访问该应用 |
400 |
|
| 参数错误 |
404 |
|
| 应用不存在 |
407 |
|
| 应用访问越权(权限提升异常) |
405 |
|
| 输入文本过长 |
406 |
|
| 图片数量超过限制 |
搜索结果中多媒体资源(图片)
如需获取数据集内数据url链接并进行下载,请参考搜索结果中多媒体资源(图片、视频)URL获取预签名 API