ShareAI Platform Docs

دستاویزات کو دوبارہ ترتیب دیں

ایک سوال اور 1–1000 دستاویزات فراہم کریں۔.

Markdown کے طور پر دیکھیں
اس صفحے پر
POST https://api.shareai.now/api/v1/rerank

دستاویزات کو دوبارہ ترتیب دیں

بیس URL
https://api.shareai.now
تصدیق
Bearer API کلید یا منظور شدہ OAuth ایکسیس ٹوکن
مطلوبہ اسکوپ
inference or monetization_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
}'

درخواست کے فیلڈز#

فیلڈقسممعنی اور حدود
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 اور دستاویزات کی تعداد سے زیادہ نہیں ہونا چاہیے۔ نتائج کو اصل دستاویز کے اشاریہ جات سے ملائیں۔.

بلنگ یونٹس#

دوبارہ ترتیب دینے کی شرحیں ان پٹ ٹوکنز، اسکور شدہ دستاویزات، درخواستوں یا فراہم کنندہ کی رپورٹ کردہ تلاش کی مقدار استعمال کر سکتی ہیں۔ ٹوکن میں تلاش کی عالمی تبدیلی فرض نہیں کی جاتی۔ ایک فراہم کنندہ جو قیمت شدہ جہت کی رپورٹ نہیں کر سکتا، اس ٹیرف کے لیے دستیاب نہیں ہے۔.

کنسول سے درست فعال ماڈل شناخت کنندہ منتخب کریں۔ اس کا اعلان کردہ آپریشن اور ان پٹ/آؤٹ پٹ صلاحیتیں اس اینڈپوائنٹ سے مطابقت رکھنی چاہئیں؛ ایک ٹیکسٹ چیٹ ماڈل کو کسی دوسرے آپریشن کے لیے تبدیل نہیں کیا جا سکتا۔ آپ کی اسناد، پرووائیڈر اور اکاؤنٹ کی پابندیاں اب بھی لاگو ہوتی ہیں۔.

قیمتیں اور استعمال#

شرحیں منتخب ماڈل، پرووائیڈر، یونٹس اور ویریئنٹس کے لیے EUR AI کریڈٹس میں شائع کی جاتی ہیں۔ صرف اس کے فعال ٹیرف میں موجود ڈائمینشنز چارج کی جاتی ہیں۔ ایک تخمینہ عمل درآمد سے پہلے کریڈٹس محفوظ کرتا ہے؛ حتمی چارجز ماپی گئی استعمال پر مبنی ہوتے ہیں۔ قیمتیں ریزولوشن، آؤٹ پٹ فارمیٹ یا استعمال کے بینڈ پر منحصر ہو سکتی ہیں۔ حتمی ShareAI ڈیبٹ کے لیے کنسول استعمال چیک کریں۔ اپ اسٹریم لاگت کے فیلڈز اور میڈیا بائٹس کو ایجاد کردہ ٹوکین گنتی میں تبدیل نہیں کیا جاتا۔.

رسائی اور غلطیاں#

استعمال کریں inference منظور شدہ نیٹ ورک-لاگت انفرنس کے لیے یا monetization_gateway منظور شدہ بلڈر مارک اپ اور قبول شدہ بلنگ شرائط کے لیے۔ صرف شناختی رسائی خرچ کی اجازت نہیں دیتی۔ توثیق، ماڈل کی اجازت، ناکافی کریڈٹس، شرح کی حدود اور عمل درآمد کی ناکامیوں کے نتیجے میں ایک ساختہ error. ٹائم آؤٹ یا غیر یقینی جمع کرانے کے بعد، ایک اور ممکنہ طور پر ادا شدہ درخواست بنانے سے پہلے استعمال یا ویڈیو جاب کا معائنہ کریں۔.

آخری بار اپ ڈیٹ کیا گیا نومبر 3, 2026

ShareAI پلیٹ فارم دستاویزات
تمام دستاویزات

عنوان یا مواد کے ذریعے تلاش کریں۔

اس صفحے کے بارے میں پوچھیں

اس صفحے کو دریافت کرنے کے لیے ایک معاون منتخب کریں۔ آپ صفحہ کو کاپی کر کے اپنی گفتگو میں چسپاں بھی کر سکتے ہیں۔

Ask ChatGPTAsk ClaudeAsk GrokAsk ShareAI