ドキュメントをリランキング

クエリに対する関連性に基づいてドキュメント一覧をリランキングします。

POST /v1/rerank

サービスルート: https://getrouter.ai

プロトコル: Rerank API

認証: Authorization: Bearer YOUR_API_KEY

リクエストボディ

リクエストボディは必須です。 メディアタイプ: application/json

リクエストフィールド

フィールド必須説明
modelstringはい
querystringはいクエリテキスト
documentsarray<string or object>はいリランキング対象のドキュメント一覧
top_nintegerいいえ上位 N 件の結果を返します。
return_documentsbooleanいいえデフォルト: false

リクエスト例

curl --request POST \
  --url https://getrouter.ai/v1/rerank \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "MODEL_ID",
  "query": "string",
  "documents": [
    "string"
  ]
}'

レスポンス

ステータス説明
200リランキングに成功

成功レスポンスのフィールド

フィールド必須説明
idstringいいえ
resultsarray<object>いいえ
metaobjectいいえ

レスポンス例

{
  "id": "string",
  "results": [
    {
      "index": 1,
      "relevance_score": 1,
      "document": {}
    }
  ],
  "meta": {}
}

関連ガイド

詳しいワークフローと例については、Rerank API ガイドを参照してください。


このページは公開 Relay OpenAPI 仕様から自動生成されています。仕様全体は API Explorer で確認できます。