88API88API
使用指南AI 應用API 文件幫助支援
重排序(Rerank)

Jina AI 重排序格式(Rerank)

官方文件

標準格式

在88API中,Jina AI的rerank格式被採用為標準格式。所有其他供應商(如Xinference、Cohere等)的rerank響應都會被格式化為Jina AI的格式,以提供統一的開發體驗。

📝 簡介

Jina AI Rerank 是一個強大的文字重排序模型,可以根據查詢對文件列表進行相關性排序。該模型支援多語言,可以處理不同語言的文字內容,併為每個文件分配相關性分數。

💡 請求示例

基礎重排序請求 ✅

curl https://88api.ai/v1/rerank \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $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 $API_KEY

其中 $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: 伺服器內部錯誤

💡 最佳實踐

查詢最佳化建議

  1. 使用清晰具體的查詢文字
  2. 避免過於寬泛或模糊的查詢
  3. 確保查詢與文件使用相同的語言風格

文件處理建議

  1. 保持文件長度適中,不要超過模型限制
  2. 確保文件內容完整且有意義
  3. 可以包含多語言文件,模型支援跨語言匹配

效能最佳化

  1. 合理設定 top_n 引數以減少不必要的計算
  2. 對於大量文件,考慮分批處理
  3. 可以快取常用查詢的結果

多語言支援

該模型支援多種語言的文件重排序,包括但不限於:

  • 英語
  • 中文
  • 德語
  • 西班牙語
  • 日語
  • 法語

無需指定語言引數,模型會自動識別和處理不同語言的內容。