API概览

本文为您汇总了内容安全中所有可调用的内容检测类API。

概述

本文适用基于API URL发起HTTP或HTTPS POST请求的用户,如果您使用的是SDK,可以跳过本文档。

发起API请求的URL由不同参数组合而成,有固定的请求结构(请参见请求结构)。URL中包含公共参数(请参见公共参数)、您的签名(请参见签名)和某个API接口的具体参数。每篇API文档均给出了URL请求示例供您参考,但是为了方便显示,我们并没有编码这些URL示例,您需要在发起请求前自行编码。我们根据您的签名验证了请求后,会发送返回结果给您(请参见返回结果)。接口调用成功会显示返回参数,调用失败则显示相应报错,您可以根据公共错误码和具体API错误码分析排查。

说明

推荐您使用SDK,免除手动签名验证环节,方便调用接口以及管理资源。

并发限制

并发限制指同一时刻能够检测的内容(图片、视频、文本、语音)的数量。关于接口调用的并发数量限制,请参见产品定价页的说明。

说明
  • 如果您要调整默认并发限制,请通过在线服务联系我们。提高默认并发限制需另行收费。

  • 默认情况下,针对同一对象进行多场景检测只计作一次并发。例如,对同一张图片进行色情和暴恐涉政检测,则并发数量是1。

内容审核(机审)

服务

接口

说明

图片审核

/green/image/scan

提交图片同步检测任务,检测图片违规或识别图片中的不良信息。

/green/image/asyncscan

提交图片异步检测任务,检测图片违规或识别图片中的不良信息。

/green/image/results

查询图片审核的异步检测结果。

/green/image/feedback

提交图片审核的检测结果反馈。

视频审核

/green/video/syncscan

提交视频同步检测任务,检测视频智能鉴黄、视频暴恐涉政、视频图文违规、视频不良场景、视频logo。

/green/video/asyncscan

提交视频异步检测任务,检测视频智能鉴黄、视频暴恐涉政、视频图文违规、视频不良场景、视频logo。

/green/video/results

查询视频审核的异步检测结果。

/green/video/cancelscan

取消视频流检测任务。

/green/video/feedback

提交视频审核的检测结果反馈。

文本审核

/green/text/scan

提交文本同步检测任务,检测中文或英文文本中是否包含色情、广告、灌水、涉政、辱骂等违规信息。

/green/text/feedback

提交文本审核的检测结果反馈。

音频审核

/green/voice/syncscan

提交语音同步检测任务,检测语音文件或语音流中的违规信息。

/green/voice/asyncscan

提交语音异步检测任务,检测语音文件或语音流中的违规信息。

/green/voice/results

查询语音异步检测结果。

/green/voice/cancelscan

取消语音检测任务。

文件审核

/green/file/asyncscanv2

提交文件异步检测任务,解析待检测文件中的图片和文字部分,并分别检测其中的违规内容。

/green/file/results

提交文本异步检测结果。

人工审核

接口

说明

/green/image/manual/asyncScan

如果您对识别结果的准确率和召回率要求非常高,可以调用图片人工审核功能。

/green/video/manual/asyncScan

如果您对识别结果的准确率和召回率要求非常高,可以调用视频人工审核功能。

/green/text/manual/asyncScan

如果您对识别结果的准确率和召回率要求非常高,可以调用文本人工审核功能。

/green/voice/manual/asyncScan

如果您对识别结果的准确率和召回率要求非常高,可以调用语音人工审核功能。

图文OCR识别

服务

接口

说明

通用图文OCR

/green/image/scan

提交图文OCR同步识别任务,识别图片中的文字信息。

/green/image/asyncscan

提交图文OCR异步识别任务,识别图片中的文字信息。

/green/image/results

查询图文OCR异步识别结果。

结构化卡证OCR

/green/image/scan

提交结构化卡证OCR同步识别任务,识别证件类图像中的文字信息。

/green/image/asyncscan

提交结构化卡证OCR异步识别任务,识别证件类图像中的文字信息。

/green/image/results

查询结构化卡证OCR异步识别结果。

人脸识别

服务

接口

说明

人脸属性检测

/green/face/detect

提交人脸属性检测任务,识别图片中的人脸属性信息,包括人脸模糊度、人脸角度、人脸位置、微笑程度、是否戴眼镜、是否戴口罩、是否戴帽子、是否有胡子、是否有刘海、头发类型等。

人脸比对

/green/image/scan

提交人脸比对的同步检测任务,进行人脸照片1:1比对,检测两张人脸照片的相似度。

/green/image/asyncscan

提交人脸比对的异步检测任务,进行人脸1:1比对。

/green/image/results

查询人脸比对异步检测任务的检测结果。

自定义人脸检索

接口

说明

/green/image/scan

提交自定义人脸检索任务。

根据您输入的待识别人脸图片,在指定人脸库中查找并返回最相似的Top 5个体,返回的Top 5个体按照相似度从大到小排序。

/green/sface/person/add

新建个体,并加入指定组。

/green/sface/person/update

设置个体信息,包括姓名和备注信息。

/green/sface/person/update

获取个体信息,包括姓名、相关人脸、所属的组。

/green/sface/person/delete

删除个体。

/green/sface/face/add

为指定个体新增一组人脸信息。

/green/sface/face/delete

删除指定个体下的人脸信息。

/green/sface/groups

获取所有的组列表

/green/sface/group/persons

获取指定组下的个体列表。

/green/sface/person/groups/add

新增组信息,将一个个体加入到指定组。

/green/sface/person/groups/delete

移除组信息,将一个个体从指定组中移除。