API概览 - 智能媒体管理

本产品（智能媒体管理/2020-09-30）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

服务地域

API	标题	API概述
ListRegions	查询支持IMM服务的Region列表	查询支持IMM服务的Region列表信息，包括Region和对应语言的描述信息。

项目管理

API	标题	API概述
CreateProject	创建项目	创建一个项目（Project）。
UpdateProject	更新项目	更新一个已创建项目（Project）的信息。
GetProject	查询项目信息	查询指定项目（Project）的信息，包含基础信息，数据集（Dataset）和文件相关的统计信息等。
ListProjects	查询所有项目信息	查询所有项目（Project）的信息，包含基础信息，数据集（Dataset）和文件相关的统计信息等。
DeleteProject	删除项目	删除指定项目（Project）。

元数据管理

API	标题	API概述
数据集管理	数据集管理
CreateDataset	创建数据集	创建一个数据集（Dataset）。
UpdateDataset	更新数据集	更新一个数据集（Dataset）的信息。
GetDataset	查询数据集信息	查询一个数据集的信息。
ListDatasets	列出数据集	获取数据集列表，支持通过数据集名称前缀查询列表。
DeleteDataset	删除数据集	删除一个数据集（Dataset）。
元数据索引	元数据索引
IndexFileMeta	文件元信息建立索引	对输入的文件进行数据处理如标签识别、人脸检测、地点检测等，将提取的文件元信息建立索引，支持用户在一个数据集内多样化的数据检索。
BatchIndexFileMeta	批量文件元信息建立索引	批量索引文件元信息，对输入的文件进行数据处理如标签识别、人脸检测、地点检测等，并将文件元信息索引到数据集内，支持多样化的数据检索。
UpdateFileMeta	更新文件元数据	更新数据集内已索引的文件的部分元数据。
BatchUpdateFileMeta	批量更新文件元信息	更新批量数据集内已索引的文件的部分元数据。
GetFileMeta	获取文件元数据	获取数据集内已完成索引的文件的元数据。
BatchGetFileMeta	批量获取文件元数据	批量获取数据集内已完成索引的文件的元数据。
DeleteFileMeta	删除文件元信息	从数据集内删除文件的元信息。
BatchDeleteFileMeta	批量删除文件元信息	批量从数据集内删除文件的元信息。
查询与统计	查询与统计
SimpleQuery	简单查询	查询和统计数据集内文件，支持逻辑关系表达方式。
SemanticQuery	自然语言查询	通过输入自然语言，对数据集内的元数据进行基于语义的查询搜索。
FuzzyQuery	模糊查询	查询所有已提取的文件元数据（包含文件名、标签、路径、自定义标签、文本等字段），只要文件元数据中有一个字段的值匹配指定字符串，该文件的元数据就会被返回。
智能管理	智能管理
人脸聚类	人脸聚类
CreateFigureClusteringTask	创建人物人脸聚类任务	创建一个人物人脸聚类任务，通过智能算法，可以在您已索引到数据集的图片中，将属于不同人物的人脸进行聚类分组。
CreateFigureClustersMergingTask	合并人物聚类	将两个或两个以上人物聚类分组合并为一个人物聚类分组。
GetFigureCluster	获取人物人脸的聚类信息	获取人脸分组的基本信息，包括创建时间、照片数量、分组封面等信息。
QueryFigureClusters	查询人物聚类	根据条件查询人物聚类及其信息。
BatchGetFigureCluster	批量获取人脸聚类	批量获取人物聚类及其信息。
UpdateFigureCluster	更新人物聚类	更新一个人脸聚类分组的信息，可以更新分组的名称、标签等信息。
SearchImageFigureCluster	查询图片人脸所属聚类	查询指定图片中所有人脸所在的人物聚类列表，每个人物聚类中包含人脸框，相似度等信息。
CreateFacesSearchingTask	创建相似人脸图片检索任务	从媒体集中搜索与指定图片或人脸ID最相似的前N张图片，并返回相应人脸ID及边界框，返回结果按照相似度降序排列。
时空聚类	时空聚类
CreateLocationDateClusteringTask	创建时空聚类任务	时空聚类功能，可以将您已索引到数据集内的图片、视频等携带了拍摄时间、拍摄地点信息等文件，按照时间、地理位置进行分类。这些分类可以理解为用户的一次旅行所拍摄的内容（它们时间接近、地点接近），也可以理解为用户在不同生活、工作地的拍摄内容。通过获取、分析这些分类所在地点、所经历的时间范围，可以为用户提供媒体文件归类、精选、生成照片视频故事等能力。
QueryLocationDateClusters	查询时空聚类	查询时空聚类列表信息，支持多种条件，详情请参考请求参数。
UpdateLocationDateCluster	更新时空聚类	更新一个时空聚类的信息。
DeleteLocationDateCluster	删除时空聚类分组	删除一个时空聚类。
故事	故事
CreateStory	创建故事	创建一个故事。
QueryStories	查询故事	根据条件查询故事及其信息。
GetStory	获取故事信息	获取一个故事的信息。
CreateCustomizedStory	创建自定义故事	使用选择的图片和视频创建一个故事。
UpdateStory	更新故事	更新故事信息，例如重命名，修改封面等。
AddStoryFiles	添加故事文件	向故事中添加文件。
RemoveStoryFiles	从故事中删除文件	从故事中删除文件。
DeleteStory	删除故事	删除故事。
图片聚类	图片聚类
CreateSimilarImageClusteringTask	创建相似图片聚类任务	相似图片聚类功能，可以将您已索引到数据集内的图片按照相似度生成聚类，用于图片去重、选优等场景，例如可以通过该功能筛选相册中连拍的图片。
QuerySimilarImageClusters	查询相似图片聚类	查询相似图片聚类列表信息。
数据绑定	数据绑定
CreateBinding	创建绑定任务	创建数据集（Dataset）和对象存储（OSS）Bucket的绑定关系，自动同步全量和增量文件并为其索引。
GetBinding	查询绑定关系信息	查询指定的数据集和对象存储（OSS）Bucket绑定关系详情。
ListBindings	查询绑定关系列表	查询数据集和对象存储（OSS）Bucket绑定关系列表。
DeleteBinding	删除绑定任务	删除数据集和对象存储（OSS）Bucket绑定任务。
AttachOSSBucket	绑定对象存储桶	将OSS Bucket与IMM Project绑定，可以通过OSS x-oss-process方式使用IMM的数据处理能力。
DetachOSSBucket	解绑对象存储桶	解除项目与OSS Bucket的绑定关系。
GetOSSBucketAttachment	获取对象存储桶绑定信息	获取同一地域下与指定OSS Bucket绑定的项目的项目名称。

