نقاط النهاية
إعادة الترتيب (Rerank)
نقطة النهاية POST /rerank ترتّب قائمة مستندات بحسب صلتها باستعلام، وتُستخدم كمرحلة ثانية في البحث وRAG بعد جلب المرشحين بالمتجهات.
جرّبه في ساحة التجربةرتّب قائمة مستندات بحسب صلتها باستعلام. تمثل نماذج إعادة الترتيب المرحلة الثانية في مسار البحث: اجلب من 50 إلى 200 مرشح عبر embeddings أو البحث بالكلمات المفتاحية، ثم أعد ترتيبها واحتفظ بأفضل القليل منها لمطالبتك.
POST https://api14.com/api/v1/rerank
ليس في OpenAI SDK الرسمية دالة rerank، لذا استدعِها بـ HTTP مباشرة (وكل مثال بلغة أدناه يفعل ذلك).
الطلب
| المعامل | النوع | مطلوب | الوصف |
|---|---|---|---|
model | string | نعم | معرّف نموذج rerank، مثل cohere/rerank-v3.5. |
query | string | نعم | استعلام البحث. |
documents | string[] | نعم | النصوص المرشحة المراد تقييمها. |
top_n | integer | لا | أعِد أفضل N نتيجة فقط. الافتراضي كلها. |
return_documents | boolean | لا | تضمين نص المستند في كل نتيجة. |
مثال
import OpenAI from "openai";
const client = new OpenAI({
baseURL: "https://api14.com/api/v1",
apiKey: process.env.API14_API_KEY,
});
const result = await client.post("/rerank", { body: {
"model": "cohere/rerank-v3.5",
"query": "What is the capital of France?",
"documents": [
"Paris is the capital of France.",
"Berlin is in Germany."
],
"top_n": 1
} });
console.log(result.results);
curl https://api14.com/api/v1/rerank \
-H "Authorization: Bearer sk-api14-..." \
-H "Content-Type: application/json" \
-d '{
"model": "cohere/rerank-v3.5",
"query": "How do I reset my password?",
"documents": [
"Billing happens on the first of each month.",
"To reset your password, open Settings and choose Security.",
"Our office is closed on public holidays."
],
"top_n": 2
}'
الاستجابة
{
"id": "gen-1791100000-rr1",
"model": "cohere/rerank-v3.5",
"results": [
{ "index": 1, "relevance_score": 0.94 },
{ "index": 0, "relevance_score": 0.08 }
],
"usage": { "search_units": 1, "cost": 0.002 }
}
يشير index إلى موضع المستند في مصفوفة documents. تُرتَّب النتائج بحسب relevance_score من الأعلى إلى الأدنى.
الأسعار
تُحاسَب نماذج rerank لكل عملية بحث بسعر النموذج المعلن، ويظهر بصيغة "$ / 1K searches". التكلفة في usage.cost وتُخصم من رصيدك بالدولار.
عرض نماذج rerank
curl "https://api14.com/api/v1/models?category=rerank"
الأخطاء
| الحالة | الرمز | متى يحدث |
|---|---|---|
| 400 | model_required / invalid_json | model مفقود أو الجسم غير صالح. |
| 402 | insufficient_balance | رصيدك بالدولار يساوي 0. |
| 403 | model_not_allowed | قائمة المفتاح المسموح بها تستبعد النموذج. |
| 404 | model_not_found | معرّف نموذج غير معروف أو معطّل. |
| 429 | rate_limited | تجاوز عدد الطلبات في الدقيقة. |
راجع الأخطاء.