本产品(
智能媒体管理/2017-09-06
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
服务操作
API | 标题 | API概述 |
---|---|---|
OpenImmService | 开通智能媒体管理服务 | 调用OpenImmService接口开通智能媒体管理服务。 |
项目操作
API | 标题 | API概述 |
---|---|---|
DeleteProject | 删除一个项目 | 调用DeleteProject接口删除一个项目。 |
UpdateProject | 更新项目的CU或服务角色信息 | 调用UpdateProject接口更新项目的CU或服务角色信息。 |
GetProject | 获取项目的信息 | 调用GetProject接口获取项目的信息。 |
ListProjects | 列出已创建的所有项目信息 | 调用ListProjects接口列出已创建的所有项目信息。 |
PutProject | 创建一个项目 | 目前支持创建文档标准型、图片标准型和视频标准型项目,请根据需要处理的内容类型创建相应项目。 |
媒体集管理
API | 标题 | API概述 |
---|---|---|
CreateSet | 创建媒体集 | 调用CreateSet接口创建媒体集。 |
DeleteSet | 删除媒体集 | 调用DeleteSet接口删除媒体集。 |
UpdateSet | 更新媒体集的显示名称 | 调用UpdateSet接口更新媒体集的显示名称。 |
GetSet | 获取媒体集信息 | 调用GetSet接口获取媒体集信息。 |
ListSets | 获取媒体集列表 | 调用ListSets接口获取媒体集列表。 |
文档管理
API | 标题 | API概述 |
---|---|---|
文档转换同步请求 | 文档转换同步请求 | |
ConvertOfficeFormat | 文档(例如OFFICE文档)格式的转换 | 采用同步请求方式进行文档(例如Office文档)格式的转换,执行完毕返回转换成功的页数。 |
文档转换异步请求 | 文档转换异步请求 | |
ListOfficeConversionTask | 列出项目中已创建的文档格式转换任务 | 调用ListOfficeConversionTask接口列出项目中已创建的文档格式转换任务。 |
GetOfficeConversionTask | 查询异步文档格式转换任务的状态信息 | 调用GetOfficeConversionTask接口查询异步文档格式转换任务的状态信息。 |
DeleteOfficeConversionTask | 删除异步文档格式转换任务 | 调用DeleteOfficeConversionTask接口删除异步文档格式转换任务。 |
CreateOfficeConversionTask | 创建单个文档的转换任务 | 采用异步请求方式进行文档(例如Office文档)格式的转换,执行完成后返回TaskId。 |
文档预览 | 文档预览 | |
RefreshWebofficeToken | 刷新Weboffice的访问凭证 | 调用RefreshWebofficeToken接口刷新Weboffice的访问凭证。 |
RefreshOfficePreviewToken | 刷新文档预览凭证 | 刷新文档预览凭证AccessToken。 |
GetWebofficeURL | 获取Weboffice的访问凭证 | 获取Weboffice的访问凭证。Weboffice提供文档的在线协作功能,包括预览、编辑、协作等。 |
GetOfficePreviewURL | 获取文档预览URL | 获取文档预览的URL和AccessToken。 |
图片管理
API | 标题 | API概述 |
---|---|---|
媒体集图片管理 | 媒体集图片管理 | |
GetImage | 从媒体集中获取一张图片的信息 | 调用GetImage接口从媒体集中获取一张图片的信息。 |
DeleteImage | 删除图片 | 删除媒体集中指定的图片。 |
FindImages | 搜索媒体集中图片 | 调用FindImages接口根据指定条件,例如时间、地点、标签、人物特征等,搜索媒体集中图片。并可以按照给定要求进行排序。 |
ListImages | 获取媒体集中的图片列表 | 获取媒体集中的图片列表,返回结果以图片加入媒体集的时间升序排序。 |
UpdateImage | 更新媒体集中用户自定义的图片信息 | 调用UpdateImage接口更新媒体集中用户自定义的图片信息。 |
IndexImage | 将图片加入媒体集 | 将图片加入媒体集,并进行AI检测。 |
媒体集人脸处理 | 媒体集人脸处理 | |
FindSimilarFaces | 查找和指定人脸相似的人脸 | 从媒体集中搜索与指定图片或人脸ID最相似的前N张图片,并返回相应人脸ID及边界框,返回结果按照相似度降序排列。 |
CompareImageFaces | 比较两个人脸的相似度 | 调用CompareImageFaces接口比较两个人脸的相似度。 |
人脸聚类 | 人脸聚类 | |
ListFaceGroups | 获取一个媒体集中的人脸分组列表 | 调用ListFaceGroups接口获取一个媒体集中的人脸分组列表。 |
UpdateFaceGroup | 更新媒体集中人脸分组 | 更新媒体集中人脸分组的名称、封面图、标签等信息。 |
CreateGroupFacesJob | 人脸聚类 | 按照人物将人脸分组。 |
CreateMergeFaceGroupsJob | 合并媒体集中的两个人脸分组 | 调用CreateMergeFaceGroupsJob接口合并媒体集中的两个人脸分组。 |
媒体集标签处理 | 媒体集标签处理 | |
ListSetTags | 统计媒体集内标签 | 获取媒体集中Top 100的标签信息列表,返回结果按标签出现次数降序排列。 |
图片分析 | 图片分析 | |
GetImageQuality | 获取图片综合质量分数 | 获取图片质量分数。 |
GetImageCroppingSuggestions | 获取图片裁剪建议(裁剪框位置) | 获取图片裁剪建议。 |
DetectQRCodes | 二维码检测 | 二维码检测,建议换用DetectImageQRCodes。 |
DetectImageQRCodes | 检测图片中二维码 | 检测图片中二维码的位置和内容。 |
DetectImageTags | 检测图片中的标签场景 | 检测图片中的标签信息。 |
人脸人体 | 人脸人体 | |
DetectImageFaces | 检测图片中的人脸及人脸信息 | 调用DetectImageFaces接口检测图片中的人脸及人脸信息。 |
DetectImageBodies | 检测图片中的人体 | 检测图片中的人体信息。 |
图片盲水印 | 图片盲水印 | |
EncodeBlindWatermark | 添加图片盲水印 | 在图片中不能直接看到该水印,但可以通过DecodeBlindWatermark恢复图中隐藏的水印。 |
DecodeBlindWatermark | 解析图片盲水印 | 解析由IMM添加的盲水印。 |
视频管理
API | 标题 | API概述 |
---|---|---|
GetMediaMeta | 获取多媒体文件信息 | 获取多媒体文件信息,如编码、码率、分辨率、流信息等。 |
媒体集视频处理 | 媒体集视频处理 | |
IndexVideo | 对视频进行自动截帧、分组、识别操作 | 调用IndexVideo接口将视频添加到媒体集中,并对视频进行自动截帧、分组、识别等操作。 |
ListVideos | 获取多个视频的信息 | 调用ListVideos接口获取媒体集中的视频信息列表,返回结果以视频加入媒体集的时间升序排序。 |
GetVideo | 获取一个视频的信息 | 调用GetVideo获取媒体集中一个视频的信息。 |
DeleteVideo | 删除一个视频的信息 | 调用DeleteVideo接口删除媒体集中的一个视频的信息。 |
视频异步任务 | 视频异步任务 | |
GetVideoTask | 查询视频类任务 | 调用GetVideoTask接口查询视频任务的执行状态和结果。 |
ListVideoTasks | 列出视频类异步任务 | 调用ListVideoTasks接口列出视频任务信息。 |
DeleteVideoTask | 删除视频异步任务 | 调用DeleteVideoTask接口删除一个视频任务。 |
CreateVideoCompressTask | 创建一个视频压缩存储的任务 | 调用CreateVideoCompressTask接口创建一个视频压缩存储任务,执行完成后返回TaskId。 |
CreateGrabFrameTask | 创建一个视频截帧任务 | 调用CreateGrabFrameTask接口创建一个视频截帧任务,执行完成后返回TaskId。 |