文檔審核增強版SDK及接入指南 - Content Moderation

文檔審核2.0版支援SDK方式調用和原生HTTPS方式調用。推薦您使用SDK接入，可免去簽名驗證以及Body格式構建等細節步驟。本文介紹文檔審核2.0版接入的方式。

步驟一：開通服務

訪問開通內容審核2.0版服務頁面，開通文檔審核2.0版服務。介面接入使用後系統會按使用量自動出賬，具體資訊，請參見計費說明。

開通文檔審核2.0版服務後，預設付費方式是按量後付費，且按照實際用量結算當日費用，不調用服務不收費。

步驟二：為RAM使用者授權

在接入SDK或者API之前，您需要為RAM使用者授權。您可以為RAM使用者建立一個存取金鑰（AccessKey）。在調用阿里雲API時您需要使用AccessKey完成身分識別驗證。擷取方式，請參見擷取AccessKey。

操作步驟

使用Resource Access Management員登入RAM控制台。
建立RAM使用者。
具體操作，請參見建立RAM使用者。
向RAM使用者授權系統策略許可權：AliyunYundunGreenWebFullAccess。
具體操作，請參見為RAM使用者授權。
完成以上配置後，您可以使用RAM使用者調用Alibaba Content Security ServiceAPI。

步驟三：安裝並接入文檔審核服務

目前支援的接入地區為：

地區	外網接入地址	內網接入地址	支援的服務
新加坡	green-cip.ap-southeast-1.aliyuncs.com	green-cip-vpc.ap-southeast-1.aliyuncs.com	document_detection_global

說明

如果需要其他語言的SDK範例程式碼，您可以通過OpenAPI 開發人員門戶線上調試工具調試API介面，該工具會自動產生相應API的SDK調用範例程式碼。

阿里雲SDK代碼通過定義ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET環境變數來建立預設的訪問憑證。調用介面時，程式直接存取憑證，讀取您的存取金鑰（即AccessKey）並自動完成鑒權。您在接入SDK程式碼範例之前，請先配置環境變數。具體操作，請參見身分識別驗證配置。

API介面欄位說明請參考文檔審核增強版2.0版API

Java SDK

支援Java 1.8及以上版本。

原始代碼，請參見Java SDK源碼或者Java SDK源碼（OSS路徑）。

支援以下三種類型的文檔檢測。

對公網可訪問文檔進行檢測

使用情境

當需要審核的文檔可通過公網連結訪問時，文檔審核2.0版服務可通過文檔URL擷取檔案後進行審核。

在pom.xml中加入相應依賴，就可以在Maven工程中使用SDK。

在dependencies中添加如下依賴：

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>green20220302</artifactId>
  <version>3.0.1</version>
</dependency>

接入Java SDK。

提交文檔檢測任務程式碼範例

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.FileModerationRequest; 
import com.aliyun.green20220302.models.FileModerationResponse; 
import com.aliyun.green20220302.models.FileModerationResponseBody; 
import com.aliyun.teaopenapi.models.Config;

