OCR API ドキュメント:エンドポイント、モード、制限
このページは、2つのエンドポイント、4つのリクエストモード、制限、エラーを1か所で確認できる開発者向けOCR APIドキュメントとして機能します。APIはOCRエンジンが既に生成したテキストを整形しますが、画像は読み取りません。
更新日:

主要ポイント
- POST /v1/chat/completionsとGET /v1/modelsの2つのメソッドがあり、Bearerキーで認証します。
- ストリーミング、JSONモード、ツール呼び出しはOpenAIチャット形式に従い、モデルIDはuncensoredです。
- 制限: 完全なAPIキーでは同時リクエスト8件、1分あたり300件、ボディサイズ8 MB。トライアルキーでは同時2件、1分あたり60件。
- 過負荷時のエラーはHTTP 429で、減速するか並列度を減らす必要があるかを示すコードが含まれます。
概要と認証
このサービスはホストされたOpenAI互換テキストAPIです。このサイトでの目的はOCRジョブの2番目のパート、つまりOCRエンジンが生成した生文字列を受け取り、整形された文章、構造化フィールド、またはフラグ付き行を返すことです。入力はテキストのみです。画像、音声、動画の入出力、埋め込み、ファインチューニングはありません。
すべては1つの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 を含むモデル一覧を返します。無効なキーは認証エラーを返し、問題がリクエストボディではなくキーにあることを示します。
リクエストパラメータ
チャット補完(chat completion)リクエストには model と messages が必要です。以下のオプションフィールドはモデルに渡されます。
temperatureとtop_p:サンプリング制御。OCR修復にはtemperatureを0に設定し、同一の入力に対して同一の出力が得られるようにします。max_tokens:オプション。指定しない場合、補完はプロンプト後の100,000トークンのウィンドウに残っている分を使用できます。呼び出しあたりのコストに上限を設定したい場合に指定します。stop:生成を終了する文字列。マーカー間の出力を要求する場合に便利です。seed:実行間での再現性を向上させます。presence_penaltyとfrequency_penalty:渡されます。クリーンアップには0に設定してください。ペナルティがあると、テーブルヘッダーなどの正当な繰り返し単語を変更する可能性があります。stream、response_format、tools、tool_choiceは次の3つのセクションで説明します。
コンテキストウィンドウはプロンプトと補完を合わせて100,000トークンまでカウントされ、リクエストボディは最大8 MBまで可能です。実際にはトークン制限の方が先に到達します。
ストリーミングレスポンス
"stream": trueを設定すると、APIはテキスト生成中にServer-Sent Eventsを送信します。ストリーミングは、クリーンな段落が現れるのを見るエディタなどのインタラクティブなツールに役立ちます。トークン使用量はストリームの終了時に報告されるため、コストを記録し続けることができます。
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)
スループットに影響する1つの詳細があります。ストリーミングリクエストはストリームが終了するまで同時実行スロットを占有します。コードが途中で読み取りを停止して接続を開いたままにすると、そのスロットはビジー状態のままになります。ストリームを明示的に閉じるか、最後まで消費してください。
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" メッセージを追加します。このパターンは、モデルが変更した行のみを返すため、出力トークンを低く保ちます。
テキスト整形に適した設定
推奨される開始点がある場合、レファレンスはより有用になります。ここではOCR修復でパラメータが通常どのように組み合わされるかを示します。これらはタスクの動作に基づく提案であり、測定されたベンチマークではありません。
- 決定論的修復:
temperature0、ペナルティなし、固定のseed。昨日の出力を再現する再実行を希望するアーカイブに使用してください。 - フィールド抽出:
temperature0、response_formatをjson_objectに設定、および期待される最大オブジェクトサイズをわずかに上回るmax_tokensの上限。 - インタラクティブレビュー:
streamtrueと短いシステムプロンプト、エディターが修正されたテキストの出現を確認し、早期に停止できるようにします。 - 行レベルの修正:
replace_lineスタイルの関数を持つツール、モデルが変更された部分のみを返すようにします。
メッセージのロールは通常の規約に従います:systemは永続的な指示用、userはOCRテキスト用、assistantはマルチターンセッションでの以前の返信用、toolは関数の結果用です。指示をシステムメッセージに、生テキストをユーザーメッセージに配置します。OCRテキスト自体が指示のように見える場合(例えば、以前のテキストを無視するよう促すスキャンされた看板など)、分離により、ユーザーメッセージが修復すべきデータであり、従うべきコマンドではないことをモデルに伝えるのが容易になります。システムプロンプトでそれを明示してください。
すべての呼び出しに対してX-Request-Idの値を記録してください。これは、特定のページが正しく表示されず、その確認を依頼する際にサポートが必要とする識別子です。
制限、ヘッダー、エラー
| 制限 | フルキー | トライアルキー |
|---|---|---|
| 同時リクエスト | 8 | 2 |
| 1分あたりのリクエスト数 | 300 | 60 |
| 最大ボディサイズ | 8 MB | 8 MB |
| コンテキスト長 | 100,000トークン | 100,000トークン |
レスポンスにはX-Request-Id(サポートへの問い合わせ時に伝えてください)、X-Balance-USD(残高クレジット)、X-RateLimit-Limit-Requests、X-RateLimit-Limit-Concurrencyが含まれます。
制限に達すると、APIはHTTP 429を返します。エラーコードrate_limitedは1分あたりのリクエストが多すぎることを意味し、負荷を分散してください。コードconcurrencyは同時実行中のリクエストが多すぎることを意味し、ワーカーの数を減らしてください。Retry-After: 5ヘッダーを伴う429は一時的な過負荷を示しており、5秒待ってから再送信してください。失敗したリクエストと拒否されたリクエストは課金されないため、リトライループは安全です。
課金はトークン単位です:入力1Mあたり$0.15、出力1Mあたり$0.50で、期限のない前払いクレジットから差し引かれます。チャージ額とボーナスについては料金ページをご覧ください。プロンプトはトレーニングには使用されません。コンテンツルールは単一のハード制限です:未成年者が関わる性的コンテンツは一切認められません。ポリシーに関する質問はサポートまで。
その他のガイド
質問と回答
APIが提供するエンドポイントはどれですか?
2つあります。生成用POST /v1/chat/completionsとモデル一覧用GET /v1/modelsです。両方とも同じBearerキーを使用します。
ストリーミングと関数呼び出しはサポートされていますか?
はい。streamをtrueに設定してSSEを使用し、関数呼び出しにはtoolsとtool_choiceを使用し、結果をrole toolメッセージとして返します。
最大入力サイズはいくらですか?
コンテキストウィンドウはプロンプトと補完を合わせて100,000トークンで、リクエストボディは最大8 MBまで可能です。
429エラーが発生した理由は何ですか?
1分あたりのリクエスト数(rate_limited)、同時リクエスト(concurrency)のいずれかを超過したか、Retry-After: 5を含む一時的な過負荷に達しました。待機して再試行してください。
キーはフォーム 1 つで手に入ります
アカウントを作成し、キーをコピーし、ベースURLを変更します。これでセットアップは完了です。