النص

إعادة ترتيب المستندات

إعادة ترتيب المستندات حسب صلتها باستعلام

POST
/v1/rerank

استخدم GET /v1/models?recommended_for=rerank لعرض نماذج rerank الحالية. استخدم نموذجاً تدرج تفاصيله عملية rerank.

إعادة ترتيب المستندات باستخدام نماذج التشابه الدلالي. مفيد لتحسين نتائج البحث وتطبيقات RAG.

جسم الطلب

تعود نقطة النهاية هذه بعد انتهاء عملية الترتيب. بالنسبة لمجموعات المستندات الكبيرة، اضبط مهلة عميل HTTP على 120s على الأقل.

modelstringمطلوب

معرّف نموذج reranker المراد استخدامه (مثل qwen3-vl-rerank).

querystringمطلوب

الاستعلام المراد ترتيب المستندات بناءً عليه. الحد الأقصى للطول: 32,000 حرف.

documentsarrayمطلوب

قائمة المستندات (سلاسل نصية) المراد إعادة ترتيبها. الحدود: حتى 1,000 مستند، وكل مستند حتى 100,000 حرف، وبحد أقصى 2,000,000 حرف إجمالي للمستندات.

top_ninteger

عدد أفضل النتائج المراد إرجاعها، من 1 إلى documents.length. في حال حذفه، يحدد النموذج المحدد عدد النتائج.

return_documentsbooleanالافتراضي: false

ما إذا كان سيتم تضمين نص المستند الأصلي في كل نتيجة. أرسله فقط عندما تدرج تفاصيل النموذج return_documents.

الاستجابة

resultsarray

قائمة مرتبة من المستندات مع درجات التقييم.

تحتوي كل نتيجة على:

  • index (integer): فهرس المستند الأصلي
  • relevance_score (number): درجة الصلة. يعتمد نطاقها على النموذج المحدد.
  • document (string): النص الأصلي (إذا كانت return_documents=true)
modelstring

النموذج المستخدم لإعادة الترتيب. عندما يكون متاحاً.

usageobject

الاستخدام المُسجَّل للطلب، عندما يكون متاحاً: total_tokens، أو search_units للنماذج التي تتم محاسبتها لكل عملية بحث.

الطلب

curl -X POST "https://api.tokenlab.sh/v1/rerank" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "qwen3-vl-rerank",
    "query": "What is machine learning?",
    "documents": [
      "Machine learning is a subset of AI",
      "The weather is nice today",
      "Deep learning uses neural networks"
    ],
    "top_n": 2,
    "return_documents": true
  }'

الاستجابة

Response
{
  "results": [
    {
      "index": 0,
      "relevance_score": 0.95,
      "document": "Machine learning is a subset of AI"
    },
    {
      "index": 2,
      "relevance_score": 0.82,
      "document": "Deep learning uses neural networks"
    }
  ],
  "model": "qwen3-vl-rerank",
  "usage": {
    "total_tokens": 45
  }
}

الأخطاء

الحالةالرمزالسبب
400invalid_requestحقل مفقود أو فارغ أو يتجاوز حداً مذكوراً أعلاه. يحدد param اسمه
400unsupported_endpointالنموذج غير منشور لنقطة النهاية هذه

تعامل مع الحالات الأخرى كما هو موضح في التعامل مع أخطاء API.

التفويض

BearerAuth
AuthorizationBearer <token>

مصادقة مفتاح API. قم بإنشاء أو إدارة مفاتيح API في Dashboard > API > API Keys.

الموضع: header

الترويسات

X-TokenLab-Delivery-Policy?string

سياسة التسليم لكل طلب. تتجاوز إعدادات API key و Workspace الافتراضية. يحاول النظام تلقائياً استخدام TokenLab Verified أولاً، وقد ينتقل مرة واحدة إلى Official فقط قبل المخرجات، أو قبول الطلب، أو إنشاء مورد دائم.

القيم المتاحة

  • "auto"
  • "verified"
  • "official"

جسم الطلب

application/json

الاستجابة

application/json

application/json

application/json

application/json

application/json

application/json

application/json