API概览-AI 安全护栏(AI Guardrails)-阿里云帮助中心

API标准及多语言预置SDK

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

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

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

公共

API	标题	API概述
GetGroups	获取分组列表	获取一个账号下的所有个体分组信息。
UploadCredentials	生成上传凭证	文件上传前需要生成上传凭证。

人脸

API	标题	API概述
AddFaces	新增个体对应人脸图片	向个体中增加人脸图片，用于检索，需要提前创建个体。
DeleteFaces	删除人脸图片	从一个个体库中删除一张或者多张指定个体对应的人脸图片。
DetectFace	人脸检测定位	检测一个指定人脸图像的属性内容（比如是否微笑、是否戴眼镜）。

图像

API	标题	API概述
ListSimilarityImages	列举图像	查询指定图库下的所有图片样本及其元信息。
ImageAsyncScan	异步图片风险检测	对图片进行多个风险场景的识别，包括色情、暴恐敏感、文字、人脸、广告、二维码识别。
ImageAsyncScanResults	获取异步图片检测结果	获取异步图片检测结果。
ImageSyncScan	图像同步风险检测	检测图片中是否包含风险内容。
ImageAsyncManualScan	图片人工审核	提交图像人工审核请求。
ImageAsyncManualScanResults	获取图片人工审核结果	获取图片人工审核结果。
ImageScanFeedback	图像扫描反馈	反馈机器识别不准确的图像。

相似图

API	标题	API概述
AddSimilarityImage	增加相似图样本	向一个图库中添加一张或者多张图像用于检索。
AddSimilarityLibrary	新增一个相似图样本图库	一个账号（uid）下可以创建一个或者多个相似图库，用于检索图像。
DeleteSimilarityImage	移除相似图样本	删除相似图库中的一张或者多张图片。
DeleteSimilarityLibrary	删除指定的相似图库	删除一个账号下的一个或者多个相似图库。
GetSimilarityImage	获取相似图信息	查询指定相似图库中样本图片的元信息。
GetSimilarityLibrary	查询指定图库的信息	查询一个账号下的所有图库信息。
ListSimilarityLibraries	获取相似图库	查询一个账号下所有相似图库及其元信息。

视频

API	标题	API概述
VideoAsyncScan	视频文件风险异步检测	提交视频文件异步风险检测请求。
VideoAsyncScanResults	查询视频风险异步检测任务结果	获取视频文件的人工审核结果，结果以json形式返回。
VideoCancelScan	停止视频检测	停止视频风险检测。
VideoFeedback	视频检测结果反馈	反馈机器识别不准确的视频信息。
VideoSyncScan	视频异步检测	检测视频中是否含有风险内容。
VideoAsyncManualScan	视频异步人工审核	提交异步视频文件人工审核请求。
VideoAsyncManualScanResults	获取异步人工审核结果	获取视频文件的人工审核结果，结果以json形式返回。

直播流

API	标题	API概述
LiveStreamAsyncScan	直播流异步扫描	提交直播流异步检测请求，检测直播中的风险内容。
LiveStreamAsyncScanResults	直播流异步扫描结果	获取直播流异步检测结果。
LiveStreamCancelScan	取消直播流扫描	取消正在检测的直播流任务。

视频点播

API	标题	API概述
VodAsyncScan	点播视频异步扫描	检测点播视频中是否含有风险内容。
VodAsyncScanResults	获取点播视频异步扫描结果	获取点播视频异步扫描结果。

音频

API	标题	API概述
VoiceAsyncScan	提交语音异步检测任务	提交语音异步检测任务，检测语音文件或者语音流中的风险。
VoiceAsyncScanResults	查询语音异步检测结果	查询语音流或语音文件的检测结果。
VoiceCancelScan	取消语音检测任务	取消已经提交并正在检测中的语音检测任务。
VoiceSyncScan	短语音同步检测	检测实时语音流或语音文件中的垃圾内容。
VoiceAsyncManualScan	提交语音人工审核	提交语音文件到内容安全服务进行人工审核，结果需要异步获取。
VoiceAsyncManualScanResults	查询语音人工审核结果	查询语音人工审核的结果，结果以json格式返回。

文本

API	标题	API概述
TextAsyncManualScan	文本人工审核	提交文本异步人工审核请求。
TextAsyncManualScanResults	获取文本人工审核结果	获取文本人工审核结果，结果以json形式返回。
TextFeedback	文本反垃圾结果反馈	反馈机器识别不准确的文本内容。
TextScan	文本扫描	文本垃圾检测和文本关键词检测。

文件

API	标题	API概述
FileAsyncScan	文件异步扫描	异步检测pdf、word等文档文件中的风险内容。
FileAsyncScanResults	查询文件异步扫描结果	查询异步文件扫描的检测结果。

网页

API	标题	API概述
WebpageAsyncScan	网页异步检测内容审核	提交HTML网页的异步风险扫描请求，结果需要异步获取。
WebpageAsyncScanResults	查询网页异步检测结果	查询HTML页面的风险检测结果，结果以json格式返回。
WebpageSyncScan	网页同步检测内容审核	同步检测html页面中的内容风险。

个体

API	标题	API概述
AddGroups	添加个体到指定分组	将一个个体添加到一个指定的分组中，检索个体时必须指定分组。
AddPerson	新建个体	创建一个个体，个体有姓名、id等可选属性。
DeleteGroups	删除个体分组	删除一个或者多个个体分组。
DeletePerson	删除个体	从一个个体库中删除一个或者多个个体。
SetPerson	设置个体信息	设置个体的姓名、id等信息。
GetFaces	查询个体信息	个体名称、关联的人脸图片ID和所属个体组ID等。
GetPerson	获取个体信息	获取指定个体的属性信息。
GetPersons	获取个体列表信息	获取指定个体分组中的个体信息。

其他

API	标题	API概述
AddVideoDna	添加视频dna	添加视频dna。
AddVideoDnaGroup	添加视频分组	添加视频dna分组
DeleteVideoDna	删除视频截动图	删除视频dna。
DeleteVideoDnaGroup	删除视频分组	删除视频dna分组。
FileAsyncScanV2	文档检测新版本	文件检测新版本。支持常见的office文档格式。
VoiceIdentityCheck	设置语音人工审核状态	设置语音人工审核状态
VoiceIdentityRegister	新增个体识别	新增语音个体识别。
VoiceIdentityStartCheck	设置实体识别算法	设置实体语音识别算法。
VoiceIdentityStartRegister	启动语音实体识别	启动实体语音识别算法。
VoiceIdentityUnregister	注销语音注册人脸	注销语音注册人脸。