API概览

更新时间:
复制为 MD 格式

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

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

API目录

API

标题

API概述

TextModerationPlus 文本审核Plus 文本审核增强版升级PLUS服务,面向大语言模型的输入指令和生成文字分别提供审核服务,特定的模型输入指令支持检索标准回答,同时开放审核标签的开启和关闭功能。
TextModeration 文本审核增强版 采用动态策略和模型强化变异对抗性,提供多种业务场景的审核服务,识别出多种违规风险。
ImageModeration 图片审核增强版 图片审核
ImageAsyncModeration 图片异步检测 图片异步检测接口,异步检测任务不会实时返回检测结果,您需要通过callback或者轮询的方式获取检测结果。检测结果最长保留3天。
DescribeImageModerationResult 查询图片异步检测结果 获取图片审核增强版审核任务结果。
VoiceModeration 语音审核增强版任务提交 提交语音审核增强版检测任务。
VoiceModerationResult 查询语音审核结果 语音审核增强版检测结果获取接口。
VoiceModerationCancel 取消语音流审核任务 语音审核增强版取消任务接口。
VideoModeration 视频审核增强版任务提交 内容安全视频审核增强版,帮助您检测视频文件中的风险或违规内容。本接口为检测任务提交接口。
VideoModerationResult 查询视频审核任务结果 获取视频审核增强版审核任务结果。
VideoModerationCancel 取消视频直播审核任务 取消视频直播审核任务。
FileModeration 文档检测任务提交 文档检测
DescribeFileModerationResult 查询文档检测结果 文档审核结果

其他

API

标题

API概述

DescribeImageResultExt 图片辅助信息获取接口 图片审核增强版辅助信息API用于获取图片审核增强版API接口识别的更多辅助信息,包含图片文字识别结果、自定义图库命中信息等。
UrlAsyncModeration URL风险异步检测 URL异步检测服务,识别URL链接是否存在欺诈、色情、赌博等风险,守护平台内容生态。
DescribeUrlModerationResult 查询URL异步检测结果 根据 URL 异步检测返回的 ReqId查询检测结果。
DescribeUploadToken 查询上传token 查询上传token
ImageBatchModeration 图片多Service同步检测 图片批量调用
ManualCallback 人审渠道回调接口 内容安全人审结果渠道回调接口
ManualModeration 内容安全人审提交任务 内容安全人审提交请求接口
ManualModerationResult 内容安全人审结果获取接口 获取人审结果
DescribeMultimodalModerationResult 查询异步多模态检测结果 查询异步多模态检测结果
MultiModalAgent 内容审核Agent 多模态AgentAPI同步检测接口
MultiModalGuard AI安全护栏多模态同步检测接口 AI安全护栏多模态同步检测接口,包括内容合规检测、敏感内容检测、提示词攻击检测、恶意文件检测、恶意URL检测等全方位检测能力。
MultimodalAsyncModeration 多模态异步检测 多模态-异步检测