الانتقال إلى المحتوى الرئيسي
POST
/
v1
/
rerank
curl -X POST "https://api.lemondata.cc/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
  }
}
إعادة ترتيب المستندات باستخدام نماذج التشابه الدلالي (semantic similarity). مفيد لتحسين نتائج البحث وتطبيقات RAG.

جسم الطلب (Request Body)

model
string
مطلوب
معرف نموذج إعادة الترتيب (reranker) المراد استخدامه (على سبيل المثال، BAAI/bge-reranker-v2-m3 أو qwen3-rerank).
query
string
مطلوب
الاستعلام الذي سيتم ترتيب المستندات بناءً عليه.
documents
array
مطلوب
قائمة المستندات (نصوص) المراد إعادة ترتيبها.
top_n
integer
عدد أفضل النتائج التي سيتم إرجاعها. القيمة الافتراضية هي جميع المستندات.
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.lemondata.cc/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
  }
}

الجسم

application/json
model
string
مطلوب

معرف نموذج إعادة الترتيب (reranker) المراد استخدامه (على سبيل المثال، BAAI/bge-reranker-v2-m3 أو qwen3-rerank ).

query
string
مطلوب

الاستعلام الذي سيتم ترتيب المستندات بناءً عليه.

documents
object[]
مطلوب

قائمة المستندات (نصوص) المراد إعادة ترتيبها.

top_n
integer

عدد أفضل النتائج التي سيتم إرجاعها. القيمة الافتراضية هي جميع المستندات.

return_documents
boolean

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

الاستجابة

200 - application/json

Response 200

results
object[]

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

model
string

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

usage
object

إحصائيات استخدام الـ token.