增加相似图样本

本文介绍了如何使用Java SDK,将指定的相似图图片添加到对应图库。

功能描述

添加相似图样本时,您可以为图片设置标签。如果样本图片在检索时被命中,其标签信息也会被返回。关于参数的详细说明,请参见增加样本图片API文档

您需要使用内容安全的API接入地址,调用本SDK接口。关于API接入地址的信息,请参见接入地址(Endpoint)

前提条件

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

    说明

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

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

传入URL示例代码

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.AddSimilarityImageRequest; 
import com.aliyuncs.http.FormatType;
import com.aliyuncs.http.HttpResponse;
import com.aliyuncs.http.MethodType;
import com.aliyuncs.http.ProtocolType;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;

import java.util.*;

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");
        IAcsClient client = new DefaultAcsClient(profile);

        AddSimilarityImageRequest addSimilarityImageRequest = new AddSimilarityImageRequest();
        // 指定API返回格式、请求方法。
        addSimilarityImageRequest.setAcceptFormat(FormatType.JSON);
        addSimilarityImageRequest.setMethod(MethodType.POST);
        addSimilarityImageRequest.setEncoding("utf-8");
        addSimilarityImageRequest.setProtocol(ProtocolType.HTTP);

        JSONObject httpBody = new JSONObject();
        /**
         * 一次请求中可以同时添加多张图片(最大20张/次),
         * 计费按照单张图片添加的单价×添加的图片数量计算。
         */
        JSONObject task = new JSONObject();
        task.put("dataId", UUID.randomUUID().toString());
        // 添加图片。
        task.put("url", "https://example.com/feed/xxx");
        // 添加最多3个自定义标签(非必须)。
        JSONArray tags = new JSONArray();
        tags.add("自定义标签1");
        tags.add("自定义标签2");
        tags.add("自定义标签3");
        task.put("tag", tags);
        httpBody.put("tasks", Arrays.asList(task));

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

        /**
         * 请设置超时时间,服务端全链路处理超时时间为10秒,请做相应设置。
         * 如果您设置的ReadTimeout小于服务端处理的时间,程序中会获得一个ReadTimeout异常。
         */
        addSimilarityImageRequest.setConnectTimeout(3000);
        addSimilarityImageRequest.setReadTimeout(10000);
        HttpResponse httpResponse = null;
        try {
            httpResponse = client.doAction(addSimilarityImageRequest);
        } catch (Exception e) {
            e.printStackTrace();
        }

        // 服务端接收到请求,并完成处理返回的结果。
        if (httpResponse != null && httpResponse.isSuccess()) {
            JSONObject scrResponse = JSON.parseObject(org.apache.commons.codec.binary.StringUtils.newStringUtf8(httpResponse.getHttpContent()));
            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) {
                        System.out.println("成功添加1张图片 "); 
                    } else {
                        // 单张图片处理失败,原因是具体的情况详细分析。
                        System.out.println("task process fail. task response:" + JSON.toJSONString(taskResult));
                    }
                }
            } else {
                /**
                 * 表明请求整体处理失败,原因视具体的情况详细分析。
                 */
                System.out.println("the whole image scan request failed. response:" + JSON.toJSONString(scrResponse));
            }
        }
    }

}

传入本地文件示例代码

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.extension.uploader.ClientUploader;
import com.aliyuncs.green.model.v20180509.AddSimilarityImageRequest; 
import com.aliyuncs.http.FormatType;
import com.aliyuncs.http.HttpResponse;
import com.aliyuncs.http.MethodType;
import com.aliyuncs.http.ProtocolType;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;

import java.util.*;

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");
        IAcsClient client = new DefaultAcsClient(profile);

        AddSimilarityImageRequest addSimilarityImageRequest = new AddSimilarityImageRequest();
        // 指定API返回格式、请求方法。
        addSimilarityImageRequest.setAcceptFormat(FormatType.JSON);
        addSimilarityImageRequest.setMethod(MethodType.POST);
        addSimilarityImageRequest.setEncoding("utf-8");
        addSimilarityImageRequest.setProtocol(ProtocolType.HTTP);

        JSONObject httpBody = new JSONObject();
        /**
         * 一次请求中可以同时添加多张图片(最大20张/次),
         * 计费按照单张图片添加的单价×添加的图片数量计算。
         */
        JSONObject task = new JSONObject();
        task.put("dataId", UUID.randomUUID().toString());
         /**
         * 如果您要检测的文件存于本地服务器上,可以通过下述代码片生成URL。
         * 再将返回的URL作为图片地址传递到服务端。
         */
        String url = null;
        ClientUploader clientUploader = ClientUploader.getImageClientUploader(profile, false);
        try{
            url = clientUploader.uploadFile("d:/test.jpg");
        }catch (Exception e){
            e.printStackTrace();
        } 
        task.put("url", url);
        // 添加最多3个自定义标签(非必须)。
        JSONArray tags = new JSONArray();
        tags.add("自定义标签1");
        tags.add("自定义标签2");
        tags.add("自定义标签3");
        task.put("tag", tags);
        httpBody.put("tasks", Arrays.asList(task));

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

        /**
         * 请设置超时时间,服务端全链路处理超时时间为10秒,请做相应设置。
         * 如果您设置的ReadTimeout小于服务端处理的时间,程序中会获得一个ReadTimeout异常。
         */
        addSimilarityImageRequest.setConnectTimeout(3000);
        addSimilarityImageRequest.setReadTimeout(10000);
        HttpResponse httpResponse = null;
        try {
            httpResponse = client.doAction(addSimilarityImageRequest);
        } catch (Exception e) {
            e.printStackTrace();
        }

        // 服务端接收到请求,并完成处理返回的结果。
        if (httpResponse != null && httpResponse.isSuccess()) {
            JSONObject scrResponse = JSON.parseObject(org.apache.commons.codec.binary.StringUtils.newStringUtf8(httpResponse.getHttpContent()));
            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) {
                        System.out.println("成功添加1张图片 "); 
                    } else {
                        // 单张图片处理失败,原因是具体的情况详细分析。
                        System.out.println("task process fail. task response:" + JSON.toJSONString(taskResult));
                    }
                }
            } else {
                /**
                 * 表明请求整体处理失败,原因视具体的情况详细分析。
                 */
                System.out.println("the whole image scan request failed. response:" + JSON.toJSONString(scrResponse));
            }
        }
    }

}