エンドポイント
リランク
POST /rerank で候補ドキュメントをクエリへの関連度順に並べ替える方法です。埋め込みで取得した 50〜200 件を上位数件に絞るリクエストとレスポンス、料金、リランクモデルの一覧、エラーを説明します。OpenAI SDK にメソッドがないため通常の HTTP で呼び出します。
プレイグラウンドで試すドキュメントのリストを、クエリへの関連度の順に並べ替えます。リランカーは検索パイプラインの 2 段目です。埋め込みまたはキーワード検索で 50〜200 件の候補を取得し、リランクして上位の数件だけをプロンプトに残します。
POST https://api14.com/api/v1/rerank
公式の OpenAI SDK にはリランクのメソッドがないため、通常の HTTP で呼び出します(以下の各言語の例もすべてそうしています)。
リクエスト
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
model | string | はい | リランクモデルの ID。例: 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 の高い順に並びます。
料金
リランクモデルは、モデルの表示価格(「$ / 1K searches」)で、検索ごとに課金されます。料金は usage.cost に含まれ、USD 残高から差し引かれます。
リランクモデルの一覧
curl "https://api14.com/api/v1/models?category=rerank"
エラー
| ステータス | コード | 発生条件 |
|---|---|---|
| 400 | model_required / invalid_json | model がない、またはボディの形式が正しくない。 |
| 402 | insufficient_balance | USD 残高が $0。 |
| 403 | model_not_allowed | キーの許可リストにモデルが含まれていない。 |
| 404 | model_not_found | モデル ID が不明、または無効化されている。 |
| 429 | rate_limited | 毎分のリクエスト数を超えた。 |
エラーを参照してください。