Jina AIのリランク形式（Rerank）

Jina AI リランキング形式（Rerank）

本ページの概要

公式ドキュメント

Jina AI Rerank

標準形式

4All API API では、Jina AI の rerank 形式が標準形式として採用されています。Xinference や Cohere など、他のすべてのベンダーの rerank レスポンスは Jina AI の形式に整形され、統一された開発体験を提供します。

📝 はじめに

Jina AI Rerank は、クエリに基づいて文書リストの関連度を並べ替える強力なテキスト再ランキングモデルです。このモデルは多言語に対応しており、さまざまな言語のテキストを処理でき、各文書に関連度スコアを付与します。

💡 リクエスト例

基本的なリランキングリクエスト ✅

curl https://4All API地址/v1/rerank \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $4All API_API_KEY" \
  -d '{
    "model": "jina-reranker-v2-base-multilingual",
    "query": "Organic skincare products for sensitive skin",
    "top_n": 3,
    "documents": [
      "Organic skincare for sensitive skin with aloe vera and chamomile...",
      "New makeup trends focus on bold colors and innovative techniques...",
      "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."
    ]
  }'

レスポンス例:

{
  "results": [
    {
      "document": {
        "text": "Organic skincare for sensitive skin with aloe vera and chamomile..."
      },
      "index": 0,
      "relevance_score": 0.8783142566680908
    },
    {
      "document": {
        "text": "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."
      },
      "index": 2,
      "relevance_score": 0.7624675869941711
    }
  ],
  "usage": {
    "prompt_tokens": 815,
    "completion_tokens": 0,
    "total_tokens": 815
  }
}

📮 リクエスト

エンドポイント

POST /v1/rerank

認証方法

API キー認証を行うには、リクエストヘッダーに以下を含めます。

Authorization: Bearer $4All API_API_KEY

ここでの $4All API_API_KEY は、あなたの API キーです。

リクエストボディのパラメータ

model

型：文字列
必須：いいえ
デフォルト値：jina-reranker-v2-base-multilingual
説明：使用するリランキングモデル

query

型：文字列
必須：はい
説明：文書を関連度順に並べ替えるためのクエリテキスト

top_n

型：整数
必須：いいえ
デフォルト値：制限なし
説明：並べ替え後の上位 N 件の文書を返します

documents

型：文字列配列
必須：はい
説明：リランキング対象の文書リスト
制限：各文書の長さはモデルの最大 token 制限を超えないようにしてください

📥 レスポンス

成功レスポンス

results

型：配列
説明：リランキングされた文書リスト
属性：
document : 文書テキストを含むオブジェクト
index : 元のリストにおける文書のインデックス
relevance_score : 関連度スコア（0〜1）

usage

型：オブジェクト
説明：token 使用状況の統計
属性：
prompt_tokens : プロンプトで使用された token 数
completion_tokens : 補完で使用された token 数
total_tokens : 合計 token 数
prompt_tokens_details : プロンプト token の詳細情報 cached_tokens : キャッシュされた token 数 audio_tokens : 音声 token 数
completion_tokens_details : 補完 token の詳細情報 reasoning_tokens : 推論 token 数 audio_tokens : 音声 token 数 accepted_prediction_tokens : 受け入れられた予測 token 数 rejected_prediction_tokens : 拒否された予測 token 数

エラーレスポンス

リクエストに問題がある場合、API はエラーレスポンスを返します。

400 Bad Request : リクエストパラメータが無効
401 Unauthorized : API キーが無効、または未提供
429 Too Many Requests : リクエスト頻度の上限超過
500 Internal Server Error : サーバー内部エラー

💡 ベストプラクティス

クエリ最適化のヒント

明確で具体的なクエリテキストを使う
あまりに広すぎる、または曖昧すぎるクエリは避ける
クエリと文書で同じ言語スタイルを使うようにする

文書処理のヒント

文書の長さは適度に保ち、モデルの制限を超えないようにする
文書内容が完全で意味のあるものになっていることを確認する
多言語文書を含めることも可能で、モデルはクロスリンガルのマッチングに対応しています

パフォーマンス最適化

不要な計算を減らすために top_n パラメータを適切に設定する
大量の文書を扱う場合は、分割処理を検討する
よく使うクエリの結果はキャッシュできる

多言語対応

このモデルは、以下を含む多言語の文書リランキングに対応しています。

英語
中国語
ドイツ語
スペイン語
日本語
フランス語

言語パラメータを指定する必要はなく、モデルが異なる言語の内容を自動的に識別して処理します。