Merge pull request #221 from 563750789/master

update CI demo

Author: 563750789

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.qcloud</groupId>
     <artifactId>cos_api</artifactId>
-    <version>5.6.231</version>
+    <version>5.6.233</version>
     <packaging>jar</packaging>
     <name>cos-java-sdk</name>
     <description>java sdk for qcloud cos</description>

src/main/java/com/qcloud/cos/COS.java

@@ -3293,6 +3293,8 @@ SelectObjectContentResult selectObjectContent(SelectObjectContentRequest selectR
     UpdateFileMetaIndexResponse updateFileMetaIndex(UpdateFileMetaIndexRequest customRequest);
 
     MediaTemplateResponseV2 createMediaTemplateV2(MediaTemplateRequestV2 request);
+
+    ImageOCRResponse imageOCR(ImageOCRRequest request);
 }
 
 

src/main/java/com/qcloud/cos/COSClient.java

@@ -5333,6 +5333,20 @@ public MediaTemplateResponseV2 createMediaTemplateV2(MediaTemplateRequestV2 temp
         return invoke(request, new Unmarshallers.CICommonUnmarshaller<MediaTemplateResponseV2>(MediaTemplateResponseV2.class));
     }
 
+    @Override
+    public ImageOCRResponse imageOCR(ImageOCRRequest ocrRequest) {
+        CosHttpRequest<ImageOCRRequest> request = createRequest(ocrRequest.getBucketName(), ocrRequest.getObjectKey(), ocrRequest, HttpMethodName.GET);
+        request.addParameter("ci-process","OCR");
+        addParameterIfNotNull(request, "detect-url", ocrRequest.getDetectUrl());
+        addParameterIfNotNull(request, "type", ocrRequest.getType());
+        addParameterIfNotNull(request, "language-type", ocrRequest.getLanguageType());
+        addParameterIfNotNull(request, "ispdf", String.valueOf(ocrRequest.getPdf()));
+        addParameterIfNotNull(request, "pdf-pagenumber", ocrRequest.getPdfPageNumber());
+        addParameterIfNotNull(request, "isword", String.valueOf(ocrRequest.getWord()));
+        addParameterIfNotNull(request, "enable-word-polygon", String.valueOf(ocrRequest.getEnableWordPolygon()));
+        return invoke(request, new Unmarshallers.CICommonUnmarshaller<ImageOCRResponse>(ImageOCRResponse.class));
+    }
+
     public String generateCosDomainPrivateM3U8Url(PrivateM3U8Request privateM3U8Request) {
         CosHttpRequest<PrivateM3U8Request> request = createRequest(privateM3U8Request.getBucketName(), privateM3U8Request.getObject(), privateM3U8Request, HttpMethodName.GET);
         request.addParameter("ci-process","pm3u8");

src/main/java/com/qcloud/cos/demo/ci/OcrDemo.java

@@ -0,0 +1,41 @@
+package com.qcloud.cos.demo.ci;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.qcloud.cos.COSClient;
+import com.qcloud.cos.model.ciModel.ai.ImageOCRRequest;
+import com.qcloud.cos.model.ciModel.ai.ImageOCRResponse;
+import com.qcloud.cos.utils.Jackson;
+
+import java.io.UnsupportedEncodingException;
+
+/**
+ * OCR 同步请求demo https://cloud.tencent.com/document/product/460/63227
+ */
+public class OcrDemo {
+
+    public static void main(String[] args) throws JsonProcessingException, UnsupportedEncodingException {
+        // 1 初始化用户身份信息（secretId, secretKey）。
+        COSClient client = ClientUtils.getTestClient();
+        // 2 调用要使用的方法。
+        imageOCR(client);
+    }
+
+    /**
+     * imageOCR 通用文字识别功能（Optical Character Recognition，OCR）
+     * 基于行业前沿的深度学习技术，将图片上的文字内容，智能识别为可编辑的文本
+     * 可应用于随手拍扫描、纸质文档电子化、电商广告审核等多种场景，大幅提升信息处理效率。
+     */
+    public static void imageOCR(COSClient client)  {
+        //1.创建任务请求对象
+        ImageOCRRequest request = new ImageOCRRequest();
+        //2.添加请求参数 参数详情请见api接口文档
+        request.setBucketName("demo-1234567890");
+        //2.1设置图片位置或直接传入图片的url
+        request.setObjectKey("1.jpg");
+//        request.setDetectUrl("https://demo-123456789.cos.ap-chongqing.myqcloud.com/1.png");
+        //3.调用接口,获取任务响应对象
+        ImageOCRResponse response = client.imageOCR(request);
+        System.out.println(Jackson.toJsonString(response));
+    }
+
+}

src/main/java/com/qcloud/cos/model/ciModel/ai/ImageOCRRequest.java

@@ -0,0 +1,87 @@
+package com.qcloud.cos.model.ciModel.ai;
+
+import com.qcloud.cos.internal.CosServiceRequest;
+
+public class ImageOCRRequest extends CosServiceRequest {
+    private String bucketName;
+    private String objectKey; // 对象文件名，例如：folder/document.jpg
+    private String detectUrl; // 处理的图片链接
+    private String type; // ocr 的识别类型
+    private String languageType; // 识别语言类型
+    private Boolean isPdf = false; // 是否开启 PDF 识别
+    private Integer pdfPageNumber = 1; // 需要识别的 PDF 页面的对应页码
+    private Boolean isWord = false; // 是否需要返回单字信息
+    private Boolean enableWordPolygon = false; // 是否开启单字的四点定位坐标输出
+
+    public String getBucketName() {
+        return bucketName;
+    }
+
+    public void setBucketName(String bucketName) {
+        this.bucketName = bucketName;
+    }
+
+    public String getObjectKey() {
+        return objectKey;
+    }
+
+    public void setObjectKey(String objectKey) {
+        this.objectKey = objectKey;
+    }
+
+    public String getDetectUrl() {
+        return detectUrl;
+    }
+
+    public void setDetectUrl(String detectUrl) {
+        this.detectUrl = detectUrl;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public void setType(String type) {
+        this.type = type;
+    }
+
+    public String getLanguageType() {
+        return languageType;
+    }
+
+    public void setLanguageType(String languageType) {
+        this.languageType = languageType;
+    }
+
+    public Boolean getPdf() {
+        return isPdf;
+    }
+
+    public void setPdf(Boolean pdf) {
+        isPdf = pdf;
+    }
+
+    public Integer getPdfPageNumber() {
+        return pdfPageNumber;
+    }
+
+    public void setPdfPageNumber(Integer pdfPageNumber) {
+        this.pdfPageNumber = pdfPageNumber;
+    }
+
+    public Boolean getWord() {
+        return isWord;
+    }
+
+    public void setWord(Boolean word) {
+        isWord = word;
+    }
+
+    public Boolean getEnableWordPolygon() {
+        return enableWordPolygon;
+    }
+
+    public void setEnableWordPolygon(Boolean enableWordPolygon) {
+        this.enableWordPolygon = enableWordPolygon;
+    }
+}

src/main/java/com/qcloud/cos/model/ciModel/ai/ImageOCRResponse.java

@@ -0,0 +1,55 @@
+package com.qcloud.cos.model.ciModel.ai;
+
+import com.qcloud.cos.model.CosServiceResult;
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamImplicit;
+
+import java.util.List;
+
+@XStreamAlias("Response")
+public class ImageOCRResponse extends CosServiceResult {
+
+    @XStreamImplicit(itemFieldName = "TextDetections")
+    private List<TextDetection> textDetections; // 检测到的文本信息
+
+    @XStreamAlias("Language")
+    private String language; // 检测到的语言类型
+
+    @XStreamAlias("Angel")
+    private Float angel; // 图片旋转角度
+
+    @XStreamAlias("PdfPageSize")
+    private Integer pdfPageSize; // PDF的总页数
+
+    public List<TextDetection> getTextDetections() {
+        return textDetections;
+    }
+
+    public void setTextDetections(List<TextDetection> textDetections) {
+        this.textDetections = textDetections;
+    }
+
+    public String getLanguage() {
+        return language;
+    }
+
+    public void setLanguage(String language) {
+        this.language = language;
+    }
+
+    public Float getAngel() {
+        return angel;
+    }
+
+    public void setAngel(Float angel) {
+        this.angel = angel;
+    }
+
+    public Integer getPdfPageSize() {
+        return pdfPageSize;
+    }
+
+    public void setPdfPageSize(Integer pdfPageSize) {
+        this.pdfPageSize = pdfPageSize;
+    }
+}

src/main/java/com/qcloud/cos/model/ciModel/ai/ItemPolygon.java

@@ -0,0 +1,28 @@
+package com.qcloud.cos.model.ciModel.ai;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+
+public class ItemPolygon extends OcrPolygon{
+
+    @XStreamAlias("Width")
+    private Integer width; // 宽
+
+    @XStreamAlias("Height")
+    private Integer height; // 高
+
+    public Integer getWidth() {
+        return width;
+    }
+
+    public void setWidth(Integer width) {
+        this.width = width;
+    }
+
+    public Integer getHeight() {
+        return height;
+    }
+
+    public void setHeight(Integer height) {
+        this.height = height;
+    }
+}

src/main/java/com/qcloud/cos/model/ciModel/ai/OcrPolygon.java

@@ -0,0 +1,27 @@
+package com.qcloud.cos.model.ciModel.ai;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+
+public class OcrPolygon {
+    @XStreamAlias("X")
+    private Integer x; // 横坐标
+
+    @XStreamAlias("Y")
+    private Integer y; // 纵坐标
+
+    public Integer getX() {
+        return x;
+    }
+
+    public void setX(Integer x) {
+        this.x = x;
+    }
+
+    public Integer getY() {
+        return y;
+    }
+
+    public void setY(Integer y) {
+        this.y = y;
+    }
+}

src/main/java/com/qcloud/cos/model/ciModel/ai/OcrWord.java

@@ -0,0 +1,41 @@
+package com.qcloud.cos.model.ciModel.ai;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamImplicit;
+
+import java.util.List;
+
+public class OcrWord {
+    @XStreamAlias("Confidence")
+    private Integer confidence; // 置信度 0 ~ 100
+
+    @XStreamAlias("Character")
+    private String character; // 候选字
+
+    @XStreamImplicit(itemFieldName = "WordCoordPoint")
+    private List<OcrPolygon> wordCoordPoint; // 单字在原图
+
+    public Integer getConfidence() {
+        return confidence;
+    }
+
+    public void setConfidence(Integer confidence) {
+        this.confidence = confidence;
+    }
+
+    public String getCharacter() {
+        return character;
+    }
+
+    public void setCharacter(String character) {
+        this.character = character;
+    }
+
+    public List<OcrPolygon> getWordCoordPoint() {
+        return wordCoordPoint;
+    }
+
+    public void setWordCoordPoint(List<OcrPolygon> wordCoordPoint) {
+        this.wordCoordPoint = wordCoordPoint;
+    }
+}