OCR API 集成:Python 和 Node 代码示例
此处的 OCR API 集成意味着在您的 OCR 引擎后添加一个 HTTP 请求:您发送原始识别文本并获取清理后的文本。该接口与 OpenAI 兼容,因此您现有的 SDK 只需更改两项设置即可使用。
更新于

要点
- 将 Base URL 设置为 https://api.llmocrapi.com/v1,使用模型 ID uncensored,并将您的密钥作为 Bearer token 发送。
- API 仅接受文本。请先运行您的 OCR 引擎,并将其输出作为用户消息传递。
- JSON 模式返回机器可读的结果,最多 8 个工作线程的小型线程池可保持批处理快速。
- 429 响应表示需要等待并重试,而非失败:失败的请求不会收费。
调用在流水线中的位置
典型的文档流包含四个步骤。扫描仪或手机摄像头生成图像,OCR 引擎将图像转换为原始文本,清理步骤修复该文本,您的应用程序存储或搜索结果。此处描述的 API 是第三步。它不查看图像,也没有图像输入。当您关注原始扫描的隐私时,这是一个特性,因为只有文本离开您的机器;如果您期望一个处理图片的单一接口,则是一个限制。
提示词不用于训练。尽管如此,只发送任务所需的内容:如果清理不依赖于它们,请在调用前去除账号或姓名。
在编写任何代码之前,获取 API 密钥。新用户注册后只需在该页面点击一下即可领取 $0.50 的免费试用额度,足以多次运行下面的所有示例。试用密钥允许 2 个并发请求和每分钟 60 个请求;完整密钥允许 8 个和 300 个。
您需要设置的参数
| 设置 | 说明 |
|---|---|
| Base URL | https://api.llmocrapi.com/v1 |
| 接口 | POST /v1/chat/completions |
| 模型 ID | uncensored |
| Auth 头 | Authorization: Bearer YOUR_KEY |
| 上下文窗口 | 100,000 token,包含提示词和补全 |
将密钥存储在环境变量中,不要提交到源代码控制。示例读取 LLMOCR_API_KEY。
开始前的两个实用提示。将密钥保留在前端代码之外,因为任何交付到浏览器的内容都可以被其用户读取;从服务器或工作线程调用 API。尽早决定原始 OCR 文本和清理后的文本将存储在哪里,因为清理后的输出是您将搜索、索引和展示给用户的文件,而原始文本是如果更正受到质疑时的证据。
首次 curl 请求
先从 curl 开始,以便在 SDK 隐藏它之前看到请求的原始结构。下面的示例是一个典型的损坏 OCR 片段:跨换行符的连字符、字母与数字混淆以及多余的页码。
curl https://api.llmocrapi.com/v1/chat/completions \
-H "Authorization: Bearer $LLMOCR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"temperature": 0,
"messages": [
{"role": "system", "content": "You repair raw OCR text. Fix broken words, rejoin hyphenated line breaks, remove page numbers. Return only the corrected text."},
{"role": "user", "content": "The inven-\ntory was com1leted on Tuesday.\n\n- 14 -\n\nA second ship-\nment arrived."}
]
}'
回复遵循标准的 chat completion 格式。清理后的文本位于 choices[0].message.content,usage 报告该调用的提示词和补全 token。将 temperature 设置为 0 以进行清理。您希望相同的输入产生相同的输出,而不是创造性变化。
Python 配合 OpenAI SDK
使用 pip install openai 安装 SDK。仅构造函数与标准 OpenAI 设置不同。
import os
from openai import OpenAI
client = OpenAI(
base_url="https://api.llmocrapi.com/v1",
api_key=os.environ["LLMOCR_API_KEY"],
max_retries=4,
)
SYSTEM = (
"You repair raw OCR text. Fix broken words, rejoin hyphenated line breaks, "
"remove page numbers and running headers. Do not add or remove facts. "
"Return only the corrected text."
)
def clean(raw: str) -> str:
resp = client.chat.completions.create(
model="uncensored",
temperature=0,
messages=[
{"role": "system", "content": SYSTEM},
{"role": "user", "content": raw},
],
)
return resp.choices[0].message.content
print(clean("The inven-\ntory was com1leted on Tuesday."))
max_retries 参数指示 SDK 在连接错误和 429 响应时进行重试并退避,因此对于轻度使用,您不需要自己编写该循环。
Node.js 示例
使用 npm install openai 和 ES 模块,相同的调用如下所示。
import OpenAI from "openai";
const client = new OpenAI({
baseURL: "https://api.llmocrapi.com/v1",
apiKey: process.env.LLMOCR_API_KEY,
});
export async function clean(raw) {
const resp = await client.chat.completions.create({
model: "uncensored",
temperature: 0,
messages: [
{ role: "system", content: "Repair raw OCR text. Return only the corrected text." },
{ role: "user", content: raw },
],
});
return resp.choices[0].message.content;
}
console.log(await clean("A second ship-\nment arrived."));
任何支持 OpenAI 聊天格式的东西,例如无代码自动化工具或现有的内部包装器,都可以使用相同的两个设置。文档列出了所有支持的参数。
使用 JSON 模式的结构化输出
自由文本适合归档,但数据提取流水线需要字段。使用 response_format 开启 JSON 模式,并在提示词中描述您想要的形状。在指令和设置中都要求 JSON 可获得最可靠的结果。
import json
resp = client.chat.completions.create(
model="uncensored",
temperature=0,
response_format={"type": "json_object"},
messages=[
{"role": "system", "content": (
"Clean the OCR text of a receipt and answer in JSON with keys "
"'vendor' (string), 'date' (YYYY-MM-DD or null), 'total' (number or null), "
"'cleaned_text' (string)."
)},
{"role": "user", "content": raw_receipt_text},
],
)
data = json.loads(resp.choices[0].message.content)
始终将 json.loads 包裹在 try 块中并保留原始文本,因为非常长或截断的响应仍可能产生无效的 JSON。如果解析失败,重试一次,然后将该页面排队进行人工审核。
并行处理批次
一次处理一个请求对于数千页来说太慢。完整密钥允许 8 个并发请求,因此 6 或 8 个工作线程的线程池可让您保持在限制之下。如果同一密钥被其他任何内容使用,请留出一些余量。
from concurrent.futures import ThreadPoolExecutor
pages = [open(f"ocr/page_{i:04d}.txt").read() for i in range(1, 501)]
with ThreadPoolExecutor(max_workers=6) as pool:
cleaned = list(pool.map(clean, pages))
for i, text in enumerate(cleaned, start=1):
open(f"clean/page_{i:04d}.txt", "w").write(text)
如果您超过限制,API 将返回 HTTP 429。错误代码 rate_limited 表示每分钟请求过多,concurrency 表示同时请求过多。带有 Retry-After: 5 标头的 429 表示临时过载:等待五秒。流式请求会保留并发槽位,直到流结束,因此请关闭您停止读取的流。
在长时间运行中监控 X-Balance-USD 响应标头。当余额较低时,暂停并从 定价页面 充值,而不是让作业中途失败。
长文档及输出检查
实际的 OCR 输出很少是一个整洁的页面。扫描一本书会给您数千页,损坏是不均匀的:一个干净的章节,然后是一页满是破碎字符的污渍页。一些习惯可以使清理步骤可预测。
按结构拆分,而不是按字符数拆分。在页面边界或段落边界处切断,以便模型在块开始时永远不会收到半句话。如果句子跨越页面边界,将上一页的最后一段作为只读上下文包含在内,并告诉模型仅返回当前页面。这会在每个请求中消耗一些额外的输入 token,在每 100 万 token $0.15 的情况下几乎可以忽略不计,并且可以修复跨越两页的连字符单词。
在接受结果之前,先用低成本检查验证每个结果。将清理后的文本长度与源文本进行比较:比率远非 1 意味着模型丢弃或编造了内容。比较数字:从两个版本中提取所有数字序列,并标记它们不同的页面,因为日期、金额和标识符的遗漏成本最高。将原始 OCR 保留在清理后的文本旁边,以便人员始终可以重建引擎实际看到的内容。
最后,将第一次运行视为试点。清理 20 页,亲自阅读其中 10 页,并调整系统提示词。通常,对指令进行两到三轮编辑比任何参数更改对质量的提升更大。
常见错误
- 一次性发送非常大的页面。 上下文窗口为 100,000 token,最大请求正文为 8 MB,但页面大小的块准确性更好,且失败的块重做成本更低。
- 让模型重写。 如果提示词没有说明不添加或删除事实,它可能会擅自润色损坏的段落。保持指令明确并比较长度:如果清理后的页面远短于其源,则值得查看。
- 使用错误的模型名称。 唯一的模型 ID 是
uncensored。您可以使用GET /v1/models列出模型。 - 期望嵌入或图像输入。 此 API 均不提供。对于清理后的文本搜索,请使用单独的嵌入工具。
- 忘记记录请求 ID。 每个响应都包含一个
X-Request-Id标头。将其与页面一起存储,以便支持人员可以追踪不良结果。
内容规则很简单:模型经过调整,可在合法成人使用中无拒绝地回答,且绝不允许涉及未成年人的色情内容。关于特定案例的问题请前往 支持。
更多指南
问答
我需要特殊的 SDK 吗?
不需要。只要将 Base URL 设置为 https://api.llmocrapi.com/v1,使用模型 ID uncensored,并发送 Bearer 密钥,任何 OpenAI SDK 或 HTTP 客户端均可工作。
我可以直接发送图片或 PDF 吗?
不可以。API 仅接受文本。请先运行 OCR 引擎,然后将其输出作为消息内容发送。
我可以同时运行多少个请求?
完整密钥允许 8 个并发请求和每分钟 300 个请求。试用密钥允许 2 个并发请求和每分钟 60 个。
如果我达到速率限制会发生什么?
您会收到 HTTP 429 错误,代码为 rate_limited 或 concurrency。等待后重试;失败的请求不会收费。
只差一张表单,即可获得密钥
创建账户,复制密钥,更改基础 URL。这就是全部设置。