APIリファレンス
リランク
クエリとの関連度に基づいて候補ドキュメントを再ランキングします。
リランク API はクエリと候補ドキュメントを受け取り、関連度でランキングされた結果を返します。RAG パイプラインでは、検索(Retrieval)の後段でよく使用されます。
エンドポイント
| メソッド | パス | 説明 |
|---|---|---|
POST | /v1/rerank | 候補ドキュメントを再ランキングします |
リクエストフィールド
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
model | string | はい | リランクモデル ID |
query | string | はい | クエリテキスト |
documents | array | はい | 候補ドキュメント(文字列またはオブジェクト) |
top_n | integer | いいえ | 上位 N 件の結果を返します |
return_documents | boolean | いいえ | 各結果に元のドキュメントを含めるかどうか。デフォルトは false |
max_chunk_per_doc | integer | いいえ | ドキュメントあたりの最大チャンク数。チャネルのサポート状況により異なります |
overlap_tokens | integer | いいえ | チャンクのオーバーラップトークン数。チャネルのサポート状況により異なります |
curl
curl https://api.tensoraxis.ai/v1/rerank \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $TENSORAXIS_API_KEY" \
-d '{
"model": "jina-reranker-v2-base-multilingual",
"query": "What is an API gateway?",
"documents": [
"An API gateway handles authentication, routing and rate limiting.",
"A vector database is used for similarity search.",
"Object storage stores files."
],
"top_n": 2,
"return_documents": true
}'レスポンス形式
{
"results": [
{
"index": 0,
"relevance_score": 0.98,
"document": "An API gateway handles authentication, routing and rate limiting."
}
],
"usage": {
"total_tokens": 42
}
}return_documents が false の場合、通常、結果には index と relevance_score のみが含まれます。