API リファレンス

リランク

対応モデルはまだありません

現在、モデル一覧にこのルートに対応するモデルはありません。このページは参考として残しています。
POST/v1/rerank

1 つのクエリに対して候補ドキュメントのリストをスコアリングします。結果は関連度の高い順に返され、各ドキュメントの元のインデックスが保持されます。

#リクエストパラメーター

  • modelstring必須

    リアルタイムのモデル一覧にある、リランクモデルの正確な識別子。

  • querystring必須

    候補のスコアリングに使う検索クエリまたは質問。

  • documentsstring[]必須

    ランク付けする候補の文章。アプリケーション側では元の順序を保持してください。

  • top_ninteger任意

    返すランク付け結果の最大件数。

  • return_documentsboolean任意

    対応している場合、各結果にドキュメントのテキストを含めます。

#関連するエラー

  • 400 invalid_request_errorquery または documents がない、空である、またはこのモデルが対応していません。
  • 401Bearer トークンが無効か、ありません。このパスでは error.code が付きません — ステータスで判定してください。
  • 402 insufficient_user_quotaウォレット残高が事前確保の見積額に足りません。
  • 429キー単位のレート制限です。ボディは空なので、Retry-After の時間だけ待ってください。insufficient_user_quota が付いた 429 は、レート制限ではなく 1 日の利用上限額によるものです。
  • 503 model_not_found不明なモデルか、現在そのモデルを提供できる正常なチャネルがありません。

エラーコード一覧 →

#リクエスト例

curl https://www.aisplice.store/v1/rerank \
  -H "Authorization: Bearer sk-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "YOUR_RERANK_MODEL",
    "query": "What is the capital of France?",
    "documents": [
      "Paris is the capital of France.",
      "Berlin is in Germany."
    ],
    "top_n": 2
  }'

#レスポンス

response.json
{
  "results": [
    { "index": 0, "relevance_score": 0.9821 },
    { "index": 1, "relevance_score": 0.1034 }
  ]
}

まだ解決しませんか?

リクエスト ID かエラーメッセージを送っていただければ、こちらで調査します。