テキスト

ドキュメントの再ランク付け

クエリに対する関連性に基づいてドキュメントを再ランク付けします

POST
/v1/rerank

意味的類似性モデルを使用してドキュメントを再ランク付けします。検索結果の改善や RAG アプリケーションに役立ちます。

リクエストボディ

入力が大きい場合、HTTP クライアントのタイムアウトを少なくとも 120s に設定してください。処理完了後にレスポンスを返します。

modelstring必須

使用するリランカーモデルの ID(例:qwen3-vl-rerank)。

querystring必須

ドキュメントをランク付けするためのクエリ。最大長は 32,000 文字です。

documentsarray必須

再ランク付けするドキュメント(文字列)のリスト。上限は最大 1,000 件、各ドキュメント最大 100,000 文字、ドキュメント合計最大 2,000,000 文字です。

top_ninteger

返す上位結果数。1 以上、documents.length 以下です。省略時の件数は選択したモデルに依存します。

return_documentsbooleanデフォルト: false

レスポンスに元のドキュメントテキストを含めるかどうか。

レスポンス

resultsarray

スコア順にランク付けされたドキュメントのリスト。

各結果には以下が含まれます:

  • index (integer): 元のドキュメントのインデックス
  • relevance_score (number): 関連性スコア。範囲は選択したモデルによって異なります。
  • document (string): 元のテキスト(return_documents=true の場合)
modelstring

再ランク付けに使用されたモデル。 利用可能な場合に返されます。

usageobject

トークン使用統計。 利用可能な場合に返されます。

リクエスト

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
  }'

レスポンス

Response
{
  "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": {
    "prompt_tokens": 45,
    "total_tokens": 45
  }
}

認証

BearerAuth
AuthorizationBearer <token>

APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。

場所: header

ヘッダー

X-TokenLab-Delivery-Policy?string

リクエストごとの配信ポリシー。APIキーおよびWorkspaceのデフォルト設定を上書きします。自動的にまず TokenLab Verified を試行し、出力、リクエストの受け入れ、または永続的なリソース作成の前に、一度だけ Official に切り替える場合があります。

指定できる値

  • "auto"
  • "verified"
  • "official"

リクエストボディ

application/json

レスポンス

application/json

application/json

application/json

application/json