度大师OCR文字识别

HTTP接口手册

基础说明

微信图片_20240126155728.png

如上图，必须允许HTTP服务才能使用HTTP接口（默认开启）。如果需要允许被局域网访问，请将主机切换到任何可用地址。

在全局设置页中勾选高级才会显示。

由于目前的一些缺陷，如果Umi-OCR关闭时仍有用户未断开HTTP接口连接，可能导致Umi-OCR关闭不完全（UI面板和主线程结束了，但负责网络的子线程未被关闭）。这时只能等待所有用户关闭连接，或者进任务管理器删掉Umi-OCR的进程。

由于目前的一些缺陷，对并发支持较差。

Base64 接口

传入一个base64编码的图片，进行识别。

URL：/api/ocr

例：（实际端口请在全局设置中查看）

http://127.0.0.1:1224/api/ocr

请求

方法：POST

参数：json

参数名	类型	描述
base64	string	待识别图像的 Base64 编码字符串，无需前缀
options	object	【可选】配置选项字典

base64无需data:image/png;base64,等前缀，直接放正文。

options 是可选的，可以不传这个参数。如果传了，则内部的所有子参数也均为可选。注意，使用不同引擎插件时， options 的子参数可能不同，见下：

Paddle引擎插件选项：

options 子参数	类型	默认值	描述
`ocr.language`	string	`models/config_chinese.txt`	识别语言，具体见下
`ocr.cls`	boolean	`false`	是否进行图像旋转校正。`true/false`
`ocr.limit_side_len`	int	`960`	图像压缩边长。允许 `960/2880/4320/999999`
`tbpu.merge`	string	`MergeLine`	段落合并方案，具体见下

Paddle专属 ocr.language 可选项：

可选项（字符串）	对应语言
`models/config_chinese.txt`	简体中文
`models/config_en.txt`	English
`models/config_chinese_cht(v2).txt`	繁體中文
`models/config_japan.txt`	日本語
`models/config_korean.txt`	한국어
`models/config_cyrillic.txt`	Русский

通用 tbpu.merge 可选项：

可选项（字符串）	对应方案
`MergeLine`	单行
`MergePara`	多行-自然段
`MergeParaCode`	多行-代码段
`MergeLineVrl`	竖排-从右到左
`MergeLineVlr`	竖排-从左到右
`None`	不做处理

Paddle options 完整字典示例：

    "options": {        "ocr.language": "models/config_chinese.txt",        "ocr.maxSideLen": 960,        "ocr.cls": false,        "tbpu.parser": "MergeLine",
    }

Rapid引擎插件选项：

options 子参数	类型	默认值	描述
`ocr.language`	string	`简体中文`	识别语言，具体见下
`ocr.angle`	boolean	`false`	是否进行图像旋转校正。`true/false`
`ocr.maxSideLen`	int	`1024`	图像压缩边长。允许 `1024/2048/4096/999999`
`tbpu.merge`	string	`MergeLine`	段落合并方案

Rapid专属 ocr.language 可选项：

可选项（字符串）	对应语言
`简体中文`	简体中文
`English`	English
`繁體中文`	繁體中文
`日本語`	日本語
`한국어`	한국어
`Русский`	Русский

Paddle options 完整字典示例：

    "options": {        "ocr.language": "简体中文",        "ocr.maxSideLen": 1024,        "ocr.angle": false,        "tbpu.parser": "MergeLine",
    }

P2T引擎插件选项：

P2T暂时不可调整语言，支持中文+英文+数学公式混合图片。

options 子参数	类型	默认值	描述
`tbpu.merge`	string	`MergeLine`	段落合并方案

P2T options 完整字典示例：

    "options": {        "tbpu.parser": "MergeLine",
    }

响应

json

字段名	类型	描述
code	int	任务状态。`100`为成功，`101`为无文本，其余为失败
data	list/string	识别结果。`code==100`时为object，其余情况为string
time	double	识别耗时（秒）
timestamp	double	任务开始时间戳（秒）

`data` 参数

识别成功（code==100）时为列表list，列表中每项元素的组成如下。图片中无文本（code==101），或识别失败（code>101）时为string，内容为错误原因。

参数名	类型	描述
text	string	文本
score	double	置信度 (0~1)
box	list	文本框四个角的坐标

box的格式：从左上角开始，顺时针。

[左上角,右上角,右下角,左下角]

每个角为 [x, y]

例：

"data": [
    {        "text": "识别文本111",        "score": 0.99800001,        "box": [[x1,y1], [x2,y2], [x3,y3], [x4,y4]]
    },
    {        "text": "识别文本222",        "score": 0.97513333,        "box": [[x1,y1], [x2,y2], [x3,y3], [x4,y4]]
    },
]

Base64 接口示例

JavaScript 示例：

