文档

API概览

更新时间:
本产品(智能媒体管理/2017-09-06)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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。
  • 本页导读 (1)