الانتقال إلى المحتوى الرئيسي

Documentation Index

Fetch the complete documentation index at: https://docs.tokenlab.sh/llms.txt

Use this file to discover all available pages before exploring further.

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

جسم الطلب

مهلة الطلبات المتزامنة: ينتظر هذا الـ endpoint غير الخاص بالمحادثة حتى ينتهي النموذج الذي تم التوجيه إليه. قد تتجاوز المدخلات الكبيرة أو الصوت الطويل أو الدُفعات الكبيرة القيمة الافتراضية الشائعة للعميل وهي 30s، لذا اضبط مهلة عميل HTTP على 120s على الأقل.
model
string
مطلوب
معرف نموذج إعادة الترتيب (reranker) المراد استخدامه (على سبيل المثال، BAAI/bge-reranker-v2-m3 أو qwen3-rerank).
query
string
مطلوب
الاستعلام الذي سيتم ترتيب المستندات بناءً عليه. الحد الأقصى للطول: 32,000 حرف.
documents
array
مطلوب
قائمة المستندات (نصوص) المراد إعادة ترتيبها. الحدود: حتى 1,000 مستند، وكل مستند حتى 100,000 حرف، وبحد أقصى 2,000,000 حرف لجميع المستندات.
top_n
integer
عدد أفضل النتائج التي سيتم إرجاعها. القيمة الافتراضية هي جميع المستندات. يجب أن تكون القيمة 1 على الأقل وألا تتجاوز documents.length. لا تملك TokenLab حاليًا حدًا أدنى خاصًا بالمزوّد تتم إدارته؛ إذا نشر مزوّد حدًا لاحقًا، فيجب إضافته أولًا إلى حقيقة شكل طلب rerank قبل توثيقه أو فرضه.
return_documents
boolean
افتراضي:"false"
ما إذا كان سيتم تضمين نص المستند الأصلي في الاستجابة.

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

results
array
قائمة مرتبة من المستندات مع الدرجات.تحتوي كل نتيجة على:
  • index (integer): فهرس المستند الأصلي
  • relevance_score (number): درجة الصلة (0-1)
  • document (string): النص الأصلي (إذا كان return_documents=true)
model
string
النموذج المستخدم لإعادة الترتيب.
usage
object
إحصائيات استخدام الـ token.
curl -X POST "https://api.tokenlab.sh/v1/rerank" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "BAAI/bge-reranker-v2-m3",
    "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
  }'
{
  "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": "BAAI/bge-reranker-v2-m3",
  "usage": {
    "prompt_tokens": 45,
    "total_tokens": 45
  }
}