OCR API 文档:接口、模式与限制
本页面作为面向开发者的 OCR API 文档,在一个位置展示完整功能:两个接口、四种请求模式、限制和错误。API 清理 OCR 引擎已生成的文本;它不读取图像。
更新于

要点
- 存在两种方法:POST /v1/chat/completions 和 GET /v1/models,通过 Bearer 密钥进行认证。
- 流式输出、JSON 模式和函数调用遵循 OpenAI 聊天格式,模型 ID 为 uncensored。
- 限制:完整密钥为 8 个并发请求和每分钟 300 个请求,试用密钥为 2 个和 60 个,请求体最大 8 MB。
- 过载时的错误为 HTTP 429,错误代码会告知你是应降低速率还是减少并发。
概览与认证
该服务是一个托管的、兼容 OpenAI 的文本 API。本网站上的用途是 OCR 任务的第二部分:获取 OCR 引擎生成的原始字符串,并返回清理后的文本、结构化字段或标记行。输入仅为文本。没有图像、音频或视频输入或输出,没有嵌入也没有微调。
所有内容都在一个 Base URL 下:https://api.llmocrapi.com/v1。认证使用标准的 Bearer 头:Authorization: Bearer YOUR_KEY。在通过 Google 或电子邮件和密码注册后,你可以在 API 密钥页面 创建密钥。该接口背后的模型是由独立提供商运行的单一开放权重模型。它不是任何模型供应商的官方 API,也不是跨供应商的路由器。其 ID 始终为 uncensored。
如果想进行动手操作而非参考,快速入门指南在文档部分中逐步介绍首次请求。
接口概览
| 方法和路径 | 用途 |
|---|---|
GET /v1/models | 列出可用模型。可用作廉价的密钥检查。 |
POST /v1/chat/completions | 在消息列表上运行模型。支持流式输出、JSON 模式和工具。 |
这就是全部功能。由于它匹配 OpenAI 的传输格式,任何允许你设置 Base URL 和密钥的客户端库均可工作。最快的健全性检查是:
curl https://api.llmocrapi.com/v1/models \
-H "Authorization: Bearer $LLMOCR_API_KEY"
有效密钥返回包含 uncensored 的模型列表。错误密钥返回认证错误,这表明问题是密钥而非请求体。
请求参数
聊天完成请求需要 model 和 messages。以下可选字段将透传给模型。
temperature和top_p:采样控制。对于 OCR 修复,使用temperature0,使相同输入产生相同输出。max_tokens:可选。如果不设置,补全部分可以使用提示词之后剩余的 100,000-token 上下文窗口。如果你希望对每次调用的成本设置硬性上限,请设置此参数。stop:用于结束生成的字符串。当要求输出在标记之间时非常有用。seed:提高跨运行的一致性。presence_penalty和frequency_penalty:透传。清理时请将其保持为零,因为惩罚可能会促使模型更改重复的有效词,如表格标题。stream、response_format、tools和tool_choice:将在接下来的三个部分中介绍。
上下文窗口将提示词和完成部分合计计算为 100,000 token,请求体最大可达 8 MB。实际上,token 限制会先到达。
流式响应
设置 "stream": true,API 会在生成文本时发送 Server-Sent Events。流式输出有助于交互式工具,例如编辑器中用户观看清理后的段落出现。Token 用量在流结束时报告,因此你仍可记录成本。
import os
from openai import OpenAI
client = OpenAI(base_url="https://api.llmocrapi.com/v1", api_key=os.environ["LLMOCR_API_KEY"])
stream = client.chat.completions.create(
model="uncensored",
stream=True,
messages=[{"role": "user", "content": "Fix this OCR text: th1s is a sam-\nple."}],
)
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="", flush=True)
if getattr(chunk, "usage", None):
print("\ntokens:", chunk.usage.prompt_tokens, chunk.usage.completion_tokens)
一个细节影响吞吐量。流式请求会占用其并发槽位,直到流结束。如果你的代码中途停止读取并保持连接打开,该槽位将保持忙碌。请显式关闭流,或将其消耗至结束。
JSON 模式
JSON 模式要求模型回复 JSON 对象而非文本。使用 response_format 启用它,并在你的指令中描述键。
{
"model": "uncensored",
"temperature": 0,
"response_format": {"type": "json_object"},
"messages": [
{"role": "system", "content": "Return JSON with keys 'text' (cleaned string) and 'uncertain_lines' (array of integers)."},
{"role": "user", "content": "line one\nl1ne two\nline thr3e"}
]
}
防御性解析。JSON 模式会约束输出格式,但你仍应在数据进入数据库之前验证键和类型。如果响应因 max_tokens 被截断,JSON 可能不完整,因此请提高上限或发送更小的片段。
函数调用
函数调用让模型请求你的代码执行操作,而不是生成文本。对于 OCR 工作,常见用法是返回结构化修正:模型调用一个函数,传入行号和替换内容,你的代码应用该修正。在tools数组中定义工具,使用tool_choice选择行为,并以role: "tool"消息返回结果。流式输出时,工具调用作为tool_calls增量逐步到达。
tools = [{
"type": "function",
"function": {
"name": "replace_line",
"description": "Replace one line of the OCR text with a corrected version.",
"parameters": {
"type": "object",
"properties": {
"line": {"type": "integer"},
"text": {"type": "string"},
},
"required": ["line", "text"],
},
},
}]
resp = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "1: The inven-\n2: tory was com1leted."}],
tools=tools,
tool_choice="auto",
)
for call in resp.choices[0].message.tool_calls or []:
print(call.function.name, call.function.arguments)
参数以 JSON 字符串形式返回。解析参数,应用更改,如果继续对话,请追加助手消息以及带有匹配 tool_call_id 的 role: "tool" 消息。此模式有助于保持输出 token 数量较少,因为模型仅返回它更改的行。
适合文本清理的设置
参考在推荐起点时更有用,因此以下是参数通常如何组合用于 OCR 修复。这些是基于任务行为的表现建议,而非经过测量的基准。
- 确定性修复:
temperature0,无惩罚,固定seed。对于希望重新运行能重现昨天输出的档案,请使用此设置。 - 字段提取:
temperature0,response_format设置为json_object,以及max_tokens上限略高于你预期的最大对象。 - 交互式审查:
streamtrue 和简短的系统提示词,以便编辑器看到更正后的文本出现并可以提前停止。 - 行级修复:带有
replace_line风格函数的工具,以便模型仅返回更改的内容。
消息角色遵循通常的约定:system 用于固定指令,user 用于 OCR 文本,assistant 用于多轮会话中的早期回复,tool 用于函数结果。将指令放在系统消息中,将原始文本放在用户消息中。如果 OCR 文本本身包含看起来像指令的内容,例如扫描的标志说忽略之前的文本,这种分离使得更容易告诉模型用户消息是待修复的数据,而不是要执行的命令。在系统提示词中明确说明这一点。
记录每次调用的 X-Request-Id 值。如果某页返回错误且你需要支持人员查看,这是支持人员需要的凭证。
限制、响应头和错误
| 限制 | 完整密钥 | 试用密钥 |
|---|---|---|
| 并发请求 | 8 | 2 |
| 每分钟请求数 | 300 | 60 |
| 最大请求体大小 | 8 MB | 8 MB |
| 上下文窗口 | 100,000 个 token | 100,000 个 token |
响应中包含 X-Request-Id(引用它以便向支持人员提供)、X-Balance-USD(你的剩余额度)、X-RateLimit-Limit-Requests 和 X-RateLimit-Limit-Concurrency 等 Header。
当超过限制时,API 返回 HTTP 429。错误代码 rate_limited 表示每分钟请求过多,请分散负载。代码 concurrency 表示并发请求过多,请降低工作线程数量。携带 Retry-After: 5 头信息的 429 响应表示临时过载:等待五秒后重试。失败和被拒绝的请求不收费,因此重试循环是安全的。
计费按 token 计算:输入每 1M token $0.15,输出每 1M token $0.50,从永不过期的预付额度中扣除。查看 定价页面 了解充值金额和奖励。提示词不用于训练。内容规则是单一硬性限制:禁止涉及未成年人的性内容。政策问题请发送至 支持。
更多指南
问答
API 提供哪些接口?
两个:用于生成的 POST /v1/chat/completions 和用于模型列表的 GET /v1/models。两者均使用相同的 Bearer 密钥。
它支持流式输出和函数调用吗?
可以。设置 stream 为 true 以启用 SSE 并在末尾获取用量,使用 tools 和 tool_choice 进行函数调用,以 role tool 消息形式返回结果。
最大输入大小是多少?
上下文窗口为 100,000 token(含提示词和补全),请求体最大为 8 MB。
为什么我会收到 429 错误?
你超过了每分钟请求数(rate_limited)、并发请求数(concurrency),或遇到临时过载,其中包括 Retry-After: 5。等待并重试。
只差一张表单,即可获得密钥
创建账户,复制密钥,更改 Base URL。这就是全部设置。