दस्तावेज़ों को पुनः रैंक करें
एक क्वेरी और 1–1000 दस्तावेज़ प्रदान करें।.
इस पेज पर
https://api.shareai.now/api/v1/rerankदस्तावेज़ों को पुनः रैंक करें
- बेस URL
https://api.shareai.now- प्रमाणीकरण
- Bearer API कुंजी या स्वीकृत OAuth एक्सेस टोकन
- आवश्यक स्कोप
inferenceormonetization_gateway
एक क्वेरी और 1–1000 दस्तावेज़ प्रदान करें। प्रत्येक दस्तावेज़ टेक्स्ट, एक {"text":"..."} ऑब्जेक्ट या मॉडल-समर्थित {"image":"https://..."} ऑब्जेक्ट हो सकता है।. top_n कम से कम 1 और दस्तावेज़ों की कुल संख्या से अधिक नहीं होना चाहिए। परिणामों को मूल दस्तावेज़ इंडेक्स से मिलाएं।.
शुरू करने से पहले#
अपने सर्वर पर SHAREAI_API_KEY सेट करें और मॉडल प्लेसहोल्डर को वर्तमान में सक्षम मॉडल से बदलें। ब्राउज़र कोड में कभी भी API कुंजी को उजागर न करें। मॉडल, खाता, क्रेडेंशियल और प्रोवाइडर सभी को इस ऑपरेशन की अनुमति देनी चाहिए। नीचे दिए गए वैकल्पिक सेटिंग्स के लिए मॉडल समर्थन की आवश्यकता है; API सुरक्षा सीमाएँ यह वादा नहीं करतीं कि हर मॉडल हर मान का समर्थन करेगा।.
एक अनुरोध भेजें#
cURL
curl --fail-with-body --request POST "https://api.shareai.now/api/v1/rerank" \
-H "Authorization: Bearer $SHAREAI_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"model": "YOUR_ENABLED_RERANK_MODEL",
"query": "A cat",
"documents": [
{
"text": "A cat on a windowsill."
},
{
"text": "A map of Berlin."
}
],
"top_n": 1
}'Python
import json
import os
import urllib.request
payload = {'model': 'YOUR_ENABLED_RERANK_MODEL',
'query': 'A cat',
'documents': [{'text': 'A cat on a windowsill.'},
{'text': 'A map of Berlin.'}],
'top_n': 1}
headers = {'Content-Type': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["SHAREAI_API_KEY"]
request = urllib.request.Request('https://api.shareai.now/api/v1/rerank', data=json.dumps(payload).encode(), headers=headers, method="POST")
with urllib.request.urlopen(request, timeout=180) as response:
result = json.load(response)
print(result)TypeScript
const response = await fetch("https://api.shareai.now/api/v1/rerank", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.SHAREAI_API_KEY}`, ...{"Content-Type": "application/json"} },
body: JSON.stringify({
"model": "YOUR_ENABLED_RERANK_MODEL",
"query": "A cat",
"documents": [
{
"text": "A cat on a windowsill."
},
{
"text": "A map of Berlin."
}
],
"top_n": 1
}),
});
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
console.log(result);अनुरोध फ़ील्ड्स#
| फ़ील्ड | प्रकार | अर्थ और सीमाएँ |
|---|---|---|
model आवश्यक | स्ट्रिंग | सटीक सक्षम सार्वजनिक मॉडल पहचानकर्ता। इस ऑपरेशन को घोषित करना चाहिए और आपके क्रेडेंशियल द्वारा अनुमत होना चाहिए।. |
query आवश्यक | स्ट्रिंग | गैर-खाली प्रासंगिकता क्वेरी।. |
documents आवश्यक | ऐरे | 1–1000 गैर-खाली टेक्स्ट स्ट्रिंग्स या सिंगल-की टेक्स्ट/इमेज ऑब्जेक्ट्स। इमेज वैल्यू HTTPS URLs या समर्थित इमेज डेटा URLs होनी चाहिए, जिसमें मॉडल इमेज-इनपुट समर्थन हो।. |
top_n | पूर्णांक | वैकल्पिक परिणाम संख्या 1 से दस्तावेज़ों की कुल संख्या तक। लौटाए गए इंडेक्स मूल दस्तावेज़ ऐरे को संदर्भित करते हैं।. |
return_documents | बूलियन | वैकल्पिक प्रोवाइडर-समर्थित मूल दस्तावेज़ों को परिणाम में शामिल करना।. |
provider | ऑब्जेक्ट | वैकल्पिक प्रोवाइडर रूटिंग प्राथमिकताएँ। स्वीकृत प्रोवाइडर टैग के लिए provider.only का उपयोग करें, मॉडल ID में प्रीफिक्स के रूप में नहीं। खाता और क्रेडेंशियल प्रतिबंध अभी भी लागू होते हैं।. |
परिणाम पढ़ें#
सफलता HTTP 200 के साथ JSON लौटाती है। एक क्वेरी और 1–1000 दस्तावेज़ प्रदान करें। प्रत्येक दस्तावेज़ टेक्स्ट, एक {"text":"..."} ऑब्जेक्ट या मॉडल-समर्थित {"image":"https://..."} ऑब्जेक्ट हो सकता है।. top_n कम से कम 1 और दस्तावेज़ों की कुल संख्या से अधिक नहीं होना चाहिए। परिणामों को मूल दस्तावेज़ इंडेक्स से मिलाएं।.
बिलिंग इकाइयाँ#
रीरैंक दरें इनपुट टोकन, स्कोर किए गए दस्तावेज़, अनुरोध या प्रोवाइडर-रिपोर्टेड सर्च मात्रा का उपयोग कर सकती हैं। टोकन में सर्च को बदलने के लिए कोई सार्वभौमिक मान्यता नहीं है। एक प्रोवाइडर जो मूल्य निर्धारण आयाम की रिपोर्ट नहीं कर सकता, उस टैरिफ के लिए अनुपलब्ध है।.
Console से सटीक सक्षम मॉडल पहचानकर्ता चुनें। इसका घोषित ऑपरेशन और इनपुट/आउटपुट क्षमताएँ इस एंडपॉइंट से मेल खानी चाहिए; एक टेक्स्ट चैट मॉडल को किसी अन्य ऑपरेशन के लिए प्रतिस्थापित नहीं किया जा सकता। आपके क्रेडेंशियल, प्रोवाइडर और खाता प्रतिबंध अभी भी लागू होते हैं।.
मूल्य निर्धारण और उपयोग#
दरें चयनित मॉडल, प्रोवाइडर, इकाइयों और वेरिएंट के लिए EUR AI क्रेडिट में प्रकाशित की जाती हैं। केवल इसकी सक्रिय टैरिफ में शामिल आयामों का शुल्क लिया जाता है। एक अनुमान निष्पादन से पहले क्रेडिट आरक्षित करता है; अंतिम शुल्क मापे गए उपयोग का उपयोग करते हैं। कीमतें रिज़ॉल्यूशन, आउटपुट फॉर्मेट या उपयोग बैंड पर निर्भर हो सकती हैं। अंतिम ShareAI डेबिट के लिए Console Usage की जाँच करें। अपस्ट्रीम लागत फ़ील्ड और मीडिया बाइट्स को आविष्कृत टोकन गिनती में परिवर्तित नहीं किया जाता।.
एक्सेस और त्रुटियाँ#
उपयोग करें inference अनुमोदित नेटवर्क-लागत इन्फरेंस के लिए monetization_gateway अनुमोदित Builder मार्कअप और स्वीकृत बिलिंग शर्तों के लिए। केवल पहचान-आधारित एक्सेस खर्च को अधिकृत नहीं करता। सत्यापन, मॉडल प्राधिकरण, अपर्याप्त क्रेडिट, दर सीमाएँ और निष्पादन विफलताएँ एक संरचित error. लौटाती हैं। टाइमआउट या अनिश्चित सबमिशन के बाद, Usage या वीडियो जॉब का निरीक्षण करें इससे पहले कि आप एक और संभावित भुगतान अनुरोध बनाएँ।.
अंतिम अपडेट नवम्बर 3, 2026