图片处理

API	标题	API概述
EncodeBlindWatermark	添加图片盲水印	将特定的文本信息嵌入到图片中，而这些信息在视觉观察下是不可见的。由于这些水印在视觉上是隐蔽的，它们不会影响图片的美观性或原始信息的传递，但可以通过 CreateDecodeBlindWatermarkTask 接口提取出来。
CreateDecodeBlindWatermarkTask	创建解析盲水印任务	提取盲水印。
GetDecodeBlindWatermarkResult	获取解析盲水印任务结果	获取解析图片盲水印任务的结果。
DetectImageLabels	检测图片中的标签信息	检测图片中的场景、物体和事件标签信息。场景信息包括：自然景观、生活场景、灾难场景等大类；事件信息包括：才艺、办公、表演、生产等大类；物体信息包括：餐具、电子产品、家具、交通工具等大类。图片标签检测目前支持的标签种类包含三十多个分类、数千个标签。
DetectImageScore	获取图片分数	以主观美学为准评估图片的视觉质量，同时考虑构图、亮度、对比度、色彩、清晰度等多方面因素的影响。该功能返回一个范围为0-1的图片质量得分，得分越高则表示图片的视觉质量越高。
DetectImageCodes	图片二维码检测	识别指定图像中的条码和二维码。
DetectImageFaces	通过AI模型能力检测图片中的人脸以及人脸信息	检测指定图像中的人脸边界信息、属性信息、质量信息。边界信息（Boundary）包括：顶点Y坐标距离顶端距离（Top）、顶点X坐标距离左端距离（Left）、高度（Height）、宽度（Width）；属性信息包括：年龄（Age）、年龄标准差（AgeSD）、性别（Gender）、心情（Emotion）、是否张口（Mouth）、是否有胡子（Beard）、是否有帽子（Hat）、是否带口罩（Mask）、是否戴眼镜（Glasses）、头部朝向（HeadPose）、人脸吸引力（Attractive）及上述各属性的置信度；质量信息包括：人脸质量分（FaceQuality）、人脸清晰度（Sharpness）。
DetectImageCropping	通过AI模型能力在给定的目标图片比例下检测出视觉效果较好的裁剪框区域	通过AI模型能力在给定的目标图片比例下检测出视觉效果较好的裁剪框区域。
AddImageMosaic	添加图片马赛克	在一张图片的一个或多个特定区域内添加多种形状的马赛克、高斯模糊或纯色块，并将填充后的图片保存到指定的OSS文件对象地址。该功能主要用于隐私保护。
CreateImageToPDFTask	创建图片转PDF任务	将多张图片转换为单个PDF文件，并保存到指定的OSS文件对象地址。
CreateImageSplicingTask	创建图片拼接任务	将多张图片按设定的规则拼接成一张图片，并保存到指定的OSS文件对象地址。
CompareImageFaces	图片人脸相似度比对	比较两张图片中最大的人脸的相似度。最大的人脸指的是图片经人脸检测后，所有人脸框中面积最大的。
DetectImageBodies	检测图片中的人体	检测图片中的人体信息，包含置信度，人体边框等信息。
DetectImageCars	检测图片中的车辆信息	检测指定图像中的车辆边界信息、车辆属性信息、车牌信息。车辆属性信息包括：车辆颜色（CarColor）、车辆类型（CarType）；车牌信息包括：车牌识别内容（Content）、车牌框信息（Boundary）。
DetectImageTexts	图片文本识别	图片文本识别，将图片上的文字内容智能识别成为可编辑的文本。

