@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
76 lines (71 loc) • 6.15 kB
TypeScript
import { AbstractClient } from "../../../common/abstract_client";
import { ClientConfig } from "../../../common/interface";
import { ImageModerationRequest, CreateImageModerationAsyncTaskResponse, CreateImageModerationAsyncTaskRequest, ImageModerationResponse } from "./ims_models";
/**
* ims client
* @class
*/
export declare class Client extends AbstractClient {
constructor(clientConfig: ClientConfig);
/**
* 本接口用于提交图片文件进行异步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms/image/package) 并调整好对应的业务配置。
### 接口使用说明:
- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms/image/package)”开启使用图片内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含**1万张图片**识别额度,有效期为1个月。
- 该接口为收费接口,计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。
### 接口功能说明:
- 支持对图片文件或链接进行检测,通过深度学习技术,识别可能令人反感、不安全或不适宜的违规图片内容;
- 支持对GIF图/长图进行截帧或拆分检测;
- 支持识别多种违规场景,包括:低俗、违法违规、色情、广告等场景;
- 支持多种物体检测(实体、广告台标、二维码等)及图片中文本的OCR文本识别;
- 支持根据不同的业务场景配置自定义的审核策略;
- 支持用户自定义选择图片风险库,打击自定义识别类型的违规图片(目前仅支持黑名单配置);
- 支持在审核图片内容时同时关联账号或设备信息,可识别违规风险账号或设备。
### 接口调用说明:
- 图片尺寸支持:**长或者宽 >50分辨率**和**长或者宽<40000分辨率**,并且**图片长宽比<90:1;**
- 图片文件分辨率支持:建议**分辨率大于256x256**,否则可能会影响识别效果;
- 图片文件支持格式:PNG、JPG、JPEG、BMP、GIF、WEBP格式;
- 图片文件链接支持的传输协议:HTTP、HTTPS;
- 若传入图片文件的访问链接,则需要注意**图片下载时间限制为3秒**,为保障被检测图片的稳定性和可靠性,建议您使用腾讯云COS存储或者CDN缓存等;
- 默认接口请求频率限制:**20次/秒**,超过此调用频率则会报错。
*/
CreateImageModerationAsyncTask(req: CreateImageModerationAsyncTaskRequest, cb?: (error: string, rep: CreateImageModerationAsyncTaskResponse) => void): Promise<CreateImageModerationAsyncTaskResponse>;
/**
* 本接口(Image Moderation, IM)用于提交图片文件进行同步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms) 并调整好对应的业务配置。
### 接口使用说明:
- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms)”开启使用图片内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含**3000张图片**识别额度,有效期为15天。
- 该接口为收费接口,计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。
### 接口功能说明:
- 支持对图片文件或链接进行检测,通过深度学习技术,识别可能令人反感、不安全或不适宜的违规图片内容;
- 支持对GIF图/长图进行截帧或拆分检测;
- 支持识别多种违规场景,包括:低俗、违法违规、色情、广告等场景;
- 支持多种物体检测(实体、广告台标、二维码等)及图片中文本的OCR文本识别;
- 支持根据不同的业务场景配置自定义的审核策略;
- 支持用户自定义选择图片风险库,打击自定义识别类型的违规图片(目前仅支持黑名单配置);
- 支持在审核图片内容时同时关联账号或设备信息,可识别违规风险账号或设备。
### 接口调用说明:
- 图片文件大小支持:**文件 < 5M**
- 图片尺寸支持:**长或者宽 >50分辨率**和**长或者宽<10000分辨率**
- 图片文件分辨率支持:建议**分辨率大于256x256**,否则可能会影响识别效果;
- 图片文件支持格式:PNG、JPG、JPEG、BMP、GIF、WEBP格式;
- 图片文件链接支持的传输协议:HTTP、HTTPS;
- 若传入图片文件的访问链接,则需要注意**图片下载时间限制为3秒**,为保障被检测图片的稳定性和可靠性,建议您使用腾讯云COS存储或者CDN缓存等;
- 默认接口请求频率限制:**100次/秒**,超过此调用频率则会报错。
-审核列表中,排序是按照用户通过API接口上传调用的时间进行排序;
<div class="rno-api-explorer" style="margin-bottom:20px">
<div class="rno-api-explorer-inner">
<div class="rno-api-explorer-hd">
<div class="rno-api-explorer-title">
关于版本迭代的描述
</div>
</div>
<div class="rno-api-explorer-body">
<div class="rno-api-explorer-cont">
<p>当前页面版本为图片内容安全2020版本,2020.11.3日前接入的图片内容安全接口为2019版本,在此时间前接入的用户可直接访问以下链接进行维护操作:<a href="https://cloud.tencent.com/document/product/1125/38206" target="_blank">图片内容安全-2019版本</a></p>
<p>2020版本相对2019版本进行了升级,支持更灵活的多场景业务策略配置以及更丰富的识别回调信息,满足不同业务的识别需求,建议按照2020版本接入指引进行接口升级;同时,2019版本也会持续维护直至用户不再使用为止。</p>
</div>
</div>
</div>
</div>
*/
ImageModeration(req: ImageModerationRequest, cb?: (error: string, rep: ImageModerationResponse) => void): Promise<ImageModerationResponse>;
}