通用OCR(算法编码：8000400005)

接口信息

API Path
/aipaas/ocr/v1/identify/generalOcr

请求协议
HTTPS

请求方法
POST

请求头部：

头部标签	必填	说明	类型	数据字典	限制	头部内容	示例
Content-Type	是	application/json	[string]			application/json	application/json
X-APP-ID	是	买家中心-已购能力-【X-APP-ID】	[string]
Device-Uuid	否	设备管理-设备uuid	[string]
Authorization	是	鉴权信息	[string]

请求参数 Json
Object

参数名	说明	必填	类型	数据字典	限制	示例
seqid	请求序列号，请求的唯一标识，不能为空字符	是	[string]
image	图片的base64编码，大小不超过5M、分辨率不超过3840*3840	是	[string]
html_escape	默认值为True，用于解决xss漏洞，值为True时对识别出的文本做html转义，上层调用不用担心xss漏洞问题，值为False时识别出的文本原样输出，上层调用方如果需要把识别结果展示在web页面上需要自己修复xss漏洞问题	否	[boolean]

响应内容：

返回结果

> 成功 (200)
> Json
> Object

参数名	说明	必填	类型	数据字典	限制	示例
seqid	请求序列号，usid，请求的唯一标识，透传	是	[string]
code	状态响应码	是	[string]
message	调用结果描述	是	[string]
flag	业务上成功或失败：1成功，0失败	是	[int]
data		是	[object]
data>>timeSecond	分析耗时，单位：秒	是	[int]
data>>words_result	list[string]；一次输出所有结果，如果识别失败，或者图片中本身就没有文字会返回 [] 返回的数组的长度为1 或0	是	[array]

成功示例[Mock API]：

{
    "seqid": "zhongpingjushi",
    "code": "10000",
    "message": "成功",
    "flag": "1",
    "data": {
        "timeSecond": 1,
        "words_result": ["测试"]
    }
}

详细说明：

1. 功能简介

通用OCR文本识别算法，输入图片，算法对图片进行解析，输出文本。

2. 修订历史

日期	版本	修订内容
2025-05-20	v1.6.5.6	初始化API文档

3. 服务鉴权

服务接口调用时需要严格遵循服务鉴权规则，服务调用鉴权规则请参见：开发指南 - 签名认证方式。

4. 状态码说明

返回编码	返回信息	说明
10000	服务执行成功	正确执行并返回结果
10301	服务必填参数缺失	服务必填参数缺失
10304	请求参数格式错误	服务入参格式错误，输入图片格式需为base64位编码的数据
10305	请求参数范围错误	上传的图片大小错误，现阶段我们支持的图片大小为：base64编码后小于5M，请重新上传图片
10503	服务连接超时	连接第三方服务发生超时时，返回服务连接超时错误
10903	服务执行失败	服务执行失败

通用状态码请参考【状态码】中的【网关认证】

5. 请求参数示例

{
    "seqid": "test_seq0",
    "image": "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgK===",
    "html_escape": true
}

6. 调用示例

6.1 Java版本

import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpResponse;
import cn.hutool.json.JSONUtil;

import java.util.HashMap;
import java.util.Map;

/** 主类，用于发起HTTP请求并处理响应 */
public class Example {

    public static void main(String[] args) {
        example();
    }

    /**
     * 方法中使用到的 JSONUtil、HttpRequest、HttpResponse均来自Hutool工具类。
     * 具体maven依赖为：
     * 
     *     cn.hutool
     *     hutool-all
     *     5.8.29
     * 
     */
    public static void example() {
        try {
            String url = "算法调用地址";
            // 设置请求头
            Map headers = new HashMap();
            //调用鉴权
            headers.put("Content-Type", "application/json");
            headers.put("X-APP-ID", "yourAppId");
            headers.put("Authorization", "yourAuthorization");
		
            // 创建请求对象
            Map request = new HashMap();
            request.put("seqid", "123");
            request.put("image", "图片base64");
            request.put("html_escape", true);
            // 将请求对象转换为JsonNode
            String requestString = JSONUtil.toJsonStr(request);

            // 发起HTTP请求
            HttpResponse response =
                    HttpRequest.post(url)
                            .headerMap(headers, true)
                            .body(requestString)
                            .execute();
            // 输出响应结果
            System.out.println(response.body());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

6.2 Python版本

import json
import hashlib
import hmac
import time
import re
import urllib.parse
import requests
import warnings
from datetime import datetime
import logging

# 配置日志，设置日志级别为INFO，并指定日志格式
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')

# 配置环境变量
X_APP_ID = "yourAppId"
AUTHORIZATION = "yourAuthorization"

# URL 和请求数据
url = "算法调用地址"  # 请求的URL
request_data = {
    "seqid": "123",
    "image": "图片base64",
    "html_escape": true
}

# 构建请求头
headers = {
    "Content-Type": "application/json",
    "X-APP-ID": X_APP_ID,
    "Authorization": AUTHORIZATION
}


def timeSimple(timestamp):
    # 将时间戳转换为HH:MM:SS格式的时间字符串
    dt_object = datetime.fromtimestamp(timestamp)
    formatted_time = dt_object.strftime("%H:%M:%S")
    return formatted_time


def send_request(url):
    try:
        start_time = time.time()
        logging.info(f"请求路径: {url}")
        logging.info(f"开始发送: {timeSimple(start_time)}")

        with requests.post(
            url, json=request_data, headers=headers, stream=True, verify=False
        ) as response:
            first_packet_time = None
            if response.status_code == 200:
                logging.info(f"接受到返回: {timeSimple(time.time())}")

                for chunk in response.iter_content(chunk_size=1024):
                    if chunk:
                        if first_packet_time is None:
                            first_packet_time = time.time()
                        logging.info(
                            f"Received chunk: {timeSimple(time.time())} {chunk.decode('utf-8')}"
                        )

                end_time = time.time()
                logging.info(f"Time to first byte (TTFB): {first_packet_time - start_time:.3f} seconds")
                logging.info(f"Request completed in {end_time - start_time:.3f} seconds")
            else:
                logging.error(f"Request failed with status code {response.status_code}")
    except Exception as e:
        logging.error(f"An error occurred: {e}")


# 发送请求
send_request(url)
logging.info(f"headers = {headers}")