媒体处理

API	标题	API概述
CreateMediaConvertTask	创建媒体转码任务	创建一个异步的媒体转码任务，提供媒体转码、媒体拼接、视频截帧、视频转动图等相关音视频媒体文件处理能力。
DetectMediaMeta	获取媒体文件元信息	获取媒体文件元信息，包括媒体格式信息和媒体流信息。
CreateVideoLabelClassificationTask	创建视频标签检测任务	检测视频内容的场景、物体和事件标签信息。场景信息包括：自然景观、生活场景、灾难场景等大类；事件信息包括：才艺、办公、表演、生产等大类；物体信息包括：餐具、电子产品、家具、交通工具等大类。视频标签检测目前支持的标签种类包含三十多个分类、数千个标签。
GetVideoLabelClassificationResult	获取视频标签检测任务	获取视频标签检测任务的结果。
GenerateVideoPlaylist	生成边转边播播放列表	创建边转边播播放列表能够将视频文件生成m3u8文件。生成播放列表后即时播放，并根据播放进度实施按需转码，相比离线转码能极大减少了转码等待时间并大幅度降低了转码和存储开销。

文档处理

API	标题	API概述
GenerateWebofficeToken	获取Weboffice凭证	获取文档预览编辑凭证。
RefreshWebofficeToken	刷新Weboffice凭证	刷新Weboffice访问凭证。Weboffice访问凭证有效期是30分钟，过期会失效，无法继续访问Weboffice。如果要继续访问Weboffice，可以使用这个接口刷新Weboffice访问凭证，即获取一个新的凭证，新的凭证过期时间也是30分钟。
CreateOfficeConversionTask	创建文档转换任务	创建文档转换任务。支持文档格式转换，将存储在对象存储中的文档（Word、PPT、Excel、PDF）转成图片，文本，或者PDF。
ExtractDocumentText	文档正文提取	提取文档文件正文中的文本。