const url = 'http://127.0.0.1:1224/api/ocr';const data = {
    base64: 'iVBORw0KGgoAAAANSUhEUgAAAC4AAAAXCAIAAAD7ruoFAAAACXBIWXMAABnWAAAZ1gEY0crtAAAAEXRFWHRTb2Z0d2FyZQBTbmlwYXN0ZV0Xzt0AAAHjSURBVEiJ7ZYrcsMwEEBXnR7FLuj0BPIJHJOi0DAZ2qSsMCxEgjYrDQqJdALrBJ2ASndRgeNI8ledutOCLrLl1e7T/mRkjIG/IXe/DWBldRTNEoQSpgNURe5puiiaJehrMuJSXSTgbaby0A1WzLrCCQCmyn0FwoN0V06QONWAt1nUxfnjHYA8p65GjhDKxcjedVH6JOejBPwYh21eE0Wzfe0tqIsEkGXcVcpoMH4CRZ+P0lsQp/pWJ4ripf1XFDFe8GHSHlYcSo9Es31t60RdFlN1RUmrma5oTzTVB8ZUaeeYEC9GmL6kNkDw9BANAQYo3xTNdqUkvHq+rYhDKW0Bj3RSEIpmyWyBaZaMTCrCK+tJ5Jsa07fs3E7esE66HzralRLgJKp0/BD6fJRSxvmDsb6joqkcFXGqMVVFFEHDL2gTxwCAaTabnkFUWhDCHTd9iYrGcAL1ZnqIp5Vpiqh7bCfua7FA4qN0INMcN1+cgCzj+UFxtbmvwdZvGIrI41JiqhZBWhhF8WxorkYPpQwJiWYJeA3rXE4hzcwJ+B96F9zCFHC0FcVegghvFul7oeEE8PvHeJqC0w0AUbbFIT8JnEwGbPKcS2OxU3HMTqD0r4wgEIuiKJ7i4MS16+og8/+bPZRPLa+6Ld2DSzcAAAAASUVORK5CYII=',
    // 可选参数
    // Paddle引擎模式
    // "options": {
    //     "ocr.language": "models/config_chinese.txt",
    //     "ocr.cls": false,
    //     "ocr.limit_side_len": 960,
    //     "tbpu.parser": "MergeLine",
    // }
    // Rapid引擎模式
    // "options": {
    //     "ocr.language": "简体中文",
    //     "ocr.angle": false,
    //     "ocr.maxSideLen": 1024,
    //     "tbpu.parser": "MergeLine",
    // }};fetch(url, {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json'
        },
        body: JSON.stringify(data)
    })
    .then(response => response.json())
    .then(data => {
        console.log(data);
    })
    .catch(error => {
        console.error(error);
    });

Python 示例：

