在不同的情况下（比如使用不同的OCR引擎插件），图片识别接口可以传入不同的参数。
通过【参数查询接口】，可以获取所有参数的定义、默认值、可选值等信息。
你可以手动调用查询接口来确认信息，也可以通过查询接口返回的字典来自动化生成前端UI。
URL：/api/ocr/get_options
例：http://127.0.0.1:1224/api/ocr/get_options
（默认端口为1224，可以在 Umi-OCR 全局设置中更改。）
方法：GET
返回 json 字典，记录图片OCR接口的参数定义。
以PaddleOCR引擎插件为例，返回值为：
展开
{
"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": "排版解析方案",
"toolTip": "按什么方式，解析和排序图片中的文字块",
"default": "multi_para",
"optionsList": [
["multi_para","多栏-按自然段换行"],
["multi_line","多栏-总是换行"],
["multi_none","多栏-无换行"],
["single_para","单栏-按自然段换行"],
["single_line","单栏-总是换行"],
["single_none","单栏-无换行"],
["single_code","单栏-保留缩进"],
["none","不做处理"]
],
"type": "enum"
},
"tbpu.ignoreArea": {
"title": "忽略区域",
"toolTip": "数组，每一项为[[左上角x,y],[右下角x,y]]。",
"default": [],
"type": "var"
},
"data.format": {
"title": "数据返回格式",
"toolTip": "返回值字典中，[\"data\"] 按什么格式表示OCR结果数据",
"default": "dict",
"optionsList": [
["dict","含有位置等信息的原始字典"],
["text","纯文本"]
],
"type": "enum"
}
}上述返回值示例中，拥有5个根元素，表示5个参数。
返回值中，每个参数有这些属性：
title：参数名称。toolTip：参数说明。default：默认值。type：参数值的类型，具体如下：enum：枚举。参数值必须为optionsList中某一项的[0]。boolean：布尔。参数值必须为true/false。text：字符串。number：数字。如何属性isInt==true，那么必须为整数。var：特殊类型，具体见toolTip的说明。
Tip
注意， Umi-OCR 在不同插件配置下，图片OCR的参数名称、格式、取值范围可能不同。下面的说明不代表所有情况，请自行通过 /api/ocr/get_options 接口确认一下。
- ocr.language ：OCR目标语言。
- ocr.cls ：填 true 时启用方向纠正，可识别旋转过的图片。
- ocr.limit_side_len ：图像压缩边长。先将图片压缩到该尺寸再进行OCR，以加快速度。如果要识别超大尺寸图片，请调高该参数。
- data.format ：数据返回格式。OCR返回值字典中，
["data"]按什么格式表示OCR结果数据。可选值：dict：含有位置等信息的原始字典text：纯文本
- tbpu.parser ：排版解析方案。可选值：
multi_para：多栏-按自然段换行multi_line：多栏-总是换行multi_none：多栏-无换行single_para：单栏-按自然段换行single_line：单栏-总是换行single_none：单栏-无换行single_code：单栏-保留缩进，适用于解析代码截图none：不做处理
- tbpu.ignoreArea ：忽略区域功能。传入一些矩形框，位于这些矩形框内部的文字块将会被忽略。
- 外层格式：列表
[]，每项表示一个矩形框。 - 内层格式：列表
[[x1,y1],[x2,y2]]，其中x1,y1是矩形框左上角坐标，x2,y2是右下角坐标。 - 示例：假设忽略区域包含3个矩形框，那么
tbpu.ignoreArea的格式类似：[ [[0,0],[100,50]], // 第1个框，左上角(0,0)，右下角(100,50) [[0,60],[200,120]], // 第2个 [[400,0],[500,30]] // 第3个 ]
- 注意，只有处于忽略区域框内部的整个文本块（而不是单个字符）会被忽略。如下图所示，黄色边框的深色矩形是一个忽略区域。那么只有
key_mouse才会被忽略。pubsub_connector.py、pubsub_service.py这两个文本块得以保留。
- 外层格式：列表
对于上述返回值示例，可以组装出这样的参数字典：
展开
{
"ocr.language": "models/config_chinese.txt",
"ocr.cls": true,
"ocr.limit_side_len": 4320,
"tbpu.parser": "multi_none",
"data.format": "text"
}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); });Python 示例：（点击展开）
import json, requests
response = requests.get("http://127.0.0.1:1224/api/ocr/get_options")
res_dict = json.loads(response.text)
print(json.dumps(res_dict, indent=4, ensure_ascii=False))传入一个base64编码的图片，返回OCR识别结果。
URL：/api/ocr
例：http://127.0.0.1:1224/api/ocr
方法：POST
参数：json 字典，值为：
- base64 ： 必填。待识别图像的 Base64 编码字符串，无需
data:image/png;base64,等前缀。 - options ：可选。参数字典，见 查询接口 。
options 参数示例：（点击展开）
{
"base64": "iVBORw0KGgoAAAAN……",
"options": {
"ocr.language": "models/config_chinese.txt",
"ocr.cls": true,
"ocr.limit_side_len": 4320,
"tbpu.parser": "multi_none",
"data.format": "text"
}
}返回 json ，内容为：
| 字段 | 类型 | 描述 |
|---|---|---|
| code | int | 任务状态码。100为成功，101为无文本，其余为失败 |
| data | list/string | 识别结果，格式见下 |
| time | double | 识别耗时（秒） |
| timestamp | double | 任务开始时间戳（秒） |
图片中无文本（code==101），或识别失败（code!=100 and code!=101）时：
["data"]为string，内容为错误原因。例：{"code": 902, "data": "向识别器进程传入指令失败，疑似子进程已崩溃"}
识别成功（code==100）时，如果options中data.format为dict（默认值）：
["data"]为list，每一项元素为dict，包含以下子元素：
| 参数名 | 类型 | 描述 |
|---|---|---|
| text | string | 文本 |
| score | double | 置信度 (0~1) |
| box | list | 文本框顺时针四个角的xy坐标：[左上,右上,右下,左下] |
| end | string | 表示本行文字结尾的结束符，根据排版解析得出。可能为空、空格、换行。 |
结果示例：
{
"code": 100,
"data": [
{
"text": "第一行的文本，",
"score": 0.99800001,
"box": [[x1,y1], [x2,y2], [x3,y3], [x4,y4]],
"end": "",
},
{
"text": "第二行的文本",
"score": 0.97513333,
"box": [[x1,y1], [x2,y2], [x3,y3], [x4,y4]],
"end": "\n",
},
]
}识别成功（code==100）时，如果options中data.format为text：
["data"]为string，即所有OCR结果的拼接。例：
"data": "第一行的文本，第二行的文本\n"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=",
// 可选参数示例
"options": {
"data.format": "text",
}
};
fetch(url, {
method: "POST", body: JSON.stringify(data),
headers: {"Content-Type": "application/json"},
})
.then(response => response.json())
.then(data => {
console.log(data);
})
.catch(error => {
console.error(error);
});Python 示例：（点击展开）
import requests
import json
url = "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=",
# 可选参数示例
"options": {
"data.format": "text",
}
}
headers = {"Content-Type": "application/json"}
data_str = json.dumps(data)
response = requests.post(url, data=data_str, headers=headers)
response.raise_for_status()
res_dict = json.loads(response.text)
print(res_dict)