दस्तऐवजांचे पुनःक्रमांकन करा
एक क्वेरी आणि 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 वापरा, मॉडेल आयडीमध्ये उपसर्ग म्हणून नाही. खाते आणि क्रेडेन्शियल निर्बंध अद्याप लागू होतात. |
परिणाम वाचा#
यशस्वीतेसाठी 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