النص

إعادة ترتيب المستندات (Rerank Documents)

إعادة ترتيب المستندات بناءً على مدى صلتها بالاستعلام

POST
/v1/rerank

إعادة ترتيب المستندات باستخدام نماذج التشابه الدلالي (semantic similarity). مفيد لتحسين نتائج البحث وتطبيقات 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

ما إذا كان سيتم تضمين نص المستند الأصلي في الاستجابة.

الاستجابة (Response)

resultsarray

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

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

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

النموذج المستخدم لإعادة الترتيب. يُعاد عند توفره.

usageobject

إحصائيات استخدام الـ token. يُعاد عند توفره.

الطلب

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": {
    "prompt_tokens": 45,
    "total_tokens": 45
  }
}

التفويض

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