public class FileModerationDemo {
    public static void main(String[] args) throws Exception {
        Config config = new Config();
         /**
         * 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
         * 常見擷取環境變數方式：
         * 方式一：
         *     擷取RAM使用者AccessKey ID：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方式二：
         *     擷取RAM使用者AccessKey ID：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("建議從環境變數中擷取RAM使用者AccessKey ID");
        config.setAccessKeySecret("建議從環境變數中擷取RAM使用者AccessKey Secret");
        //接入地區和地址請根據實際情況修改。
        config.setRegionId("ap-southeast-1");
        config.setEndpoint("green-cip.ap-southeast-1.aliyuncs.com");
        //串連時逾時時間，單位毫秒（ms）。
        config.setReadTimeout(6000);
        //讀取時逾時時間，單位毫秒（ms）。
        config.setConnectTimeout(3000);

        Client client = new Client(config);
        JSONObject serviceParameters = new JSONObject();
        serviceParameters.put("url", "https://xxx.oss.aliyuncs.com/xxx.pdf"); // 檔案URL

        FileModerationRequest fileModerationRequest = new FileModerationRequest(); 
        // 檢測類型：document_detection 通用文檔檢測
        fileModerationRequest.setService("document_detection_global");
        fileModerationRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            FileModerationResponse response = client.fileModeration(fileModerationRequest); 
            if (response.getStatusCode() == 200) {
                FileModerationResponseBody result = response.getBody(); 
                System.out.println(JSON.toJSONString(result));
                System.out.println("requestId = " + result.getRequestId());
                System.out.println("code = " + result.getCode());
                System.out.println("msg = " + result.getMessage());
                Integer code = result.getCode();
                if (200 == code) {
                    FileModerationResponseBody.FileModerationResponseBodyData data = result.getData();
                    System.out.println("taskId = [" + data.getTaskId() + "]");
                } else {
                    System.out.println("file moderation not success. code:" + code);
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

擷取文檔檢測任務結果

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.DescribeFileModerationResultRequest;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponse;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponseBody;
import com.aliyun.teaopenapi.models.Config;


public class DescribeFileModerationResultDemo {

    public static void main(String[] args) throws Exception {
        Config config = new Config();
        /**
         * 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
         * 常見擷取環境變數方式：
         * 方式一：
         *     擷取RAM使用者AccessKey ID：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方式二：
         *     擷取RAM使用者AccessKey ID：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("建議從環境變數中擷取RAM使用者AccessKey ID");
        config.setAccessKeySecret("建議從環境變數中擷取RAM使用者AccessKey Secret");
        //接入地區和地址請根據實際情況修改
        config.setRegionId("ap-southeast-1");
        config.setEndpoint("green-cip.ap-southeast-1.aliyuncs.com");
        //串連時逾時時間，單位毫秒（ms）。
        config.setReadTimeout(6000);
        //讀取時逾時時間，單位毫秒（ms）。
        config.setConnectTimeout(3000);
      
        Client client = new Client(config);

        JSONObject serviceParameters = new JSONObject();
        // 提交任務時返回的taskId
        serviceParameters.put("taskId", "fi_f_O5z5i*********-1xxp0V");


        DescribeFileModerationResultRequest describeFileModerationResultRequest = new DescribeFileModerationResultRequest();
        
        describeFileModerationResultRequest.setService("document_detection_global");
        describeFileModerationResultRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            DescribeFileModerationResultResponse response = client.describeFileModerationResult(describeFileModerationResultRequest);
            if (response.getStatusCode() == 200) {
                DescribeFileModerationResultResponseBody result = response.getBody();
                System.out.println("requestId=" + result.getRequestId());
                System.out.println("code=" + result.getCode());
                System.out.println("msg=" + result.getMessage());
                if (200 == result.getCode()) {
                    DescribeFileModerationResultResponseBody.DescribeFileModerationResultResponseBodyData data = result.getData();
                    System.out.println("pageResult = " + JSON.toJSONString(data.getPageResult()));
                    System.out.println("dataId = " + data.getDataId());
                    System.out.println("url = " + data.getUrl());
                } else {
                    System.out.println("file moderation result not success. code:" + result.getCode());
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

對本地文檔進行檢測

使用情境

當您需要審核的文檔在本地機器且無公網訪問連結，您可以將文檔上傳到Alibaba Content Security Service提供的Object Storage Service Bucket中，文檔審核2.0版服務可直接存取Object Storage Service，擷取到文檔內容後進行審核。

在dependencies中添加如下依賴：

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>green20220302</artifactId>
  <version>3.0.1</version>
</dependency>

安裝OSS SDK：

<dependency>
  <groupId>com.aliyun.oss</groupId>
  <artifactId>aliyun-sdk-oss</artifactId>
  <version>3.16.3</version>
</dependency>

接入Java SDK。

提交文檔檢測任務程式碼範例

import com.alibaba.fastjson.JSON;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.DescribeUploadTokenResponse;
import com.aliyun.green20220302.models.DescribeUploadTokenResponseBody;
import com.aliyun.green20220302.models.FileModerationRequest;
import com.aliyun.green20220302.models.FileModerationResponse;
import com.aliyun.green20220302.models.FileModerationResponseBody;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.model.PutObjectRequest;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teautil.models.RuntimeOptions;

import java.io.File;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

public class FileModerationFile {
    /**服務是否部署在vpc上*/
    public static boolean isVPC = false;

    /**檔案上傳token endpoint->token*/
    public static Map<String, DescribeUploadTokenResponseBody.DescribeUploadTokenResponseBodyData> tokenMap = new HashMap<>();

    /**上傳檔案請求用戶端*/
    public static OSS ossClient = null;

    /**
     * 建立請求用戶端
     *
     * @param accessKeyId
     * @param accessKeySecret
     * @param endpoint
     * @return
     * @throws Exception
     */
    public static Client createClient(String accessKeyId, String accessKeySecret, String endpoint) throws Exception {
        Config config = new Config();
        config.setAccessKeyId(accessKeyId);
        config.setAccessKeySecret(accessKeySecret);
        // 接入地區和地址請根據實際情況修改
        config.setEndpoint(endpoint);
        return new Client(config);
    }

    /**
     * 建立上傳檔案請求用戶端
     *
     * @param tokenData
     * @param isVPC
     */
    public static void getOssClient(DescribeUploadTokenResponseBody.DescribeUploadTokenResponseBodyData tokenData, boolean isVPC) {
        //注意，此處執行個體化的client請儘可能重複使用，避免重複建立串連，提升檢測效能。
        if (isVPC) {
            ossClient = new OSSClientBuilder().build(tokenData.ossInternalEndPoint, tokenData.getAccessKeyId(), tokenData.getAccessKeySecret(), tokenData.getSecurityToken());
        } else {
            ossClient = new OSSClientBuilder().build(tokenData.ossInternetEndPoint, tokenData.getAccessKeyId(), tokenData.getAccessKeySecret(), tokenData.getSecurityToken());
        }
    }

    /**
     * 上傳檔案
     *
     * @param filePath
     * @param tokenData
     * @return
     * @throws Exception
     */
    public static String uploadFile(String filePath, DescribeUploadTokenResponseBody.DescribeUploadTokenResponseBodyData tokenData) throws Exception {
        String[] split = filePath.split("\\.");
        String objectName;
        if (split.length > 1) {
            objectName = tokenData.getFileNamePrefix() + UUID.randomUUID() + "." + split[split.length - 1];
        } else {
            objectName = tokenData.getFileNamePrefix() + UUID.randomUUID();
        }
        PutObjectRequest putObjectRequest = new PutObjectRequest(tokenData.getBucketName(), objectName, new File(filePath));
        ossClient.putObject(putObjectRequest);
        return objectName;
    }

    public static FileModerationResponse invokeFunction(String accessKeyId, String accessKeySecret, String endpoint) throws Exception {
        //注意，此處執行個體化的client請儘可能重複使用，避免重複建立串連，提升檢測效能。
        Client client = createClient(accessKeyId, accessKeySecret, endpoint);
        RuntimeOptions runtime = new RuntimeOptions();

        //本地檔案的完整路徑，例如D:\localPath\exampleFile.mp3。
        String filePath = "D:/test/1.pdf";
        //擷取檔案上傳token
        if (tokenMap.get(endpoint) == null || tokenMap.get(endpoint).expiration <= System.currentTimeMillis() / 1000) {
            DescribeUploadTokenResponse tokenResponse = client.describeUploadToken();
            tokenMap.put(endpoint, tokenResponse.getBody().getData());
        }
        //上傳檔案請求用戶端
        getOssClient(tokenMap.get(endpoint), isVPC);

        //上傳檔案
        String objectName = uploadFile(filePath, tokenMap.get(endpoint));

        // 檢測參數構造。
        Map<String, String> serviceParameters = new HashMap<>();
        //檔案上傳資訊
        serviceParameters.put("ossBucketName", tokenMap.get(endpoint).getBucketName());
        serviceParameters.put("ossObjectName", objectName);
        serviceParameters.put("dataId", UUID.randomUUID().toString());

        FileModerationRequest request = new FileModerationRequest();
        // 檢測類型。
        request.setService("document_detection_global");
        request.setServiceParameters(JSON.toJSONString(serviceParameters));

        FileModerationResponse response = null;
        try {
            response = client.fileModerationWithOptions(request, runtime);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return response;
    }

    public static void main(String[] args) throws Exception {
        /**
         * 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
         * 常見擷取環境變數方式：
         * 方式一：
         *     擷取RAM使用者AccessKey ID：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方式二：
         *     擷取RAM使用者AccessKey ID：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("建議從環境變數中擷取RAM使用者AccessKey ID");
        config.setAccessKeySecret("建議從環境變數中擷取RAM使用者AccessKey Secret");
        // 接入地區和地址請根據實際情況修改。
        FileModerationResponse response = invokeFunction(accessKeyId, accessKeySecret, "green-cip.ap-southeast-1.aliyuncs.com");

            // 列印檢測結果。
            if (response != null) {
                if (response.getStatusCode() == 200) {
                    FileModerationResponseBody body = response.getBody();
                    System.out.println(JSON.toJSONString(body));
                    System.out.println("requestId = " + body.getRequestId());
                    System.out.println("code = " + body.getCode());
                    System.out.println("msg = " + body.getMessage());
                    Integer code = body.getCode();
                    if (200 == code) {
                        FileModerationResponseBody.FileModerationResponseBodyData data = body.getData();
                        System.out.println("taskId = [" + data.getTaskId() + "]");
                    } else {
                        System.out.println("file moderation not success. code:" + code);
                    }
                } else {
                    System.out.println("response not success. status:" + response.getStatusCode());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

擷取文檔檢測任務程式碼範例

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.DescribeFileModerationResultRequest;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponse;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponseBody;
import com.aliyun.teaopenapi.models.Config;


public class DescribeFileModerationResultDemo {

    public static void main(String[] args) throws Exception {
        Config config = new Config();
        /**
         * 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
         * 常見擷取環境變數方式：
         * 方式一：
         *     擷取RAM使用者AccessKey ID：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方式二：
         *     擷取RAM使用者AccessKey ID：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("建議從環境變數中擷取RAM使用者AccessKey ID");
        config.setAccessKeySecret("建議從環境變數中擷取RAM使用者AccessKey Secret");
        //接入地區和地址請根據實際情況修改
        config.setRegionId("ap-southeast-1");
        config.setEndpoint("green-cip.ap-southeast-1.aliyuncs.com");
        //串連時逾時時間，單位毫秒（ms）。
        config.setReadTimeout(6000);
        //讀取時逾時時間，單位毫秒（ms）。
        config.setConnectTimeout(3000);
      
        Client client = new Client(config);

        JSONObject serviceParameters = new JSONObject();
        // 提交任務時返回的taskId
        serviceParameters.put("taskId", "fi_f_O5z5i*********-1xxp0V");


        DescribeFileModerationResultRequest describeFileModerationResultRequest = new DescribeFileModerationResultRequest();
        
        describeFileModerationResultRequest.setService("document_detection_global");
        describeFileModerationResultRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            DescribeFileModerationResultResponse response = client.describeFileModerationResult(describeFileModerationResultRequest);
            if (response.getStatusCode() == 200) {
                DescribeFileModerationResultResponseBody result = response.getBody();
                System.out.println("requestId=" + result.getRequestId());
                System.out.println("code=" + result.getCode());
                System.out.println("msg=" + result.getMessage());
                if (200 == result.getCode()) {
                    DescribeFileModerationResultResponseBody.DescribeFileModerationResultResponseBodyData data = result.getData();
                    System.out.println("pageResult = " + JSON.toJSONString(data.getPageResult()));
                    System.out.println("dataId = " + data.getDataId());
                    System.out.println("url = " + data.getUrl());
                } else {
                    System.out.println("file moderation result not success. code:" + result.getCode());
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

對OSS文檔進行檢測

使用情境

如果您需要審核的文檔檔案已經儲存在阿里雲Object Storage Service中，您可授權建立服務角色，允許Alibaba Content Security Service服務訪問Object Storage Service。文檔審核2.0版服務會通過服務角色擷取到Object Storage Service的檔案後進行審核。訪問雲資源訪問授權頁面建立服務角色。

在dependencies中添加如下依賴：

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>green20220302</artifactId>
  <version>3.0.1</version>
</dependency>

安裝OSS SDK：

<dependency>
  <groupId>com.aliyun.oss</groupId>
  <artifactId>aliyun-sdk-oss</artifactId>
  <version>3.16.3</version>
</dependency>

接入Java SDK。

提交文檔檢測任務程式碼範例

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.FileModerationRequest; 
import com.aliyun.green20220302.models.FileModerationResponse; 
import com.aliyun.green20220302.models.FileModerationResponseBody; 
import com.aliyun.teaopenapi.models.Config;

public class FileModerationDemo {
    public static void main(String[] args) throws Exception {
        Config config = new Config();
         /**
         * 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
         * 常見擷取環境變數方式：
         * 方式一：
         *     擷取RAM使用者AccessKey ID：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方式二：
         *     擷取RAM使用者AccessKey ID：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("建議從環境變數中擷取RAM使用者AccessKey ID");
        config.setAccessKeySecret("建議從環境變數中擷取RAM使用者AccessKey Secret");
        //接入地區和地址請根據實際情況修改。
        config.setRegionId("ap-southeast-1");
        config.setEndpoint("green-cip.ap-southeast-1.aliyuncs.com");
        //串連時逾時時間，單位毫秒（ms）。
        config.setReadTimeout(6000);
        //讀取時逾時時間，單位毫秒（ms）。
        config.setConnectTimeout(3000);

        Client client = new Client(config);
        JSONObject serviceParameters = new JSONObject();
        serviceParameters.put("ossBucketName", "bucket_01");
        serviceParameters.put("ossObjectName", "2022023/04/24/test.pdf");
        serviceParameters.put("ossRegionId", "ap-southeast-1"); 

        FileModerationRequest fileModerationRequest = new FileModerationRequest(); 
        // 檢測類型：document_detection 通用文檔檢測
        fileModerationRequest.setService("document_detection_global");
        fileModerationRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            FileModerationResponse response = client.fileModeration(fileModerationRequest); 
            if (response.getStatusCode() == 200) {
                FileModerationResponseBody result = response.getBody(); 
                System.out.println(JSON.toJSONString(result));
                System.out.println("requestId = " + result.getRequestId());
                System.out.println("code = " + result.getCode());
                System.out.println("msg = " + result.getMessage());
                Integer code = result.getCode();
                if (200 == code) {
                    FileModerationResponseBody.FileModerationResponseBodyData data = result.getData();
                    System.out.println("taskId = [" + data.getTaskId() + "]");
                } else {
                    System.out.println("file moderation not success. code:" + code);
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

擷取文檔檢測任務程式碼範例

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.green20220302.Client;
import com.aliyun.green20220302.models.DescribeFileModerationResultRequest;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponse;
import com.aliyun.green20220302.models.DescribeFileModerationResultResponseBody;
import com.aliyun.teaopenapi.models.Config;


public class DescribeFileModerationResultDemo {

    public static void main(String[] args) throws Exception {
        Config config = new Config();
        /**
         * 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
         * 常見擷取環境變數方式：
         * 方式一：
         *     擷取RAM使用者AccessKey ID：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         * 方式二：
         *     擷取RAM使用者AccessKey ID：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_ID");
         *     擷取RAM使用者AccessKey Secret：System.getProperty("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
         */
        config.setAccessKeyId("建議從環境變數中擷取RAM使用者AccessKey ID");
        config.setAccessKeySecret("建議從環境變數中擷取RAM使用者AccessKey Secret");
        //接入地區和地址請根據實際情況修改
        config.setRegionId("ap-southeast-1");
        config.setEndpoint("green-cip.ap-southeast-1.aliyuncs.com");
        //串連時逾時時間，單位毫秒（ms）。
        config.setReadTimeout(6000);
        //讀取時逾時時間，單位毫秒（ms）。
        config.setConnectTimeout(3000);
      
        Client client = new Client(config);

        JSONObject serviceParameters = new JSONObject();
        // 提交任務時返回的taskId
        serviceParameters.put("taskId", "fi_f_O5z5i*********-1xxp0V");


        DescribeFileModerationResultRequest describeFileModerationResultRequest = new DescribeFileModerationResultRequest();
        
        describeFileModerationResultRequest.setService("document_detection_global");
        describeFileModerationResultRequest.setServiceParameters(serviceParameters.toJSONString());

        try {
            DescribeFileModerationResultResponse response = client.describeFileModerationResult(describeFileModerationResultRequest);
            if (response.getStatusCode() == 200) {
                DescribeFileModerationResultResponseBody result = response.getBody();
                System.out.println("requestId=" + result.getRequestId());
                System.out.println("code=" + result.getCode());
                System.out.println("msg=" + result.getMessage());
                if (200 == result.getCode()) {
                    DescribeFileModerationResultResponseBody.DescribeFileModerationResultResponseBodyData data = result.getData();
                    System.out.println("pageResult = " + JSON.toJSONString(data.getPageResult()));
                    System.out.println("dataId = " + data.getDataId());
                    System.out.println("url = " + data.getUrl());
                } else {
                    System.out.println("file moderation result not success. code:" + result.getCode());
                }
            } else {
                System.out.println("response not success. status:" + response.getStatusCode());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Python SDK

支援Python 3.6及以上版本。

原始代碼，請參見Python SDK源碼。

支援以下三種類型的文檔檢測。

對公網可訪問文檔進行檢測

使用情境

當需要審核的文檔可通過公網連結訪問時，文檔審核2.0版服務可通過文檔URL擷取檔案後進行審核。

執行如下命令安裝pip。

pip install alibabacloud_green20220302==3.0.1

接入Python SDK。

提交文檔檢測任務程式碼範例

# coding=utf-8
# python version >= 3.6
from alibabacloud_green20220302.client import Client
from alibabacloud_green20220302 import models
from alibabacloud_tea_openapi.models import Config
import json

config = Config(
    # 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    # 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    # 常見擷取環境變數方式：
    # 擷取RAM使用者AccessKey ID：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # 擷取RAM使用者AccessKey Secret：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='建議從環境變數中擷取RAM使用者AccessKey ID',
    access_key_secret='建議從環境變數中擷取RAM使用者AccessKey Secret',
    # 連線逾時時間 單位毫秒(ms)
    connect_timeout=10000, 
    # 讀逾時時間 單位毫秒(ms) 
    read_timeout=3000,  
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)

clt = Client(config)

serviceParameters = {
    'url': 'https://detect-obj.oss-cn-hangzhou.aliyuncs.com/sample/xxxx.pdf',
}
fileModerationRequest = models.FileModerationRequest(
    # 檢測類型
    service='document_detection_global',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.file_moderation(fileModerationRequest)
    if response.status_code == 200:
        # 調用成功
        result = response.body
        print('response success. result:{}'.format(result))
    else:
        print('response not success. status:{} ,result:{}'.format(response.status_code, response))
except Exception as err:
    print(err)

擷取文檔檢測任務結果

# coding=utf-8
# python version >= 3.6
from alibabacloud_green20220302.client import Client
from alibabacloud_green20220302 import models
from alibabacloud_tea_openapi.models import Config
import json

config = Config(
    # 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    # 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    # 常見擷取環境變數方式：
    # 擷取RAM使用者AccessKey ID：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # 擷取RAM使用者AccessKey Secret：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='建議從環境變數中擷取RAM使用者AccessKey ID',
    access_key_secret='建議從環境變數中擷取RAM使用者AccessKey Secret',
    # 連線逾時時間 單位毫秒(ms)
    connect_timeout=10000, 
    # 讀逾時時間 單位毫秒(ms) 
    read_timeout=3000,  
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)

clt = Client(config)

# 提交任務時返回的taskId
serviceParameters = {
    "taskId": 'fi_f_11w5THcb*******a-1xx7hH'
}
describeFileModerationResultRequest = models.DescribeFileModerationResultRequest(
    # 檢測類型
    service='document_detection_global',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.describe_file_moderation_result(describeFileModerationResultRequest)
    if response.status_code == 200:
        # 調用成功
        # 擷取審核結果
        result = response.body
        print('response success. result:{}'.format(result))
    else:
        print('response not success. status:{} ,result:{}'.format(response.status_code, response))
except Exception as err:
    print(err)

對本地文檔進行檢測

使用情境

執行如下命令安裝pip。

pip install alibabacloud_green20220302==3.0.1

安裝OSS SDK：

pip install oss2

接入Python SDK。

提交文檔檢測任務程式碼範例

from alibabacloud_green20220302.client import Client
from alibabacloud_green20220302 import models
from alibabacloud_tea_openapi.models import Config
from alibabacloud_tea_util.client import Client as UtilClient
from alibabacloud_tea_util import models as util_models
import json
import uuid

import oss2
import time

configs = Config(
    # 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    # 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    # 常見擷取環境變數方式：
    # 擷取RAM使用者AccessKey ID：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # 擷取RAM使用者AccessKey Secret：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='建議從環境變數中擷取RAM使用者AccessKey ID',
    access_key_secret='建議從環境變數中擷取RAM使用者AccessKey Secret',
    # 串連時逾時時間，單位毫秒（ms）。
    connect_timeout=10000,
    # 讀取時逾時時間，單位毫秒（ms）。
    read_timeout=10000,
    # 接入地區和地址請根據實際情況修改。
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)
# 注意：此處執行個體化的client請儘可能重複使用，避免重複建立串連，提升檢測效能。
client = Client(configs)

bucket = None
upload_token = None


def get_oss_client(is_vpc):
    global upload_token
    global bucket
    if (upload_token == None) or int(upload_token.expiration) <= int(time.time()):
        response = client.describe_upload_token()

        upload_token = response.body.data
        auth = oss2.StsAuth(upload_token.access_key_id, upload_token.access_key_secret, upload_token.security_token)

        end_point = upload_token.oss_internet_end_point
        if (is_vpc):
            end_point = upload_token.oss_internal_end_point
        bucket = oss2.Bucket(auth, end_point, upload_token.bucket_name)


def upload_file(file_name, is_vpc):
    get_oss_client(is_vpc)
    object_name = upload_token.file_name_prefix + str(uuid.uuid4()) + '.' + file_name.split('.')[-1]
    bucket.put_object_from_file(object_name, file_name)
    return object_name


def file_moderation_by_local_file(file_path, is_vpc):
    # 1. 上傳檔案
    object_name = upload_file(file_path, is_vpc)

    # 2. 檢測參數
    service_parameters = {
        'dataId': str(uuid.uuid4()),
        'ossBucketName': upload_token.bucket_name,
        'ossObjectName': object_name
    }

    file_moderation_request = models.FileModerationRequest(
        # 檢測類型。
        service='document_detection_global',
        service_parameters=json.dumps(service_parameters)
    )

    # 建立RuntimeObject執行個體並設定運行參數。
    runtime = util_models.RuntimeOptions()
    runtime.read_timeout = 10000
    runtime.connect_timeout = 10000
    try:
        global client
        response = client.file_moderation_with_options(file_moderation_request, runtime)

        if response.status_code == 200:
            # 調用成功。
            # 擷取審核結果。
            result = response.body
            print('response success. result:{}'.format(result))
            if result.code == 200:
                result_data = result.data
                print('result: {}'.format(result_data))
        else:
            print('response not success. status:{} ,result:{}'.format(response.status_code, response))
    except Exception as err:
        print(err)


if __name__ == '__main__':
    # 本地檔案路徑
    file_path = '/Users/test/MS.pdf'
    # 是否在VPC上部署
    is_vpc = False  # True
    file_moderation_by_local_file(file_path, is_vpc)

擷取文檔檢測任務結果

# coding=utf-8
# python version >= 3.6
from alibabacloud_green20220302.client import Client
from alibabacloud_green20220302 import models
from alibabacloud_tea_openapi.models import Config
import json

config = Config(
    # 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    # 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    # 常見擷取環境變數方式：
    # 擷取RAM使用者AccessKey ID：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # 擷取RAM使用者AccessKey Secret：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='建議從環境變數中擷取RAM使用者AccessKey ID',
    access_key_secret='建議從環境變數中擷取RAM使用者AccessKey Secret',
    # 連線逾時時間 單位毫秒(ms)
    connect_timeout=10000, 
    # 讀逾時時間 單位毫秒(ms) 
    read_timeout=3000,  
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)

clt = Client(config)

# 提交任務時返回的taskId
serviceParameters = {
    "taskId": 'fi_f_11w5THcb*******a-1xx7hH'
}
describeFileModerationResultRequest = models.DescribeFileModerationResultRequest(
    # 檢測類型
    service='document_detection_global',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.describe_file_moderation_result(describeFileModerationResultRequest)
    if response.status_code == 200:
        # 調用成功
        # 擷取審核結果
        result = response.body
        print('response success. result:{}'.format(result))
    else:
        print('response not success. status:{} ,result:{}'.format(response.status_code, response))
except Exception as err:
    print(err)

對OSS文檔進行檢測

使用情境

執行如下命令安裝pip。

pip install alibabacloud_green20220302==3.0.1

接入Python SDK。

提交文檔檢測任務程式碼範例

# coding=utf-8
# python version >= 3.6
from alibabacloud_green20220302.client import Client
from alibabacloud_green20220302 import models
from alibabacloud_tea_openapi.models import Config
import json

config = Config(
    # 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    # 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    # 常見擷取環境變數方式：
    # 擷取RAM使用者AccessKey ID：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # 擷取RAM使用者AccessKey Secret：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='建議從環境變數中擷取RAM使用者AccessKey ID',
    access_key_secret='建議從環境變數中擷取RAM使用者AccessKey Secret',
    # 連線逾時時間 單位毫秒(ms)
    connect_timeout=10000,
    # 讀逾時時間 單位毫秒(ms)
    read_timeout=3000,
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)

clt = Client(config)

serviceParameters = {
    'ossRegionId': 'cn-hangzhou',
    'ossBucketName': 'detect-obj',
    'ossObjectName': 'sample/xxxx.pdf'
}
fileModerationRequest = models.FileModerationRequest(
    # 檢測類型
    service='document_detection_global',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.file_moderation(fileModerationRequest)
    if response.status_code == 200:
        # 調用成功
        result = response.body
        print('response success. result:{}'.format(result))
    else:
        print('response not success. status:{} ,result:{}'.format(response.status_code, response))
except Exception as err:
    print(err)

擷取文檔檢測任務結果

# coding=utf-8
# python version >= 3.6
from alibabacloud_green20220302.client import Client
from alibabacloud_green20220302 import models
from alibabacloud_tea_openapi.models import Config
import json

config = Config(
    # 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
    # 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
    # 常見擷取環境變數方式：
    # 擷取RAM使用者AccessKey ID：os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    # 擷取RAM使用者AccessKey Secret：os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    access_key_id='建議從環境變數中擷取RAM使用者AccessKey ID',
    access_key_secret='建議從環境變數中擷取RAM使用者AccessKey Secret',
    # 連線逾時時間 單位毫秒(ms)
    connect_timeout=10000, 
    # 讀逾時時間 單位毫秒(ms) 
    read_timeout=3000,  
    region_id='ap-southeast-1',
    endpoint='green-cip.ap-southeast-1.aliyuncs.com'
)

clt = Client(config)

# 提交任務時返回的taskId
serviceParameters = {
    "taskId": 'fi_f_11w5THcb*******a-1xx7hH'
}
describeFileModerationResultRequest = models.DescribeFileModerationResultRequest(
    # 檢測類型
    service='document_detection_global',
    service_parameters=json.dumps(serviceParameters)
)

try:
    response = clt.describe_file_moderation_result(describeFileModerationResultRequest)
    if response.status_code == 200:
        # 調用成功
        # 擷取審核結果
        result = response.body
        print('response success. result:{}'.format(result))
    else:
        print('response not success. status:{} ,result:{}'.format(response.status_code, response))
except Exception as err:
    print(err)

PHP SDK

支援PHP 5.6及以上版本。

原始代碼，請參見PHP SDK源碼。

支援以下三種類型的文檔檢測。

對公網可訪問文檔進行檢測

使用情境

當需要審核的文檔可通過公網連結訪問時，文檔審核2.0版服務可通過文檔URL擷取檔案後進行審核。

執行如下命令引入相關依賴。

composer require alibabacloud/green-20220302 3.0.1

接入PHP SDK。

提交文檔檢測任務程式碼範例

<?php
require('vendor/autoload.php');

use AlibabaCloud\SDK\Green\V20220302\Models\FileModerationRequest;
use AlibabaCloud\Tea\Exception\TeaUnableRetryError;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use AlibabaCloud\SDK\Green\V20220302\Green;

$config = new Config([
    /**
     * 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
     * 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
     * 常見擷取環境變數方式：
     * 擷取RAM使用者AccessKey ID：getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
     * 擷取RAM使用者AccessKey Secret：getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
     */
    "accessKeyId" => '建議從環境變數中擷取RAM使用者AccessKey ID',
    "accessKeySecret" => '建議從環境變數中擷取RAM使用者AccessKey Secret',
    "endpoint" => "green-cip.ap-southeast-1.aliyuncs.com",
    "regionId" => "ap-southeast-1"

]);
// 注意，此處執行個體化的client請儘可能重複使用，避免重複建立串連，提升檢測效能。
$client = new Green($config);

$request = new FileModerationRequest();
$request->service = "document_detection_global";
$serviceParameters = array("url" => "https://xxx.oss.aliyuncs.com/xxx.pdf");

$request->serviceParameters = json_encode($serviceParameters);

$runtime = new RuntimeOptions();
$runtime->readTimeout = 6000;
$runtime->connectTimeout = 3000;

try {
    $response = $client->fileModerationWithOptions($request, $runtime);
    print_r($response->body);
    if (200 != $response->statusCode) {
        print_r("response not success. code:" . $response->statusCode);
        return;
    }
    $body = $response->body;
    print_r("requestId = " . $body->requestId . "\n");
    print_r("code = " . $body->code . "\n");
    print_r("message = " . $body->message . "\n");
    if (200 != $body->code) {
        print_r("file moderation not success. code:" . $body->code);
    }
    $data = $body->data;
    print_r("taskId = " . $data->taskId);
} catch (TeaUnableRetryError $e) {
    var_dump($e->getMessage());
    var_dump($e->getErrorInfo());
    var_dump($e->getLastException());
    var_dump($e->getLastRequest());
}

擷取文檔檢測任務結果

<?php
require('vendor/autoload.php');

use AlibabaCloud\SDK\Green\V20220302\Models\DescribeFileModerationResultRequest;
use AlibabaCloud\Tea\Exception\TeaUnableRetryError;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use AlibabaCloud\SDK\Green\V20220302\Green;

$config = new Config([
    /**
     * 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
     * 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
     * 常見擷取環境變數方式：
     * 擷取RAM使用者AccessKey ID：getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
     * 擷取RAM使用者AccessKey Secret：getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
     */
    "accessKeyId" => '建議從環境變數中擷取RAM使用者AccessKey ID',
    "accessKeySecret" => '建議從環境變數中擷取RAM使用者AccessKey Secret',
    "endpoint" => "green-cip.ap-southeast-1.aliyuncs.com",
    "regionId" => "ap-southeast-1"

]);
// 注意，此處執行個體化的client請儘可能重複使用，避免重複建立串連，提升檢測效能。
$client = new Green($config);

$request = new DescribeFileModerationResultRequest();
$request->service = "document_detection_global";
$serviceParameters = array("taskId" => "fi_f_O5z5iaIis*****NYj7qa-1x****");

$request->serviceParameters = json_encode($serviceParameters);

$runtime = new RuntimeOptions();
$runtime->readTimeout = 6000;
$runtime->connectTimeout = 3000;

try {
    $response = $client->describeFileModerationResultWithOptions($request, $runtime);
    if (200 != $response->statusCode) {
        print_r("response not success. code:" . $response->statusCode);
        return;
    }
    $body = $response->body;
    print_r("requestId = " . $body->requestId . "\n");
    print_r("code = " . $body->code . "\n");
    print_r("message = " . $body->message . "\n");
    if (280 == $body->code) {
        print_r("processing file moderation. code:" . $body->code);
        return;
    }
    if (200 != $body->code) {
        print_r("file moderation result not success. code:" . $body->code);
        return;
    }
    $data = $body->data;
      print_r("data = " . json_encode($data) . "\n");
    print_r("pageResult = " . json_encode($data->pageResult) . "\n");
} catch (TeaUnableRetryError $e) {
    var_dump($e->getMessage());
    var_dump($e->getErrorInfo());
    var_dump($e->getLastException());
    var_dump($e->getLastRequest());
}

對本地文檔進行檢測

使用情境

執行如下命令引入相關依賴。

composer require alibabacloud/green-20220302 3.0.1

安裝OSS SDK：

composer require aliyuncs/oss-sdk-php

接入PHP SDK。
- 提交文檔檢測任務程式碼範例
- 擷取文檔檢測任務結果

對OSS文檔進行檢測

使用情境

執行如下命令引入相關依賴。

composer require alibabacloud/green-20220302 3.0.1

接入PHP SDK。
- 提交文檔檢測任務程式碼範例
- 擷取文檔檢測任務結果

Go SDK

支援以下三種類型的文檔檢測。

對公網可訪問文檔進行檢測

使用情境

當需要審核的文檔可通過公網連結訪問時，文檔審核2.0版服務可通過文檔URL擷取檔案後進行審核。

Go SDK

執行如下命令引入相關依賴。

go get github.com/alibabacloud-go/green-20220302/v3@v3.0.1

接入Go SDK。

提交文檔檢測任務程式碼範例

package main

import (
    "encoding/json"
    "fmt"
    openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
    green20220302 "github.com/alibabacloud-go/green-20220302/v2/client"
    util "github.com/alibabacloud-go/tea-utils/v2/service"
    "github.com/alibabacloud-go/tea/tea"
    "net/http"
)

func main() {
    // 工程代碼泄露可能會導致AccessKey泄露，並威脅帳號下所有資源的安全性。以下程式碼範例僅供參考，建議使用更安全的STS方式。
    config := &openapi.Config{
        /**
         * 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
         * 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
         * 常見擷取環境變數方式：
         * 擷取RAM使用者AccessKey ID：os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
         * 擷取RAM使用者AccessKey Secret：os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
         */
        AccessKeyId: tea.String("建議從環境變數中擷取RAM使用者AccessKey ID"),
        AccessKeySecret: tea.String("建議從環境變數中擷取RAM使用者AccessKey Secret"),
        RegionId: tea.String("ap-southeast-1"),
        Endpoint: tea.String("green-cip.ap-southeast-1.aliyuncs.com"),
        /**
     * 請設定逾時時間。服務端全鏈路處理逾時時間為10秒，請做相應設定。
     * 如果您設定的ReadTimeout小於服務端處理的時間，程式中會獲得一個ReadTimeout異常。
     */
        ConnectTimeout: tea.Int(3000),
        ReadTimeout:    tea.Int(6000),
    }
    client, _err := green20220302.NewClient(config)
    if _err != nil {
        panic(_err)
    }

    // 建立RuntimeObject執行個體並設定運行參數。
    runtime := &util.RuntimeOptions{}
    runtime.ReadTimeout = tea.Int(10000)
    runtime.ConnectTimeout = tea.Int(10000)

    serviceParameters, _ := json.Marshal(
        map[string]interface{}{
            "url": "https://xxx.oss.aliyuncs.com/xxx.pdf",
        },
    )
    request := green20220302.FileModerationRequest{
        Service:           tea.String("document_detection_global"),
        ServiceParameters: tea.String(string(serviceParameters)),
    }

    result, _err := client.FileModerationWithOptions(&request, runtime)
    if _err != nil {
        panic(_err)
    }

    if *result.StatusCode != http.StatusOK {
        fmt.Printf("response not success. status:%d\n", *result.StatusCode)
        return
    }
    body := result.Body
    fmt.Printf("response success. requestId:%s, code:%d, msg:%s\n", *body.RequestId, *body.Code, *body.Message)
    if *body.Code != http.StatusOK {
        fmt.Printf("file moderation not success. code:%d\n", *body.Code)
        return
    }
    
    data := body.Data
    fmt.Printf("file moderation taskId:%s\n", *data.TaskId)
}

擷取文檔檢測任務結果

package main

import (
    "encoding/json"
    "fmt"
    openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
    green20220302 "github.com/alibabacloud-go/green-20220302/v2/client"
    util "github.com/alibabacloud-go/tea-utils/v2/service"
    "github.com/alibabacloud-go/tea/tea"
    "net/http"
)

func main() {
    // 工程代碼泄露可能會導致AccessKey泄露，並威脅帳號下所有資源的安全性。以下程式碼範例僅供參考，建議使用更安全的STS方式。
    config := &openapi.Config{
        /**
         * 阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運。
         * 強烈建議不要把AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。
         * 常見擷取環境變數方式：
         * 擷取RAM使用者AccessKey ID：os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")
         * 擷取RAM使用者AccessKey Secret：os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
         */
        AccessKeyId: tea.String("建議從環境變數中擷取RAM使用者AccessKey ID"),
        AccessKeySecret: tea.String("建議從環境變數中擷取RAM使用者AccessKey Secret"),
        RegionId: tea.String("ap-southeast-1"),
        Endpoint: tea.String("green-cip.ap-southeast-1.aliyuncs.com"),
        /**
     * 請設定逾時時間。服務端全鏈路處理逾時時間為10秒，請做相應設定。
     * 如果您設定的ReadTimeout小於服務端處理的時間，程式中會獲得一個ReadTimeout異常。
     */
        ConnectTimeout: tea.Int(3000),
        ReadTimeout:    tea.Int(6000),
    }
    client, _err := green20220302.NewClient(config)
    if _err != nil {
    panic(_err)
    }

    // 建立RuntimeObject執行個體並設定運行參數。
    runtime := &util.RuntimeOptions{}
    runtime.ReadTimeout = tea.Int(10000)
    runtime.ConnectTimeout = tea.Int(10000)

    serviceParameters, _ := json.Marshal(
    map[string]interface{}{
    "taskId": "fi_f_O5z5iaIi******-1x****",
    },
    )
    request := green20220302.DescribeFileModerationResultRequest{
    Service:           tea.String("document_detection_global"),
    ServiceParameters: tea.String(string(serviceParameters)),
    }

    result, _err := client.DescribeFileModerationResultWithOptions(&request, runtime)
    if _err != nil {
    panic(_err)
    }

    if *result.StatusCode != http.StatusOK {
    fmt.Printf("response not success. status:%d\n", *result.StatusCode)
    return
    }
    body := result.Body
    fmt.Printf("response success. requestId:%s, code:%d, msg:%s\n", *body.RequestId, *body.Code, *body.Message)
    if *body.Code == 280 {
    fmt.Printf("processing file moderation. code:%d\n", *body.Code)
    return
    }
    if *body.Code != http.StatusOK {
    fmt.Printf("file moderation result not success. code:%d\n", *body.Code)
    return
    }

    data := body.Data
    fmt.Printf("file moderation result:%s\n", data)
    fmt.Printf("file moderation result pageResult:%s\n", data.PageResult)
    fmt.Printf("file moderation result dataId:%s\n", data.DataId)
}

對本地文檔進行檢測

使用情境

執行如下命令引入相關依賴。

go get github.com/alibabacloud-go/green-20220302/v3@v3.0.1

安裝OSS SDK：

go get github.com/aliyun/aliyun-oss-go-sdk/oss

接入Go SDK。
- 提交文檔檢測任務程式碼範例
- 擷取文檔檢測任務結果

對OSS文檔進行檢測

使用情境

執行如下命令引入相關依賴。

go get github.com/alibabacloud-go/green-20220302/v3@v3.0.1

接入Go SDK。
- 提交文檔檢測任務程式碼範例
- 擷取文檔檢測任務結果

Node.js SDK

原始代碼，請參見Node.js SDK源碼。

支援以下三種類型的文檔檢測。

對公網可訪問文檔進行檢測

使用情境

當需要審核的文檔可通過公網連結訪問時，文檔審核2.0版服務可通過文檔URL擷取檔案後進行審核。

執行如下命令引入相關依賴。

npm install @alicloud/green20220302@3.0.1

接入Node.js SDK。
- 提交文檔檢測任務程式碼範例
  擷取文檔檢測任務結果程式碼範例

對本地文檔進行檢測

使用情境

執行如下命令引入相關依賴。

npm install @alicloud/green20220302@3.0.1

安裝OSS SDK：

npm install ali-oss --save

接入Node.js SDK。
- 提交文檔檢測任務程式碼範例
  擷取文檔檢測任務結果程式碼範例

對OSS文檔進行檢測

使用情境

執行如下命令引入相關依賴。

npm install @alicloud/green20220302@3.0.1

接入Node.js SDK。
- 提交文檔檢測任務程式碼範例
  擷取文檔檢測任務結果程式碼範例

C# SDK

原始代碼，請參見C# SDK源碼。

支援以下三種類型的文檔檢測。

對公網可訪問文檔進行檢測

使用情境

當需要審核的文檔可通過公網連結訪問時，文檔審核2.0版服務可通過文檔URL擷取檔案後進行審核。

執行如下命令引入相關依賴。

dotnet add package AlibabaCloud.SDK.Green20220302 --version 3.0.1

接入C# SDK。
- 提交文檔檢測任務程式碼範例
- 擷取文檔檢測任務結果程式碼範例

對本地文檔進行檢測

使用情境

執行如下命令引入相關依賴。

dotnet add package AlibabaCloud.SDK.Green20220302 --version 3.0.1

安裝OSS SDK：

NuGet方式安裝 
1.如果您的Visual Studio沒有安裝NuGet，請先安裝NuGet。
2.在Visual Studio中建立或者開啟已有的專案，選擇工具 > NuGet封裝管理員 > 管理解決方案的NuGet程式包。
3.搜尋aliyun.oss.sdk，在結果中找到Aliyun.OSS.SDK（適用於.NET Framework）或Aliyun.OSS.SDK.NetCore（適用於.Net Core），選擇最新版本，單擊安裝。

接入C# SDK。
- 提交文檔檢測任務程式碼範例
- 擷取文檔檢測任務結果程式碼範例

對OSS文檔進行檢測

使用情境

執行如下命令引入相關依賴。

dotnet add package AlibabaCloud.SDK.Green20220302 --version 3.0.1

接入C# SDK。
- 提交文檔檢測任務程式碼範例
- 擷取文檔檢測任務結果程式碼範例

HTTPS原生調用

調用方式
服務要求地址：https://green-cip.{region}.aliyuncs.com
協議：HTTPS
方式：POST

公用請求參數

文檔審核增強版API介面的入參數包含公用請求參數和具體介面請求參數，公用請求參數是指每一個介面都需要使用到的參數，以下表格是公用請求參數的詳細介紹。

名稱	類型	是否必須	描述
Format	String	是	返回訊息的格式。取值： JSON（預設值） XML
Version	String	是	API版本號碼，使用YYYY-MM-DD日期格式，本版本為2022-03-02。
AccessKeyId	String	是	阿里雲頒發給使用者的訪問服務所用的密鑰ID。
Signature	String	是	簽名結果串，關於簽名的計算方法，請參見下方簽名方式。
SignatureMethod	String	是	簽名方式，目前支援HMAC-SHA1。
Timestamp	String	是	請求的時間戳記。日期格式按照ISO8601標準表示，並需要使用UTC時間。格式為：yyyy-MM-ddTHH:mm:ssZ。例如，北京時間2022年12月12日09點13分14秒錶示為2022-12-12T01:13:14Z。
SignatureVersion	String	是	簽名演算法版本，取值為1.0。
SignatureNonce	String	是	唯一隨機數，用於防止網路重放攻擊。不同請求要使用不同的隨機數值。
Action	String	是	取值： FileModeration DescribeFileModerationResult

公用返回參數
您發送的每次介面調用請求，無論成功與否，系統都會返回唯一識別碼（RequestId）。其他返回參數會根據您調用的服務不同而返回不同的參數。
```
{
    "Msg": "OK",
    "Code": 200,
    "Data":
    {
        "TaskId": "AAAAA-BBBBB-CCCCCCCC"
    },
    "RequestId": "ABCD1234-1234-1234-1234-123****"
}
```

程式碼範例

以下返回樣本為了便於閱讀，做了格式化處理，實際返回結果沒有進行換行、縮排等格式化處理。

審核任務程式碼範例

請求樣本

正常返回樣本

{
    "Msg": "OK",
    "Code": 200,
    "Data":
    {
        "TaskId": "AAAAA-BBBBB-CCCCCCCC"
    },
    "RequestId": "ABCD1234-1234-1234-1234-123****"
}

查詢任務程式碼範例

請求樣本

正常返回樣本

{
    "Code": 200,
    "Data": {
        "DataId": "fileId*****",
        "PageResult": [
            {
                "ImageResult": [
                    {
                        "Description": "對文檔頁面的映像內容審核",
                        "LabelResult": [
                            {
                                "label": "nonLabel"
                            }
                        ],
                        "Service": "baselineCheck"
                    }
                ],
                "ImageUrl": "http://oss.aliyundoc.com/a.png",
                "PageNum": 1,
                "TextResult": [
                    {
                        "Description": "對文檔頁面的文字內容審核",
                        "Labels": "",
                        "RiskTips": "",
                        "RiskWords": "",
                        "Service": "pgc_detection",
                        "Text": "Alibaba Content Security Service產品測試案例a"
                    }
                ]
            },
            ...
            {
                "ImageResult": [
                    {
                        "Description": "對文檔頁面的映像內容審核",
                        "LabelResult": [
                            {
                                "Confidence": 89.01,
                                "Label": "pornographic_adultContent_tii"
                            }
                        ],
                        "Service": "baselineCheck"
                    }
                ],
                "ImageUrl": "http://oss.aliyundoc.com/b.png",
                "PageNum": 10,
                "TextResult": [
                    {
                        "Description": "對文檔頁面的文字內容審核",
                        "Labels": "contraband,sexual_content",
                        "RiskTips": "違禁_違禁商品,色情_影視資源,色情_低俗",
                        "RiskWords": "風險詞A,風險詞B",
                        "Service": "ad_compliance_detection",
                        "Text": "Alibaba Content Security Service產品測試案例b"
                    }
                ]
            }
        ],
        "Url": "http://www.aliyundoc.com/a.docx"
    },
    "Message": "SUCCESS",
    "RequestId": "1D0854A7-AAAAA-BBBBBBB-CC8292AE5"
}

簽名方式
文檔審核增強版服務會對每個訪問的請求進行身分識別驗證，因此，需要在請求中包含簽名（Signature）資訊。文檔審核增強版服務通過使用AccessKey ID和AccessKey Secret進行對稱式加密的方法來驗證請求的寄件者身份。
AccessKey ID和AccessKey Secret由阿里雲官方頒發給訪問者（可以通過阿里雲官方網站申請和管理），其中AccessKey ID用於標識訪問者身份；AccessKey Secret是用於加密簽名字串和伺服器端驗證簽名字串的密鑰，必須嚴格保密，只有阿里雲和使用者知道。
使用者在訪問時，按照下面的方法對請求進行簽名處理：
1. 使用請求參數構造正常化的請求字串（Canonicalized Query String）。
  1. 按照參數名稱的字典順序對請求中所有的請求參數（包括公用請求參數和給定了的請求介面的自訂參數，但不能包括公用請求參數中提到的Signature參數本身）進行排序。
  2. 對相關請求參數的名稱和值進行編碼。名稱和值要使用UTF-8字元集進行URL編碼。
    說明
    一般支援URL編碼的庫（比如Java中的java.net.URLEncoder）都是按照application/x-www-form-urlencoded的MIME類型的規則進行編碼的。實現時可以直接使用這類方式進行編碼，把編碼後的字串中加號（+）替換成%20、星號（*）替換成%2A、%7E替換回波浪號（~），即可得到上述規則描述的編碼字串。
    URL編碼的編碼規則如下：
    對於字元A-Z、a-z、0-9以及字元中劃線（-）、底線（_）、半形句號（.）、波浪線（~）不編碼。
    對於其它字元編碼成%XY的格式，其中XY是字元對應ASCII碼的16進位表示。比如英文的雙引號（"）對應的編碼就是%22。
    對於擴充的UTF-8字元，編碼成%XY%ZA…的格式。
    需要說明的是英文空格（）要被編碼是%20，而不是加號（+）。
  3. 對編碼後的參數名稱和值使用英文等號（=）進行串連。
  4. 將英文等號串連得到字串按參數名稱的字典順序依次使用&符號串連，即得到正常化請求字串。
2. 使用 a.i 構造的正常化字串按照下面的規則構造用於計算簽名的字串：
```
StringToSign=
HTTPMethod + "&" +
percentEncode（"/"） + "&" +
percentEncode（CanonicalizedQueryString）
```
  說明
  其中HTTPMethod是提交請求用的HTTP方法，比如POST。percentEncode（/）是按照 a.ii 中描述的URL編碼規則對字元（/）進行編碼得到的值，即%2F。percentEncode（CanonicalQueryString）是對 a.i 中構造的正常化請求字串按 a.ii 中描述的URL編碼規則編碼後得到的字串。
3. 按照RFC2104的定義，使用上面的用於簽名的字串計算簽名HMAC值。
  說明
  注意計算簽名時使用的Key就是使用者持有的AccessKey Secret並加上一個&字元（ASCII:38），使用的雜湊演算法是SHA1。
4. 按照Base64編碼規則把上面的HMAC值編碼成字串，即得到簽名值（Signature）。
5. 將得到的簽名值作為Signature參數添加到請求參數中，即完成對請求籤名的過程。
  說明
  得到的簽名值在作為最後的請求參數值提交給Alibaba Content Security Service伺服器時，要和其他參數一樣，按照RFC3986的規則進行URL編碼。