文本提取工具使用指南

注意：在学习使用不同函数之前，建议先阅读请求描述，了解基本的PDF处理流程。使用不同函数时，可以在上传文件时设置各自的特殊参数。其他基本步骤一致。

文本提取：

java

{    
  "ocrRecognitionLang": "AUTO",
  "outputFormat": 1
}

所需参数：

ocrRecognitionLang：OCR识别语言，支持的类型和定义：

AUTO: 自动，CHINESE: 中文简体，CHINESE_TRAD: 中文繁体，ENGLISH: 英语，KOREAN: 韩语，JAPANESE: 日语，LATIN: 拉丁语，DEVANAGARI: 梵文，CYRILLIC: 西里尔语，ARABIC: 阿拉伯语，TAMIL: 泰米尔语，TELUGU: 泰卢固语，KANNADA: 卡纳达语；默认 AUTO。

outputFormat: 输出格式，1：json 、2：txt。

请求示例：

您需要将 apiKey 替换为您从控制台获取的 publicKey ，将 file 替换为您要转换的文件，language 替换为您想要的接口错误提示语言类型。

curljava

curl

curl --location --request POST 'https://api-server.compdf.com/server/v2/process/documentAI/ocr' \
--header 'x-api-key: apiKey' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--header 'Content-Type: multipart/form-data' \
--form 'file=@"file"' \
--form 'password="" \
--form 'parameter="{  \"ocrRecognitionLang\": \"AUTO\"  }"' \
--form 'language="1"'

java

import java.io.*;
import okhttp3.*;
public class main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    MediaType mediaType = MediaType.parse("text/plain");
    RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
      .addFormDataPart("file","{{file}}",
 RequestBody.create(MediaType.parse("application/octet-stream"),
                                          new File("<file>")))
      .addFormDataPart("language","{{language}}")
      .addFormDataPart("password","")
      .addFormDataPart("parameter","{    \"ocrRecognitionLang\": \"AUTO\"    }") 
      .build();
    Request request = new Request.Builder()
      .url("https://api-server.compdf.com/server/v2/process/documentAI/ocr")
      .method("POST", body)
      .addHeader("x-api-key", "{{apiKey}}")
      .build();
    Response response = client.newCall(request).execute();
  }
}

响应信息：

请求的成功响应返回 HTTP 200 OK 状态代码以及显示订单详细信息的 JSON 响应主体。

响应模式：application/json

响应参数	数据类型	描述
code	String	HTTP请求状态，"200"代表成功
message	String	请求信息
data	Object	返回结果
+taskId	String	任务ID
+taskFileNum	int	任务处理文件数量
+taskSuccessNum	int	任务处理文件成功数量
+taskFailNum	int	任务处理文件失败数量
+taskStatus	String	任务状态
+assetTypeId	int	使用资产类型ID
+taskCost	int	任务费用
+taskTime	int	任务持续时间
+sourceType	String	原格式
+targetType	String	目标格式
+fileInfoDTOList	Array	任务文件信息
++fileKey	String	文件key
++taskId	String	任务ID
++fileName	String	原文件名
++downFileName	String	下载文件名
++fileUrl	String	原文件地址
++downloadUrl	String	处理结果文件下载地址
++sourceType	String	原格式
++targetType	String	目标格式
++fileSize	int	文件大小
++convertSize	int	处理结果文件大小
++convertTime	int	处理消耗时间
++status	String	文件处理状态
++failureCode	String	文件处理失败错误码
++failureReason	String	文件处理失败说明
++fileParameter	String	处理参数

响应示例：

json

"code": "200",
"msg": "success",
"data": {
    "taskId": "f416dbcf-0c10-4f93-ab9e-a835c1f5dba1",
    "taskFileNum": 1,
    "taskSuccessNum": 1,
    "taskFailNum": 0,
    "taskStatus": "<taskStatus>",
    "assetTypeId": 0,
    "taskCost": 1,
    "taskTime": 1,
    "sourceType": "<sourceType>",
    "targetType": "<targetType>",
    "fileInfoDTOList": [
      {
        "fileKey": "<fileKey>",
        "taskId": "<taskId>",
        "fileName": "<fileName>",
        "downFileName": "<downFileName>",
        "fileUrl": "<fileUrl>",
        "downloadUrl": "<downloadUrl>",
        "sourceType": "<sourceType>",
        "targetType": "<targetType>",
        "fileSize": 24475,
        "convertSize": 6922,
        "convertTime": 8,
        "status": "<status>",
        "failureCode": "",
        "failureReason": "",
        "fileParameter": "<fileParameter>"
      }
    ]
}

结果：

文件类型	说明
.JSON	OCR 识别结果

JSON内容解释

参数	说明
cost	OCR 识别时间
boxes	输入图片所有检测到的物体框位置
text	OCR 识别内容
rec_scores	OCR 文本识别分数，分数越高，结果越可信

JSON结构示例：

json

{
        "cost": 149,
        "boxes": [
            [
                150,
                71,
                198,
                71,
                198,
                110,
                150,
                110
            ],
            [
                74,
                117,
                274,
                120,
                273,
                166,
                73,
                163
            ],
            [
                99,
                179,
                249,
                182,
                249,
                208,
                99,
                205
            ],
            [
                65,
                203,
                276,
                205,
                276,
                230,
                65,
                228
            ]
        ],
        "text": [
            "EPPING",
            "Twinned with",
            "Eppingen,Germany"
        ],
        "rec_scores": [
            0.46275457739830017,
            0.9971449971199036,
            0.9649983048439026,
            0.9587073922157288
        ]
}

异步请求

如果您需要使用文件异步处理流程，请阅读异步请求说明。

文本提取工具使用指南 ​

文本提取工具使用指南