Endpointy
Rerank
POST /rerank: uszereguj dokumenty według trafności względem zapytania, aby poprawić wyniki wyszukiwania i jakość odpowiedzi w systemach RAG.
Wypróbuj w playgroundUszereguj listę dokumentów według trafności względem zapytania. Rerankery to drugi etap potoku wyszukiwania: pobierz 50–200 kandydatów za pomocą embeddingów lub wyszukiwania słów kluczowych, a następnie przeprowadź rerank i zostaw kilka najlepszych do swojego promptu.
POST https://api14.com/api/v1/rerank
Oficjalne SDK OpenAI nie mają metody rerank, więc wywołuj ją zwykłym HTTP (tak robi każdy przykład w poszczególnych językach poniżej).
Żądanie
| Parametr | Typ | Wymagany | Opis |
|---|---|---|---|
model | string | tak | Identyfikator modelu rerank, np. cohere/rerank-v3.5. |
query | string | tak | Zapytanie wyszukiwania. |
documents | string[] | tak | Teksty kandydatów do oceny. |
top_n | integer | nie | Zwraca tylko N najlepszych wyników. Domyślnie wszystkie. |
return_documents | boolean | nie | Dołącza tekst dokumentu do każdego wyniku. |
Przykład
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
}'
Odpowiedź
{
"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 wskazuje pozycję w Twojej tablicy documents. Wyniki są posortowane według relevance_score, od najwyższego.
Cennik
Modele rerank są rozliczane za wyszukiwanie według ceny podanej przy modelu, wyświetlanej jako "$ / 1K wyszukiwań". Koszt znajduje się w usage.cost i jest pobierany z Twojego salda w USD.
Lista modeli rerank
curl "https://api14.com/api/v1/models?category=rerank"
Błędy
| Status | Kod | Kiedy |
|---|---|---|
| 400 | model_required / invalid_json | Brak model lub nieprawidłowe ciało żądania. |
| 402 | insufficient_balance | Twoje saldo w USD wynosi 0 USD. |
| 403 | model_not_allowed | Lista dozwolonych modeli klucza wyklucza model. |
| 404 | model_not_found | Nieznany lub wyłączony identyfikator modelu. |
| 429 | rate_limited | Przekroczono limit zapytań na minutę. |
Zobacz Błędy.