ஆவணங்களை மறுவரிசைப்படுத்தவும்
ஒரு கேள்வி மற்றும் 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 ஐ உங்கள் சர்வரில் அமைக்கவும் மற்றும் மாடல் placeholder ஐ தற்போதைய செயல்பாட்டில் உள்ள மாடலுடன் மாற்றவும். 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 தேவை | string | சரியான செயல்படுத்தப்பட்ட பொது மாடல் அடையாளம். இந்த செயல்பாட்டை அறிவிக்க வேண்டும் மற்றும் உங்கள் சான்றிதழால் அனுமதிக்கப்பட வேண்டும். |
query தேவை | string | காலியாக இல்லாத தொடர்புடைய கேள்வி. |
documents தேவை | வரிசை | 1–1000 காலியாக இல்லாத உரை சரங்கள் அல்லது ஒற்றை-முக்கிய உரை/பட பொருட்கள். பட மதிப்புகள் HTTPS URLகள் அல்லது ஆதரிக்கப்பட்ட பட தரவுப் URLகள், மாடல் பட-உள்ளீடு ஆதரவு கொண்டதாக இருக்க வேண்டும். |
top_n | முழு எண் | விருப்பமான முடிவு எண்ணிக்கை 1 முதல் ஆவணங்களின் எண்ணிக்கையளவிற்கு. திரும்பிய குறியீடுகள் மூல ஆவண வரிசையை குறிக்கின்றன. |
return_documents | பூலியன் | முடிவில் மூல ஆவணங்களை சேர்க்கும் விருப்பமான வழங்குநர்-ஆதரிக்கப்பட்ட அம்சம். |
provider | object | விருப்ப வழங்குநர் வழிமாற்று முன்னுரிமைகள். வழங்குநர்.only ஐ ஏற்றுக்கொள்ளப்பட்ட வழங்குநர் குறிச்சொற்களுக்கு பயன்படுத்தவும், மாடல் ID இல் முன்னொட்டாக அல்ல. கணக்கு மற்றும் சான்றிதழ் கட்டுப்பாடுகள் இன்னும் பொருந்தும். |
முடிவைப் படிக்கவும்#
வெற்றியானது HTTP 200 JSON உடன் திரும்பும். ஒரு கேள்வியை மற்றும் 1–1000 ஆவணங்களை வழங்கவும். ஒவ்வொரு ஆவணமும் உரை, ஒரு {"text":"..."} பொருள் அல்லது மாடல்-ஆதரிக்கப்பட்ட {"image":"https://..."} பொருள். top_n குறைந்தபட்சம் 1 ஆக இருக்க வேண்டும் மற்றும் ஆவண எண்ணிக்கையை விட அதிகமாக இருக்கக்கூடாது. முடிவுகளை மூல ஆவண குறியீடுகளுடன் பொருத்தவும்.
கட்டண அலகுகள்#
மறுவரிசை விகிதங்கள் உள்ளீடு டோக்கன்கள், மதிப்பீடு செய்யப்பட்ட ஆவணங்கள், கோரிக்கைகள் அல்லது வழங்குநர்-அறிக்கையிடப்பட்ட தேடல் அளவைப் பயன்படுத்தலாம். டோக்கனுக்கு பொதுவான தேடல் மாற்றம் எதுவும் கருதப்படவில்லை. விலைப்பட்டியலுக்கான பரிமாணத்தை அறிக்கையிட முடியாத வழங்குநர் அந்த விலைப்பட்டியலில் கிடைக்காது.
Console இல் இருந்து சரியான செயல்பாட்டில் உள்ள மாடல் அடையாளத்தைத் தேர்ந்தெடுக்கவும். அதன் அறிவிக்கப்பட்ட செயல்பாடு மற்றும் உள்ளீடு/வெளியீட்டு திறன்கள் இந்த இறுதிப்புள்ளியுடன் பொருந்த வேண்டும்; ஒரு உரை உரையாடல் மாடலை மற்றொரு செயல்பாட்டிற்கு மாற்ற முடியாது. உங்கள் சான்று, வழங்குநர் மற்றும் கணக்கு கட்டுப்பாடுகள் இன்னும் பொருந்தும்.
விலை மற்றும் பயன்பாடு#
தேர்வுசெய்யப்பட்ட மாடல், வழங்குநர், அலகுகள் மற்றும் மாறுபாடுகளுக்கான விகிதங்கள் EUR AI கிரெடிட்களில் வெளியிடப்பட்டுள்ளன. அதன் செயலில் உள்ள கட்டண அளவுகளில் உள்ள பரிமாணங்களுக்கே கட்டணம் வசூலிக்கப்படும். ஒரு மதிப்பீடு செயல்படுத்துவதற்கு முன் கிரெடிட்களை முன்பதிவு செய்கிறது; இறுதி கட்டணங்கள் அளிக்கப்பட்ட பயன்பாட்டை பயன்படுத்துகின்றன. விலைகள் தீர்மானம், வெளியீட்டு வடிவம் அல்லது பயன்பாட்டு வரம்பின் அடிப்படையில் மாறக்கூடும். இறுதி ShareAI டெபிட் விவரங்களை Console Usage-ல் சரிபார்க்கவும். மேல்நிலை செலவுகள் மற்றும் மீடியா பைட்கள் கண்டுபிடிக்கப்பட்ட டோக்கன் எண்ணிக்கைகளாக மாற்றப்படுவதில்லை.
அணுகல் மற்றும் பிழைகள்#
பயன்படுத்தவும் inference அங்கீகரிக்கப்பட்ட நெட்வொர்க்-செலவு inference க்காக அல்லது monetization_gateway அங்கீகரிக்கப்பட்ட Builder மார்க்அப் மற்றும் ஏற்றுக்கொள்ளப்பட்ட கட்டண விதிமுறைகளுக்காக. அடையாளம் மட்டும் அணுகல் செலவுகளை அங்கீகரிக்காது. சரிபார்ப்பு, மாடல் அங்கீகாரம், போதுமான கிரெடிட்கள், விகித வரம்புகள் மற்றும் செயல்பாட்டு தோல்விகள் ஒரு கட்டமைக்கப்பட்ட error. Timeout அல்லது உறுதிப்படுத்தப்படாத சமர்ப்பிப்பு பிறகு, Usage அல்லது வீடியோ வேலைகளை ஆய்வு செய்து, மற்றொரு செலவான கோரிக்கையை உருவாக்குவதற்கு முன்.
கடைசியாக புதுப்பிக்கப்பட்டது நவம்பர் 3, 2026