Endpoint
Rerank
POST /rerank mengurutkan dokumen berdasarkan relevansi terhadap sebuah query, sebagai tahap kedua pada pipeline pencarian dan RAG.
Coba di playgroundUrutkan daftar dokumen berdasarkan relevansinya terhadap sebuah query. Reranker adalah tahap kedua dalam pipeline pencarian: ambil 50–200 kandidat dengan embeddings atau pencarian kata kunci, lalu rerank dan simpan beberapa teratas untuk prompt Anda.
POST https://api14.com/api/v1/rerank
OpenAI SDK resmi tidak memiliki method rerank, jadi panggil dengan HTTP biasa (setiap contoh bahasa di bawah melakukannya).
Request
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
model | string | ya | ID model rerank, mis. cohere/rerank-v3.5. |
query | string | ya | Query pencarian. |
documents | string[] | ya | Teks kandidat yang akan diberi skor. |
top_n | integer | tidak | Kembalikan hanya N hasil terbaik. Default semuanya. |
return_documents | boolean | tidak | Sertakan teks dokumen pada setiap hasil. |
Contoh
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
}'
Respons
{
"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 menunjuk ke array documents Anda. Hasil diurutkan berdasarkan relevance_score, dari yang tertinggi.
Harga
Model rerank ditagih per pencarian sesuai harga model yang tercantum, ditampilkan sebagai "$ / 1K pencarian". Biayanya ada di usage.cost dan dipotong dari saldo USD Anda.
Menampilkan daftar model rerank
curl "https://api14.com/api/v1/models?category=rerank"
Error
| Status | Kode | Kapan |
|---|---|---|
| 400 | model_required / invalid_json | model tidak ada atau body salah format. |
| 402 | insufficient_balance | Saldo USD Anda $0. |
| 403 | model_not_allowed | Allowlist key tidak mencakup model ini. |
| 404 | model_not_found | ID model tidak dikenal atau dinonaktifkan. |
| 429 | rate_limited | Batas request per menit terlampaui. |
Lihat Error.