llmocrapi.comमार्गदर्शिका
OCR API दस्तावेज़ीकरण: एंडपॉइंट, मोड और सीमाएँ
यह पृष्ठ OCR API दस्तावेज़ीकरण के रूप में कार्य करता है उन डेवलपर्स के लिए जो पूरी 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 इंजन द्वारा उत्पादित कच्चे स्ट्रिंग को लें और साफ़ टेक्स्ट, संरचित फ़ील्ड या फ़्लैग की गई पंक्तियाँ लौटाएँ। इनपुट केवल टेक्स्ट है। कोई इमेज, ऑडियो या वीडियो इनपुट या आउटपुट, कोई एम्बेडिंग और कोई फाइन-ट्यूनिंग नहीं है।
सब कुछ एक ही बेस 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 वायर फॉर्मेट से मेल खाता है, कोई भी क्लाइंट लाइब्रेरी जो आपको बेस 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-टोकन विंडो में जो भी शेष बचता है, उसका उपयोग कर सकता है। जब आप प्रति कॉल लागत पर कड़ा कैप चाहते हैं तो इसे सेट करें।stop: जनरेशन समाप्त करने वाली स्ट्रिंग। जब आप मार्कर्स के बीच आउटपुट मांगते हैं तो यह उपयोगी है।seed: रनों के बीच दोहराव में सुधार करता है।presence_penaltyऔरfrequency_penalty: पास किए जाते हैं। सफाई के लिए उन्हें शून्य पर छोड़ दें, क्योंकि पेनल्टी मॉडल को टेबल हेडर्स जैसे दोहराए गए वैध शब्दों को बदलने के लिए प्रेरित कर सकती हैं।stream,response_format,toolsऔरtool_choice: अगले तीन अनुभागों में विस्तृत हैं।
कॉन्टेक्स्ट विंडो प्रॉम्प्ट और कंप्लीशन को मिलाकर 100,000 टोकन गिनता है, और अनुरोध बॉडी 8 MB तक हो सकती है। व्यावहारिक रूप से टोकन सीमा पहले आती है।
स्ट्रीमिंग प्रतिक्रियाएं
"stream": true सेट करें और API टेक्स्ट जनरेट होते समय सर्वर-सेंट इवेंट्स भेजता है। स्ट्रीमिंग इंटरैक्टिव टूल्स, जैसे एक एडिटर जहाँ कोई व्यक्ति साफ़ किए गए पैराग्राफ़ को देख रहा है, के लिए मददगार है। टोकन उपयोग स्ट्रीम के अंत में रिपोर्ट किया जाता है, इसलिए आप लागत को रिकॉर्ड कर सकते हैं।
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 स्ट्रिंग के रूप में वापस आते हैं। उन्हें पार्स करें, परिवर्तन लागू करें, और यदि आप बातचीत जारी रखते हैं, तो असिस्टेंट संदेश और 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 कोड का मतलब है एक साथ चल रहे बहुत सारे अनुरोध, इसलिए वर्कर्स की संख्या कम करें। Retry-After: 5 हेडर वाला 429 टेंपोररी ओवरलोड का संकेत देता है: पांच सेकंड इंतज़ार करें और फिर से भेजें। फेल और रिफ्यूज किए गए अनुरोधों पर चार्ज नहीं होता, इसलिए रीट्राई लूप सुरक्षित है।
बिलिंग प्रति टोकन है: 1M इनपुट के लिए $0.15 और 1M आउटपुट के लिए $0.50, जो प्रीपेड क्रेडिट से काटा जाता है जो कभी एक्सपायर नहीं होता। टॉप-अप राशि और बोनस के लिए प्राइसिंग पेज देखें। प्रॉम्प्ट्स को ट्रेनिंग के लिए इस्तेमाल नहीं किया जाता है। कंटेंट रूल एक ही कठोर लिमिट है: नाबालिगों से जुड़ा सेक्सुअल कंटेंट की अनुमति नहीं है। पॉलिसी के सवाल सपोर्ट को भेजें।
अधिक गाइड
प्रश्न और उत्तर
API कौन से एंडपॉइंट्स ऑफर करता है?
दो: जनरेशन के लिए POST /v1/chat/completions और मॉडल लिस्ट के लिए GET /v1/models। दोनों समान Bearer कुंजी का उपयोग करते हैं।
क्या यह स्ट्रीमिंग और फ़ंक्शन कॉलिंग को सपोर्ट करता है?
हाँ। अंत में यूसेज के साथ SSE के लिए stream को true सेट करें, और फ़ंक्शन कॉल्स के लिए tools और tool_choice का उपयोग करें, परिणाम role tool मैसेज के रूप में लौटाएं।
मैक्स इनपुट साइज़ क्या है?
कॉन्टेक्स्ट विंडो प्रॉम्प्ट और कंप्लीशन के लिए 100,000 टोकन की है, और अनुरोध बॉडी 8 MB तक हो सकती है।
मुझे 429 एरर मिला क्यों?
आपने प्रति मिनट अनुरोध (rate_limited), समानांतर अनुरोध (concurrency) में से किसी एक को पार कर लिया, या टेंपोररी ओवरलोड पर पहुंच गए, जिसमें Retry-After: 5 शामिल है। इंतज़ार करें और रीट्राई करें।
आपकी कुंजी बस एक फ़ॉर्म दूर है
एक खाता बनाएँ, कुंजी कॉपी करें, बेस URL बदलें। सेटअप यही है।