文件处理

API	标题	API概述
压缩解压	压缩解压
CreateFileCompressionTask	创建文件压缩任务	打包下载API。
CreateArchiveFileInspectionTask	创建压缩包预览解析任务	创建压缩包预览解析任务支持获取压缩包内的文件列表信息。该功能无需解压压缩包，就可以获取压缩包内的文件列表信息。
CreateFileUncompressionTask	创建解压缩任务	创建解压缩任务可以将您压缩包内的指定文件解压缩到特定位置，也可以将压缩包完整解压。目前支持的压缩格式包括Zip、RAR和7z。
点云压缩	点云压缩
CreateCompressPointCloudTask	创建点云压缩任务	点云压缩功能可以将OSS中的点云数据进行压缩处理，减少网络数据传输。

内容安全

API	标题	API概述
DetectTextAnomaly	文本合规检测	检测指定文本内容中是否包含色情、广告、灌水、涉政、辱骂等违规信息。
CreateImageModerationTask	创建图片合规检测任务	检测图片内容是否合规。包括色情内容、暴恐涉政、不良场景、logo、图文违规这几种检测场景。
CreateVideoModerationTask	创建视频合规检测任务	检测视频中的风险或违规内容，具体包括以下场景：视频智能鉴黄、视频暴恐涉政、视频图文违规、视频不良场景、视频logo。
GetImageModerationResult	获取图片合规检测任务	获取图片合规检测任务。
GetVideoModerationResult	获取视频合规检测任务	获取视频合规检测任务。

任务管理

API	标题	API概述
GetTask	获取任务信息	该接口用于主动查询指定的异步任务信息。IMM支持多种异步数据处理能力，每种能力有各自创建任务的接口，例如创建人物人脸聚类任务CreateFigureClusteringTask、创建文件压缩任务CreateFileCompressionTask等。本接口为通用接口，可以通过任务ID和类型来查询异步任务的详细信息。
ListTasks	查询任务列表	该接口提供通过多种条件查询任务列表的功能。通过该接口可以查询指定时间范围内的任务、或者通过创建任务时指定的Tag搜索任务等。
触发器	触发器
CreateTrigger	创建触发器	创建触发器任务，可通过OSS等事件源触发IMM数据处理，支持选择多种数据处理模板，对图片、视频、文档等媒体文件执行相应的处理。
SuspendTrigger	暂停触发器	将一个 Running（正在执行）状态的触发器暂停。
ResumeTrigger	恢复触发器	将一个Suspended（暂停）或Failed（失败）状态的触发器恢复。
UpdateTrigger	更新触发器	更新触发器信息，如输入的数据源配置、数据处理的配置、触发器标签等信息。
GetTrigger	获取触发器信息	获取触发器信息。
ListTriggers	查询触发器列表	查询触发器任务列表，支持排序，支持按照任务标签，任务状态等条件查询。
DeleteTrigger	删除触发器	删除指定的触发器。
批处理	批处理
CreateBatch	创建批处理任务	创建一个批处理任务，指定存储内已存在的若干文件，对其批量执行指定操作，如转码、格式转换等。
SuspendBatch	暂停批处理任务	将一个 Running（正在执行）的批处理任务暂停。
ResumeBatch	恢复批处理任务	将一个Suspend（暂停）或Failed（失败）的批处理任务恢复。
UpdateBatch	更新批处理任务	更新批处理任务信息，如输入的数据源配置、数据处理的配置、批处理任务标签等信息。
ListBatches	查询批处理任务列表	查询批处理任务列表，支持排序，支持按照任务标签，任务状态等条件查询。
GetBatch	获取批处理任务信息	获取批处理任务信息。
DeleteBatch	删除批处理任务	删除指定的一个批处理任务。