文档

文件审核

更新时间:

本文介绍如何使用Java SDK文件审核接口,检测文件中的文本和图片信息。

功能描述

文件审核目前只支持异步检测(异步检测不会实时返回检测结果)任务。关于参数的详细说明,请参见文件异步检测

功能项

文件检测

支持检测图片所在的文件格式

支持DOC、DOCX、PPT、PPTX、PDF、XLS、XLSX、TXT格式

检测图片中的文字

支持

文件大小限制

200 MB

同时检测文件的数量

10路

近线检测模式(用于批量文件检测)

支持

其他

  • 支持开启或关闭检测图片

  • 支持指定最多检测的文件页数

前提条件

  • 安装Java依赖。关于安装Java依赖的具体操作,请参见安装Java依赖

    说明

    请一定按照安装Java依赖页面中的版本安装,否则会导致调用失败。

  • 如果使用本地文件或者二进制文件检测,请下载并在项目工程中引入Extension.Uploader工具类

提交文件异步检测任务

接口

描述

支持的地域

FileAsyncScanV2Request

提交文件异步检测任务,对文件中的文本和图片进行检测。

  • cn-shanghai:华东2(上海)

  • cn-beijing:华北2(北京)

示例代码

package demo;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONObject;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.green.model.v20180509.FileAsyncScanV2Request;
import com.aliyuncs.http.FormatType;
import com.aliyuncs.http.HttpResponse;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;
import org.apache.commons.codec.binary.StringUtils;

import java.util.Arrays;

public class FileAsyncScanV2Demo {

    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");
         */
        DefaultProfile profile = DefaultProfile.getProfile(
                "cn-shanghai",
                "建议从环境变量中获取RAM用户AccessKey ID",
                "建议从环境变量中获取RAM用户AccessKey Secret");
        DefaultProfile.addEndpoint("cn-shanghai", "Green", "green.cn-shanghai.aliyuncs.com");
        // 注意:此处实例化的client尽可能重复使用,提升检测性能。避免重复建立连接。
        IAcsClient client = new DefaultAcsClient(profile);

        FileAsyncScanV2Request fileAsyncScanV2Request = new FileAsyncScanV2Request();
        fileAsyncScanV2Request.setAcceptFormat(FormatType.JSON);
        fileAsyncScanV2Request.setMethod(com.aliyuncs.http.MethodType.POST);
        fileAsyncScanV2Request.setEncoding("UTF-8");

        JSONObject data = new JSONObject();
        data.put("modType", "All");
        data.put("maxPages", 200);
        data.put("offline", true);
        data.put("bizType", "aligreen_default_bizType");

        JSONObject task = new JSONObject();
        task.put("url", "待检测文件地址");
        data.put("tasks", Arrays.asList(task));

        fileAsyncScanV2Request.setHttpContent(StringUtils.getBytesUtf8(data.toJSONString()), "UTF-8", FormatType.JSON);

        fileAsyncScanV2Request.setConnectTimeout(3000);
        fileAsyncScanV2Request.setReadTimeout(10000);
        HttpResponse httpResponse = null;
        try {
            httpResponse = client.doAction(fileAsyncScanV2Request);
            if (httpResponse.isSuccess()) {
                JSONObject responseObj = JSON.parseObject(new String(httpResponse.getHttpContent(), "UTF-8"));
                int responseCode = responseObj.getIntValue("code");
                // 每一个文件的检测结果。
                JSONArray taskResults = responseObj.getJSONArray("data");
                if (200 == responseCode) {
                    for (Object taskResult : taskResults) {
                        // 单个文件的处理结果。
                        int taskCode = ((JSONObject) taskResult).getIntValue("code");
                        if (200 == taskCode) {
                            // 保存taskId用于轮询结果。
                            System.out.println(((JSONObject) taskResult).getString("taskId"));
                        }
                    }
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

获取文件异步检测任务结果

接口

描述

支持的Region

FileAsyncScanResultsRequest

获取文件异步检测结果。

  • cn-shanghai:华东2(上海)

  • cn-beijing:华北2(北京)

示例代码

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONObject;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.green.model.v20180509.FileAsyncScanResultsRequest;
import com.aliyuncs.http.FormatType;
import com.aliyuncs.http.HttpResponse;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;

import java.util.Arrays;

public class Main {

    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");
         */
        DefaultProfile profile = DefaultProfile.getProfile(
                "cn-shanghai",
                "建议从环境变量中获取RAM用户AccessKey ID",
                "建议从环境变量中获取RAM用户AccessKey Secret");
        DefaultProfile.addEndpoint("cn-shanghai", "Green", "green.cn-shanghai.aliyuncs.com");
        // 注意:此处实例化的client尽可能重复使用,提升检测性能。避免重复建立连接。
        IAcsClient client = new DefaultAcsClient(profile);

        FileAsyncScanResultsRequest fileAsyncScanResultsRequest = new FileAsyncScanResultsRequest();
        // 指定API返回格式。
        fileAsyncScanResultsRequest.setAcceptFormat(FormatType.JSON);
        // 指定请求方法。
        fileAsyncScanResultsRequest.setMethod(com.aliyuncs.http.MethodType.POST);
        fileAsyncScanResultsRequest.setEncoding("utf-8");

        JSONObject data = new JSONObject();
        data.put("taskIds", Arrays.asList("文件审核任务ID"));

        fileAsyncScanResultsRequest.setHttpContent(org.apache.commons.codec.binary.StringUtils.getBytesUtf8(data.toJSONString()),
                "UTF-8", FormatType.JSON);

        /**
         * 请设置超时时间, 服务端全链路处理超时时间为10秒,请做相应设置。
         * 如果您设置的ReadTimeout小于服务端处理的时间,程序中会获得一个ReadTimeout异常。
         */
        fileAsyncScanResultsRequest.setConnectTimeout(3000);
        fileAsyncScanResultsRequest.setReadTimeout(10000);
        HttpResponse httpResponse = null;
        try {
            httpResponse = client.doAction(fileAsyncScanResultsRequest);
            if (httpResponse.isSuccess()) {
                JSONObject scrResponse = JSON.parseObject(new String(httpResponse.getHttpContent(), "UTF-8"));
                System.out.println(JSON.toJSONString(scrResponse, true));
                int requestCode = scrResponse.getIntValue("code");
                // 每一个文件的检测结果。
                JSONArray taskResults = scrResponse.getJSONArray("data");
                if (200 == requestCode) {
                    for (Object taskResult : taskResults) {
                        // 单个文件的处理结果。
                        int taskCode = ((JSONObject) taskResult).getIntValue("code");
                        if (200 == taskCode) {
                            // taskId。
                            System.out.println(((JSONObject) taskResult).getString("taskId"));
                            // 传入textScenes时的文本扫描结果。
                            JSONArray textResults = ((JSONObject) taskResult).getJSONArray("textResults");
                            // 传入imageScenes时的图片扫描结果。
                            JSONArray imageResults = ((JSONObject) taskResult).getJSONArray("imageResults");
                        } else {
                            // 单个视频处理失败,原因视具体的情况详细分析。
                            System.out.println("task process fail. task response:" + JSON.toJSONString(taskResult));
                        }
                    }
                } else {
                    /**
                     * 表明请求整体处理失败,原因视具体的情况详细分析。
                     */
                    System.out.println("the whole scan request failed. response:" + JSON.toJSONString(scrResponse));
                }
            } else {
                System.out.println("response not success. status:" + httpResponse.getStatus());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
  • 本页导读 (0)
文档反馈