import requestsimport jsonurl = "http://127.0.0.1:1224/api/ocr"data = {    "base64": "iVBORw0KGgoAAAANSUhEUgAAAC4AAAAXCAIAAAD7ruoFAAAACXBIWXMAABnWAAAZ1gEY0crtAAAAEXRFWHRTb2Z0d2FyZQBTbmlwYXN0ZV0Xzt0AAAHjSURBVEiJ7ZYrcsMwEEBXnR7FLuj0BPIJHJOi0DAZ2qSsMCxEgjYrDQqJdALrBJ2ASndRgeNI8ledutOCLrLl1e7T/mRkjIG/IXe/DWBldRTNEoQSpgNURe5puiiaJehrMuJSXSTgbaby0A1WzLrCCQCmyn0FwoN0V06QONWAt1nUxfnjHYA8p65GjhDKxcjedVH6JOejBPwYh21eE0Wzfe0tqIsEkGXcVcpoMH4CRZ+P0lsQp/pWJ4ripf1XFDFe8GHSHlYcSo9Es31t60RdFlN1RUmrma5oTzTVB8ZUaeeYEC9GmL6kNkDw9BANAQYo3xTNdqUkvHq+rYhDKW0Bj3RSEIpmyWyBaZaMTCrCK+tJ5Jsa07fs3E7esE66HzralRLgJKp0/BD6fJRSxvmDsb6joqkcFXGqMVVFFEHDL2gTxwCAaTabnkFUWhDCHTd9iYrGcAL1ZnqIp5Vpiqh7bCfua7FA4qN0INMcN1+cgCzj+UFxtbmvwdZvGIrI41JiqhZBWhhF8WxorkYPpQwJiWYJeA3rXE4hzcwJ+B96F9zCFHC0FcVegghvFul7oeEE8PvHeJqC0w0AUbbFIT8JnEwGbPKcS2OxU3HMTqD0r4wgEIuiKJ7i4MS16+og8/+bPZRPLa+6Ld2DSzcAAAAASUVORK5CYII=",    # 可选参数
    # Paddle引擎模式
    # "options": {
    #     "ocr.language": "models/config_chinese.txt",
    #     "ocr.cls": False,
    #     "ocr.limit_side_len": 960,
    #     "tbpu.parser": "MergeLine",
    # }
    # Rapid引擎模式
    # "options": {
    #     "ocr.language": "简体中文",
    #     "ocr.angle": False,
    #     "ocr.maxSideLen": 1024,
    #     "tbpu.parser": "MergeLine",
    # }}headers = {"Content-Type": "application/json"}data_str = json.dumps(data)response = requests.post(url, data=data_str, headers=headers)if response.status_code == 200:    res_dict = json.loads(response.text)    print("返回值字典\n", res_dict)

获取可用配置接口

获取当前是什么引擎，及需要提供哪些options参数。

URL：/api/ocr/get_options

例：（实际端口请在全局设置中查看）

http://127.0.0.1:1224/api/ocr/get_options

JavaScript 示例：

const url = "http://127.0.0.1:1224/api/ocr/get_options";fetch(url, {
        method: "GET",
        headers: { "Content-Type": "application/json" },
    })
    .then(response => response.json())
    .then(data => { console.log(data); })
    .catch(error => { console.error(error); });

请求

方法：GET

响应

json

参数名	类型	描述
title	string	引擎名称
type	string	总是`group`，无意义
其余	object	描述一个配置项。

以Paddle为例：

{
  "ocr.language": {
    "title": "语言/模型库",
    "optionsList": [
      ["models/config_chinese.txt","简体中文"],
      ["models/config_en.txt","English"],
      ["models/config_chinese_cht(v2).txt","繁體中文"],
      ["models/config_japan.txt","日本語"],
      ["models/config_korean.txt","한국어"],
      ["models/config_cyrillic.txt","Русский"]
    ],
    "type": "enum",
    "default": "models/config_chinese.txt"
  },
  "ocr.cls": {
    "title": "纠正文本方向",
    "default": false,
    "toolTip": "启用方向分类，识别倾斜或倒置的文本。可能降低识别速度。",
    "type": "boolean"
  },
  "ocr.limit_side_len": {
    "title": "限制图像边长",
    "optionsList": [
      [ 960, "960 （默认）" ],
      [ 2880, "2880" ],
      [ 4320, "4320" ],
      [ 999999, "无限制" ]
    ],
    "toolTip": "将边长大于该值的图片进行压缩，可以提高识别速度。可能降低识别精度。",
    "type": "enum",
    "default": 960
  },
  "tbpu.parser": {
    "title": "段落合并",
    "default": "MergeLine",
    "optionsList": [
      [ "MergeLine", "单行" ],
      [ "MergePara", "多行-自然段" ],
      [ "MergeParaCode", "多行-代码段" ],
      [ "MergeLineVrl", "竖排-从右到左" ],
      [ "MergeLineVlr", "竖排-从左到右" ],
      [ "None", "不做处理" ]
    ]
  }
}

可以看到，当前引擎插件的名称为文字识别（PaddleOCR），拥有4个配置参数：ocr.language、ocr.cls、ocr.limit_side_len、tbpu.merge。

其中ocr.cls是布尔值，对应到UI面板中的开关。

ocr.language、ocr.limit_side_len、tbpu.merge是枚举，对应下拉栏UI。optionsList的元素的第0位是key，第1位是显示文本。当使用HTTP接口时，应该传入key值。

命令行接口

此接口用于命令行参数的跨进程传输，一般由程序内部自动调用。开发者也可手动调用。

由于此接口较敏感（如允许访问本机图片、关闭软件），故只允许本地环回 127.0.0.1 调用。局域网无法访问此接口。

URL：/argv

例：

http://127.0.0.1:1224/argv

请求

方法：POST

参数：json list

传入一个列表，列表中记录命令行参数。

如：命令行调用 Umi-OCR.exe --path "D:/xxx.png"
等价于向argv接口发送： ["--path", "D:/xxx.png"]

网站首页

在线学习

会员特权

教程资料

下载中心

AI写脚本

度大师OCR文字识别

HTTP接口手册

基础说明

Base64 接口

请求

Paddle引擎插件选项：

Rapid引擎插件选项：

P2T引擎插件选项：

响应

`data` 参数

Base64 接口示例

获取可用配置接口

请求

响应

命令行接口

请求

网站首页

在线学习

会员特权

教程资料

下载中心

AI写脚本

度大师OCR文字识别

HTTP接口手册

基础说明

Base64 接口

请求

Paddle引擎插件 选项：

Rapid引擎插件 选项：

P2T引擎插件 选项：

响应

data 参数

Base64 接口示例

获取可用配置 接口

请求

响应

命令行 接口

请求

友情链接

Paddle引擎插件选项：

Rapid引擎插件选项：

P2T引擎插件选项：

`data` 参数

获取可用配置接口

命令行接口