本产品(
智能媒体管理/2020-09-30
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
服务地域
API | 标题 | API概述 |
---|---|---|
ListRegions | 查询支持IMM服务的Region列表 | 查询支持IMM服务的Region列表信息,包括Region和对应语言的描述信息。 |
项目管理
API | 标题 | API概述 |
---|---|---|
CreateProject | 创建项目 | 创建一个项目。 |
UpdateProject | 更新项目 | 更新一个项目的信息。 |
GetProject | 获取项目信息 | 查询指定项目(Project)的信息,包含基础信息,数据集(Dataset)和文件相关的统计信息等。 |
ListProjects | 列出所有项目信息的列表 | 列出所有项目信息的列表。 |
DeleteProject | 删除项目 | 删除一个项目。 |
元数据管理
API | 标题 | API概述 |
---|---|---|
数据集管理 | 数据集管理 | |
CreateDataset | 创建数据集 | 创建一个数据集。 |
UpdateDataset | 更新数据集 | 更新一个数据集的信息。 |
GetDataset | 查询数据集信息 | 查询一个数据集的信息。 |
ListDatasets | 列出数据集 | 获取数据集列表。 |
DeleteDataset | 删除数据集 | 删除一个数据集。 |
元数据索引 | 元数据索引 | |
IndexFileMeta | 索引文件元信息 | 索引文件元信息,对输入的文件进行数据处理如标签识别、人脸检测、地点检测等,并将文件元信息索引到数据集内,支持多样化的数据检索。 |
BatchIndexFileMeta | 批量索引文件元信息 | 批量索引文件元信息,对输入的文件进行数据处理如标签识别、人脸检测、地点检测等,并将文件元信息索引到数据集内,支持多样化的数据检索。 |
UpdateFileMeta | 更新文件元数据 | 更新文件元数据。 |
BatchUpdateFileMeta | 批量更新文件元信息 | 根据URI从数据集内批量更新文件的元信息。 |
GetFileMeta | 获取文件元数据 | 获取文件元数据。 |
BatchGetFileMeta | 批量获取文件元数据 | 批量获取文件元数据。 |
DeleteFileMeta | 删除文件元信息 | 根据URI从数据集内删除文件的元信息。 |
BatchDeleteFileMeta | 批量删除文件元信息 | 根据URI从数据集内批量删除文件的元信息。 |
查询与统计 | 查询与统计 | |
SimpleQuery | 简单查询 | 通过逻辑关系表达式,对数据集内的文件进行查询和统计。 |
SemanticQuery | 自然语言查询 | 通过输入自然语言关键字,对数据集内的元数据进行查询与统计分析。该接口目前支持的查询字段包括Labels,ProduceTime和AddressLine。 |
FuzzyQuery | 模糊查询 | 根据关键词,查询指定数据集中的文件,获取其元信息。 |
智能管理 | 智能管理 | |
人脸聚类 | 人脸聚类 | |
CreateFigureClusteringTask | 创建人物聚类任务 | 通过智能算法,将数据集内包含同一个人物的文件归为一类。 |
CreateFigureClustersMergingTask | 合并人物聚类 | 将两个或多个人物聚类合并为一个。 |
GetFigureCluster | 获取人物聚类信息 | 查询一个人物聚类的信息。 |
QueryFigureClusters | 查询人物聚类 | 根据条件查询人物聚类及其信息。 |
UpdateFigureCluster | 更新人物聚类 | 更新一个人物聚类的信息。 |
SearchImageFigureCluster | 图片人物聚类搜索 | 搜索图片中人物所在的人物聚类,返回其信息。 |
CreateFacesSearchingTask | 图片人脸搜索 | 从媒体集中搜索与指定图片或人脸ID最相似的前N张图片,并返回相应人脸ID及边界框,返回结果按照相似度降序排列。 |
时空聚类 | 时空聚类 | |
CreateLocationDateClusteringTask | 创建时空聚类任务 | 创建时空聚类任务。 |
QueryLocationDateClusters | 查询时空聚类 | 根据特定条件,查询时空聚类及其信息。 |
UpdateLocationDateCluster | 更新时空聚类 | 更新一个时空聚类的信息。 |
DeleteLocationDateCluster | 删除时空聚类分组 | 删除一个时空聚类。 |
故事 | 故事 | |
CreateStory | 创建故事 | 创建一个故事。 |
QueryStories | 查询故事 | 根据条件查询故事及其信息。 |
GetStory | 获取故事信息 | 获取一个故事的信息。 |
CreateCustomizedStory | 创建自定义故事 | 使用选择的图片和视频创建一个故事。 |
UpdateStory | 更新故事 | 更新故事信息,例如重命名,修改封面等。 |
AddStoryFiles | 添加故事文件 | 向故事中添加文件。 |
RemoveStoryFiles | 从故事中删除文件 | 从故事中删除文件。 |
DeleteStory | 删除故事 | 删除故事。 |
数据绑定 | 数据绑定 | |
CreateBinding | 创建绑定任务 | 创建数据集和OSS Bucket的绑定关系,自动为其中的文件添加索引。 |
GetBinding | 查询绑定信息 | 获取数据集和OSS Bucket绑定关系详情。 |
ListBindings | 列出绑定任务列表 | 获取数据集和OSS Bucket绑定关系列表。 |
DeleteBinding | 删除绑定任务 | 删除数据集和OSS Bucket绑定任务。 |
AttachOSSBucket | 绑定对象存储 | 创建项目与OSS Bucket的绑定关系。 |
DetachOSSBucket | 解绑对象存储 | 解除项目与OSS Bucket的绑定关系。 |
GetOSSBucketAttachment | 获取对象存储绑定信息 | 获取同一地域下与指定OSS Bucket绑定的项目的项目名称。 |
图片处理
API | 标题 | API概述 |
---|---|---|
DetectImageLabels | 检测图片中的标签信息 | 检测图片中的标签信息。 |
DetectImageScore | 获取图片分数 | 获取图片分数。 |
DetectImageCodes | 图片二维码检测 | 检测图片中的二维码。 |
DetectImageFaces | 通过AI模型能力检测图片中的人脸以及人脸信息 | 通过AI模型能力检测图片中的人脸以及人脸信息,包括年龄、性别等。 |
DetectImageCropping | 通过AI模型能力在给定的目标图片比例下检测出视觉效果较好的裁剪框区域 | 通过AI模型能力在给定的目标图片比例下检测出视觉效果较好的裁剪框区域。 |
AddImageMosaic | 添加图片马赛克 | 对一张图片的特定区域进行马赛克、高斯模糊或纯色块填充操作,用于隐私保护。 |
CreateImageToPDFTask | 创建图片转PDF任务 | 将多张图片转换为单个PDF文件。 |
CreateImageSplicingTask | 创建图片拼接任务 | 将多张图片拼接成一张图片。 |
CompareImageFaces | 图片人脸比对 | 比较两张图片中人脸的相似度。 |
DetectImageBodies | 检测图片中的人体 | 人体检测算子。 |
媒体处理
API | 标题 | API概述 |
---|---|---|
CreateMediaConvertTask | 创建媒体转码任务 | 对音视频等文件进行转码。 |
DetectMediaMeta | 获取媒体文件元信息 | 获取媒体文件元信息,包括媒体格式信息和媒体流信息。 |
CreateVideoLabelClassificationTask | 创建视频标签检测任务 | 检测视频中的内容所对应的标签信息。 |
GetVideoLabelClassificationResult | 获取视频标签检测任务 | 获取视频标签检测任务的结果。 |
文档处理
API | 标题 | API概述 |
---|---|---|
GenerateWebofficeToken | 获取Weboffice凭证 | 获取文档预览和编辑的凭证。 |
RefreshWebofficeToken | 刷新Weboffice凭证 | 刷新文档预览和编辑的凭证。 |
CreateOfficeConversionTask | 创建文档转换任务 | 对文档进行格式转换。 |
文件处理
API | 标题 | API概述 |
---|---|---|
压缩解压 | 压缩解压 | |
CreateFileCompressionTask | 创建文件压缩任务 | 将多个文件压缩并打包为一个文件。 |
CreateArchiveFileInspectionTask | 创建压缩包解析任务 | 分析读取压缩包内的文件列表。 |
CreateFileUncompressionTask | 创建解压缩任务 | 将压缩包解压缩到特定位置。 |
点云压缩 | 点云压缩 | |
CreateCompressPointCloudTask | 创建点云压缩任务 | 将点云文件进行压缩。 |
内容安全
API | 标题 | API概述 |
---|---|---|
DetectTextAnomaly | 文本合规检测 | 检测文本内容是否合规。 |
CreateImageModerationTask | 创建图片合规检测任务 | 检测图片内容是否合规。 |
CreateVideoModerationTask | 创建视频合规检测任务 | 检测视频内容是否合规。 |
任务管理
API | 标题 | API概述 |
---|---|---|
GetTask | 获取任务信息 | 查询一个任务的信息。 |
ListTasks | 列出任务 | 获取任务列表。 |
触发器 | 触发器 | |
CreateTrigger | 创建触发器 | 创建触发器任务,可通过OSS等事件源触发IMM动作,用户可选择相应的数据处理模板,对图片、视频、文档等媒体执行相应的处理。 |
SuspendTrigger | 暂停触发器 | 暂停触发器。 |
ResumeTrigger | 恢复触发器 | 恢复触发器。 |
UpdateTrigger | 更新触发器 | 更新触发器。 |
GetTrigger | 获取触发器信息 | 获取触发器信息。 |
ListTriggers | 列出触发器 | 列出触发器。 |
DeleteTrigger | 删除触发器 | 删除触发器。 |
批处理 | 批处理 | |
CreateBatch | 创建批处理任务 | 创建一个批处理任务,指定存储内已存在的若干文件,对其批量执行指定操作,如转码、格式转换等。 |
SuspendBatch | 暂停批处理任务 | 暂停批处理任务。 |
ResumeBatch | 恢复批处理任务 | 恢复批处理任务。 |
UpdateBatch | 更新批处理任务 | 更新批处理任务。 |
ListBatches | 列出批处理任务 | 列出批处理任务。 |
GetBatch | 获取批处理任务信息 | 获取批处理任务信息。 |
DeleteBatch | 删除批处理任务 | 删除批处理任务。 |
其他
API | 标题 | API概述 |
---|---|---|
ResumeBinding | 继续绑定任务 | 绑定关系暂停后,重新建立数据集和OSS Bucket的绑定关系。绑定关系重新建立后,智能媒体管理会使用暂停绑定关系前的扫描类型来扫描Bucket中的文件,并为文件建立元数据索引。 |
StopBinding | StopBinding | 暂停数据集和OSS Bucket的绑定关系。绑定关系暂停后,智能媒体管理会停止扫描Bucket中的文件且不会为Bucket中新增的文件建立元数据索引。 |
CreateDetectVideoLabelsTask | 检测视频中的内容 | 检测视频中的内容。 |
GetDRMLicense | 获取DRML证书 | 获取加密视频播放的DRM证书。 |
GetVideoPlaylist | GetVideoPlaylist | |
LiveTranscoding | 边转边播转码 | 执行边转边播对应的转码任务,一般无需调用 |
CreateSimilarImageClusteringTask | 创建相似图片聚类任务 | 将数据集内的图片根据相似度进行分类,用于相似图片(如连拍)去重、选优等场景。 |
QuerySimilarImageClusters | 查询相似图片聚类 | 查询相似图片分类的结果。 |
GenerateDRMLicense | 获取DRM许可证 | 获取DRM许可证 |
GenerateVideoPlaylist | 生成边转边播文件 | 生成一个用于边转边播的M3U8文件。用户可以使用播放器播放该文件,在播放过程中实时按需进行转码。 |