llmocrapi.comคู่มือ
เอกสาร API OCR: เอนด์พอยต์ โหมด และขีดจำกัด
หน้านี้ทำหน้าที่เป็นเอกสาร API OCR: เอนด์พอยต์ โหมด และขีดจำกัด สำหรับนักพัฒนาที่ต้องการข้อมูลครบถ้วนในที่เดียว: เอนด์พอยต์สองตัว, โหมดคำขอสี่แบบ, ขีดจำกัดและข้อผิดพลาด API ทำความสะอาดข้อความที่ OCR engine ผลิตแล้ว ไม่ได้อ่านรูปภาพ
อัปเดต

ประเด็นสำคัญ
- มีสองวิธี: POST /v1/chat/completions และ GET /v1/models ยืนยันตัวตนด้วยคีย์ Bearer
- สตรีมมิง โหมด JSON และการเรียกใช้ฟังก์ชันปฏิบัติตามรูปแบบ chat ของ OpenAI โดยระบุ model ID เป็น uncensored
- ขีดจำกัด: คำขอพร้อมกัน 8 คำขอและ 300 คำขอต่อนาทีสำหรับคีย์เต็ม, 2 และ 60 สำหรับคีย์ทดลอง, body ขนาด 8 MB
- ข้อผิดพลาดเมื่อโอเวอร์โหลดคือ HTTP 429 พร้อมรหัสที่บอกว่าคุณควรลดความเร็วหรือลดความพร้อมกัน
ภาพรวมและการยืนยันตัวตน
บริการเป็น API ข้อความที่เข้ากันได้กับ OpenAI จุดประสงค์บนเว็บไซต์นี้คือส่วนที่สองของงาน OCR: รับสตริงดิบที่ OCR engine ผลิตแล้วและส่งกลับเป็นข้อความที่สะอาด, ฟิลด์ที่มีโครงสร้างหรือบรรทัดที่ถูกระบุ Input เป็นข้อความเท่านั้น ไม่มี input หรือ output รูปภาพ, เสียงหรือวิดีโอ, ไม่มี embeddings และไม่มี fine-tuning
ทุกอย่างอยู่ภายใต้ Base URL เดียวกัน https://api.llmocrapi.com/v1 การตรวจสอบสิทธิ์ใช้ Header Bearer มาตรฐาน: Authorization: Bearer YOUR_KEY คุณสร้างคีย์บน หน้า API key หลังจากเข้าสู่ระบบด้วย Google หรือด้วยอีเมลและรหัสผ่าน โมเดลที่อยู่หลังเอนด์พอยต์เป็นโมเดลแบบเปิดน้ำหนักเพียงตัวเดียวที่ให้บริการโดยผู้ให้บริการอิสระ ไม่ใช่ API ทางการของผู้พัฒนาโมเดลรายใด และไม่ใช่ตัวกระจายการร้องขอข้ามผู้ให้บริการหลายราย รหัสของโมเดลคือ uncensored เสมอ
สำหรับคู่มือปฏิบัติจริงแทนเอกสารอ้างอิง คู่มือเริ่มต้นใช้งานในส่วน เอกสาร จะครอบคลุมขั้นตอนการทำคำขอแรกทีละขั้นตอน
สรุปเอนด์พอยต์
| เมธอดและพาธ | วัตถุประสงค์ |
|---|---|
GET /v1/models | แสดงรายการโมเดลที่มีอยู่ ใช้เพื่อตรวจสอบคีย์แบบประหยัด |
POST /v1/chat/completions | รันโมเดลกับรายการข้อความ รองรับสตรีมมิง โหมด JSON และเครื่องมือ |
นั่นคือพื้นผิวทั้งหมด เนื่องจากตรงกับรูปแบบการสื่อสารของ OpenAI ไลบรารีไคลเอนต์ใดๆ ที่ให้คุณตั้งค่า base URL และคีย์ API ได้จะใช้งานได้ การตรวจสอบความถูกต้องอย่างรวดเร็วที่สุดคือ:
curl https://api.llmocrapi.com/v1/models \
-H "Authorization: Bearer $LLMOCR_API_KEY"
คีย์ที่ถูกต้องจะส่งคืนรายการโมเดลที่มี uncensored คีย์ที่ไม่ถูกต้องจะส่งคืนข้อผิดพลาดการตรวจสอบสิทธิ์ ซึ่งบอกคุณว่าปัญหาคือคีย์ ไม่ใช่บอดีคำขอของคุณ
พารามิเตอร์ของคำขอ
คำขอ chat completion ต้องการ model และ messages ฟิลด์เสริมด้านล่างจะถูกส่งผ่านไปยังโมเดล
temperatureและtop_p: การควบคุมการสุ่มตัวอย่าง สำหรับการซ่อมแซม OCR ให้ใช้temperature0 เพื่อให้ข้อมูลนำเข้าที่เหมือนกันให้ผลลัพธ์ที่เหมือนกันmax_tokens: ไม่บังคับ หากไม่ระบุ การสร้างข้อความสามารถใช้โทเคนที่เหลือจากหน้าต่าง 100,000 โทเคนหลังจากพรอมต์ของคุณได้ กำหนดค่าเมื่อคุณต้องการจำกัดต้นทุนสูงสุดต่อการเรียกstop: สตริงที่สิ้นสุดการสร้าง มีประโยชน์เมื่อคุณขอผลลัพธ์ระหว่างมาร์คเกอร์seed: ปรับปรุงความสามารถในการทำซ้ำข้ามการรันpresence_penaltyและfrequency_penalty: ส่งผ่านต่อไป ตั้งไว้ที่ศูนย์สำหรับการ cleanup เนื่องจากค่าปรับสามารถทำให้โมเดลปรับเปลี่ยนคำที่ถูกต้องซึ่งทำซ้ำเช่นส่วนหัวของตารางstream,response_format,toolsและtool_choice: ครอบคลุมในสามส่วนถัดไป
หน้าต่างบริบทนับพรอมต์และการสร้างข้อความรวมกันที่ 100,000 โทเคน และบอดีคำขออาจมีขนาดสูงสุด 8 MB ในทางปฏิบัติ ขีดจำกัดโทเคนจะมาถึงก่อน
การตอบกลับแบบสตรีมมิง
ตั้งค่า "stream": true และ API จะส่ง SSE เมื่อข้อความถูกสร้าง การสตรีมมิงช่วยเครื่องมือแบบอินเทอร์แอคทีฟ เช่น editor ที่ผู้ใช้ดูย่อหน้าที่ผ่านการ cleanup ปรากฏขึ้น การใช้งานโทเคนจะรายงานที่ท้ายสตรีมมิง ดังนั้นคุณยังสามารถบันทึกค่าใช้จ่ายได้
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)
รายละเอียดหนึ่งอย่างส่งผลต่อปริมาณงาน คำขอที่สตรีมจะครอบครองช่อง concurrencyจนกว่าสตรีมจะสิ้นสุด หากโค้ดของคุณหยุดอ่านกลางคันและปล่อยให้การเชื่อมต่อเปิดอยู่ ช่องนั้นจะยังคงใช้งานอยู่ ให้ปิดสตรีมอย่างชัดเจน หรืออ่านจนจบ
โหมด 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 แยกวิเคราะห์ นำการเปลี่ยนแปลงไปใช้ และหากคุณสนทนาต่อ ให้เพิ่มข้อความผู้ช่วยและข้อความ role: "tool" พร้อม tool_call_id ที่ตรงกัน รูปแบบนี้รักษาโทเคนเอาต์พุตให้ต่ำ เนื่องจากโมเดลส่งคืนเฉพาะบรรทัดที่เปลี่ยนแปลง
การตั้งค่าที่เหมาะสมกับการทำความสะอาดข้อความ
การอ้างอิงจะมีประโยชน์มากขึ้นเมื่อมีจุดเริ่มต้นที่แนะนำ ดังนั้นนี่คือวิธีการที่พารามิเตอร์มักผสมผสานกันสำหรับการซ่อมแซม 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 โทเคน | 100,000 โทเคน |
การตอบกลับมี X-Request-Id (ระบุค่านี้เมื่อติดต่อฝ่ายสนับสนุน), X-Balance-USD (เครดิตคงเหลือของคุณ), X-RateLimit-Limit-Requests และ X-RateLimit-Limit-Concurrency
เมื่อคุณเกินขีดจำกัด API จะตอบกลับด้วย HTTP 429 รหัสข้อผิดพลาด rate_limited หมายถึงมีการส่งคำขอมากเกินไปในหนึ่งนาที ดังนั้นควรกระจายภาระงาน รหัส concurrency หมายถึงมีการส่งคำขอที่กำลังดำเนินการอยู่พร้อมกันมากเกินไป ดังนั้นควรลดจำนวน worker ลง การตอบกลับ 429 ที่มีเฮดเดอร์ Retry-After: 5 แสดงถึงภาวะโอเวอร์โหลดชั่วคราว: รอห้าวินาทีแล้วส่งอีกครั้ง คำขอที่ล้มเหลวและถูกปฏิเสธจะไม่ถูกคิดเงิน ดังนั้นลูปการลองใหม่จึงปลอดภัย
การเรียกเก็บเงินต่อโทเคน: $0.15 ต่อ 1M input และ $0.50 ต่อ 1M output หักจากเครดิตแบบเติมเงินล่วงหน้าที่ไม่หมดอายุ ดูหน้า ราคา สำหรับจำนวนเติมเงินและโบนัส พรอมต์ไม่ถูกใช้สำหรับการฝึกโมเดล กฎเนื้อหาเป็นขีดจำกัดเดียวที่เข้มงวด: ไม่มีเนื้อหาทางเพศที่เกี่ยวข้องกับผู้เยาว์ คำถามเกี่ยวกับนโยบายไปที่ ฝ่ายสนับสนุน
คู่มือเพิ่มเติม
ถาม-ตอบ
API มีเอนด์พอยต์อะไรบ้าง?
สอง: POST /v1/chat/completions สำหรับการสร้าง และ GET /v1/models สำหรับรายการโมเดล ทั้งสองใช้คีย์ Bearer เดียวกัน
รองรับสตรีมมิงและการเรียกใช้ฟังก์ชันหรือไม่?
ใช่ ตั้งค่า stream เป็น true เพื่อใช้ SSE พร้อมข้อมูลการใช้งานที่ส่วนท้าย และใช้ tools และ tool_choice สำหรับการเรียกใช้ฟังก์ชัน โดยส่งผลลัพธ์กลับในรูปแบบข้อความบทบาท tool
ขนาดอินพุตสูงสุดคือเท่าไหร่?
หน้าต่างบริบทคือ 100,000 โทเคนสำหรับพรอมต์รวมกับการสร้างผลลัพธ์ และ body ของคำขอสามารถมีขนาดสูงสุด 8 MB
ทำไมฉันถึงได้รับข้อผิดพลาด 429?
คุณเกินจำนวนคำขอต่อนาที (rate_limited), คำขอพร้อมกัน (concurrency) หรือเกิดภาวะโอเวอร์โหลดชั่วคราว ซึ่งรวมถึง Retry-After: 5 รอแล้วลองใหม่
คีย์ของคุณอยู่ห่างแค่แบบฟอร์มเดียว
สร้างบัญชี คัดลอกคีย์ และเปลี่ยน base URL นั่นคือการตั้งค่าทั้งหมด