テキスト
ドキュメントのリランク
クエリに対する関連度に基づいてドキュメントをリランクします
現在のリランクモデルの一覧を取得するには、GET /v1/models?recommended_for=rerank を使用してください。詳細情報に rerank オペレーションが記載されているモデルを使用します。
意味的類似度モデルを使用してドキュメントをリランクします。検索結果の改善や RAG アプリケーションに役立ちます。
リクエストボディ
このエンドポイントは、ランキング処理が完了した後にレスポンスを返します。大規模なドキュメントセットの場合は、HTTP クライアントのタイムアウトを少なくとも 120s に設定してください。
使用するリランカーモデルの ID(例: qwen3-vl-rerank)。
ドキュメントのランク付け対象となるクエリ。最大長: 32,000 文字。
リランクするドキュメント(文字列)のリスト。制限事項: 最大 1,000 件のドキュメント、各ドキュメント最大 100,000 文字、ドキュメントの合計文字数は最大 2,000,000 文字。
返す上位結果の件数(1 から documents.length まで)。省略した場合、選択されたモデルによって結果の件数が決定されます。
false各結果に元のドキュメントテキストを含めるかどうか。モデルの詳細情報に return_documents が記載されている場合にのみ送信してください。
レスポンス
スコアが付与されたドキュメントのランク付けリスト。
各結果には以下が含まれます:
index(integer): 元のドキュメントのインデックスrelevance_score(number): 関連度スコア。スコアの範囲は選択されたモデルによって異なります。document(string): 元のテキスト(return_documents=trueの場合)
リランクに使用されたモデル(利用可能な場合)。
リクエストに対して報告された使用量(利用可能な場合): total_tokens、または検索ごとに課金されるモデルの場合は search_units。
リクエスト
curl -X POST "https://api.tokenlab.sh/v1/rerank" \
-H "Authorization: Bearer sk-your-api-key" \
-H "Content-Type: application/json" \
-d '{
"model": "qwen3-vl-rerank",
"query": "What is machine learning?",
"documents": [
"Machine learning is a subset of AI",
"The weather is nice today",
"Deep learning uses neural networks"
],
"top_n": 2,
"return_documents": true
}'レスポンス
{
"results": [
{
"index": 0,
"relevance_score": 0.95,
"document": "Machine learning is a subset of AI"
},
{
"index": 2,
"relevance_score": 0.82,
"document": "Deep learning uses neural networks"
}
],
"model": "qwen3-vl-rerank",
"usage": {
"total_tokens": 45
}
}エラー
| ステータス | コード | 原因 |
|---|---|---|
400 | invalid_request | フィールドが欠落しているか、空であるか、または上記の制限を超えています。該当するフィールドは param で示されます |
400 | unsupported_endpoint | モデルがこのエンドポイントに対応していません |
その他のステータスについては、APIエラーの処理 を参照してください。
認証
BearerAuth APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。
場所: header
ヘッダー
リクエストごとの配信ポリシー。APIキーおよびWorkspaceのデフォルト設定を上書きします。自動的にまず TokenLab Verified を試行し、出力、リクエストの受け入れ、または永続的なリソース作成の前に、一度だけ Official に切り替える場合があります。
指定できる値
- "auto"
- "verified"
- "official"
リクエストボディ
application/json
レスポンス
application/json
application/json
application/json
application/json
application/json
application/json
application/json