com.tencentcloudapi.ims.v20201229

Class ImsClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.ims.v20201229.ImsClient

public class ImsClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
ImsClient(Credential credential, String region)
ImsClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
ImageModerationResponse	ImageModeration(ImageModerationRequest req) This API is used to submit an image for smart moderation.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImsClient

public ImsClient(Credential credential,
                 String region)

ImsClient

public ImsClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

ImageModeration

public ImageModerationResponse ImageModeration(ImageModerationRequest req)
                                        throws TencentCloudSDKException

This API is used to submit an image for smart moderation. Before using it, you need to log in to the console with the Tencent Cloud root account [to activate IMS](https://console.cloud.tencent.com/cms/image/package) and adjust the business configuration. ### API use instructions - Go to the "[CMS console - IMS](https://console.cloud.tencent.com/cms/image/package)" to activate IMS. - This API is a paid API. For its billing mode, see [IMS Pricing](https://intl.cloud.tencent.com/product/ims/pricing?from_cn_redirect=1). ### API feature description - It can detect images or links and recognize content that may be offensive, unsafe, or inappropriate based on the deep learning technology; - It can capture frames from or split GIF/long images for detection; - It can recognize various non-compliant scenarios, including vulgarity, law or regulation violations, pornography, and advertising; - It can detect multiple types of objects (such as object, advertising logo, and QR code) and recognize text in images based on OCR; - It allows you to customize moderation policies based on different business scenarios; - You can select image risk libraries to filter non-compliant images of custom types (currently, only blocklist configuration is supported); - You can associate account or device information when moderating an image to recognize the account or device involved. ### API call description - Supported image file size: **< 5 MB** - Supported image file resolution: **a resolution of 256x256 or higher** is recommended; otherwise, the recognition effect may be affected. - Supported image file formats: PNG, JPG, JPEG, BMP, GIF, and WEBP. - Supported image URL transfer protocols: HTTP and HTTPS. - If you pass in the access URL of an image, you need to **limit the image download time to 3 seconds**. To ensure the stability and reliability of the image to be detected, we recommend you use Tencent Cloud COS for storage or CDN for caching. - Default API request rate limit: **100 requests/sec**. If this limit is exceeded, an error will be reported.

Version iteration description

The version described on this page is 2020. The IMS APIs connected to before November 3, 2020 are on v2019, and you can directly access the following URL to perform maintenance operations: IMS APIs v2019

v2020 is an upgrade to v2019 to support more flexible multi-scenario business policy configuration and richer recognition callback information, meeting the recognition requirements of different businesses. We recommend you upgrade the APIs according to the v2020 connection guide. Meanwhile, we will continue to maintain v2019 until users no longer use it.

Parameters:

req - ImageModerationRequest

Returns:

ImageModerationResponse

Throws:

TencentCloudSDKException