رتبهبندی مجدد اسناد
یک پرسش و ۱–۱۰۰۰ سند ارائه دهید.
در این صفحه
https://api.shareai.now/api/v1/rerankرتبهبندی مجدد اسناد
- URL پایه
https://api.shareai.now- احراز هویت
- کلید API Bearer یا توکن دسترسی OAuth تأییدشده
- دامنه مورد نیاز
inferenceormonetization_gateway
یک پرسش و ۱–۱۰۰۰ سند ارائه دهید. هر سند میتواند متن، یک {"text":"..."} شیء یا یک شیء پشتیبانیشده توسط مدل باشد. {"image":"https://..."} شیء. top_n باید حداقل ۱ و بیشتر از تعداد اسناد نباشد. نتایج را با شاخصهای سند اصلی مطابقت دهید.
قبل از شروع#
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 مورد نیاز | آرایه | ۱–۱۰۰۰ رشته متن غیرخالی یا اشیاء متن/تصویر تککلیدی. مقادیر تصویر باید URLهای HTTPS یا URLهای داده تصویر پشتیبانیشده باشند، با پشتیبانی ورودی تصویر مدل. |
top_n | عدد صحیح | تعداد نتایج اختیاری از ۱ تا تعداد اسناد. شاخصهای بازگشتی به آرایه سند اصلی اشاره دارند. |
return_documents | بولین | گنجاندن اختیاری اسناد اصلی توسط ارائهدهنده در نتیجه. |
provider | شیء | تنظیمات اختیاری ترجیحات مسیریابی ارائهدهنده. از provider.only برای برچسبهای ارائهدهنده پذیرفتهشده استفاده کنید، نه یک پیشوند در شناسه مدل. محدودیتهای حساب و اعتبار همچنان اعمال میشوند. |
خواندن نتیجه#
موفقیت با HTTP 200 و JSON بازمیگردد. یک پرسش و ۱–۱۰۰۰ سند ارائه دهید. هر سند میتواند متن، یک {"text":"..."} شیء یا یک شیء پشتیبانیشده توسط مدل باشد. {"image":"https://..."} شیء. top_n باید حداقل ۱ و بیشتر از تعداد اسناد نباشد. نتایج را با شاخصهای سند اصلی مطابقت دهید.
واحدهای صورتحساب#
نرخهای رتبهبندی مجدد میتوانند از توکنهای ورودی، اسناد امتیازدهیشده، درخواستها یا مقدار جستجوی گزارششده توسط ارائهدهنده استفاده کنند. هیچ تبدیل جهانی از جستجو به توکن فرض نمیشود. ارائهدهندهای که نمیتواند یک بعد قیمتگذاریشده را گزارش دهد برای آن تعرفه در دسترس نیست.
مدل فعال مورد نظر را از Console انتخاب کنید. عملیات اعلامشده و قابلیتهای ورودی/خروجی آن باید با این نقطه پایانی مطابقت داشته باشد؛ یک مدل چت متنی نمیتواند جایگزین عملیات دیگری شود. محدودیتهای اعتبارنامه، ارائهدهنده و حساب شما همچنان اعمال میشوند.
قیمتگذاری و استفاده#
نرخها به صورت اعتبارهای AI به یورو برای مدل انتخابشده، ارائهدهنده، واحدها و انواع منتشر میشوند. فقط ابعاد موجود در تعرفه فعال آن شارژ میشوند. یک تخمین اعتبارها را قبل از اجرا رزرو میکند؛ هزینههای نهایی بر اساس استفاده اندازهگیریشده محاسبه میشوند. قیمتها ممکن است به وضوح، فرمت خروجی یا یک باند استفاده بستگی داشته باشند. برای بدهی نهایی ShareAI، Console Usage را بررسی کنید. فیلدهای هزینه بالادستی و بایتهای رسانه به شمارش توکنهای اختراعی تبدیل نمیشوند.
دسترسی و خطاها#
استفاده کنید inference برای استنتاج هزینه شبکه تأییدشده یا monetization_gateway برای افزایش قیمت تأییدشده Builder و شرایط صورتحساب پذیرفتهشده. دسترسی فقط به هویت، مجوز هزینه کردن را نمیدهد. اعتبارسنجی، مجوز مدل، اعتبار ناکافی، محدودیت نرخ و شکستهای اجرا یک ساختار بازگشتی را برمیگردانند. error. پس از یک زمان انتظار یا ارسال نامشخص، Usage یا کار ویدیویی را بررسی کنید قبل از ایجاد درخواست دیگری که ممکن است هزینهبر باشد.
لینک به واحدهای صورتحساب