AGTCloud API Docs
文件指南API Reference整合與資源更新與幫助

Rerank

使用查詢和候選文件進行相關性精排。

概述

Rerank 接收一個查詢和一組候選文件,回傳按相關性排列的結果。它通常位於向量召回、關鍵字召回或混合召回之後,用於從有限候選中選出更相關的內容。

API 串接

Base URL

https://api.agtcloud.cn/v1

執行精排

以下範例使用 Jina 風格的 POST /v1/rerank 請求。

curl 'https://api.agtcloud.cn/v1/rerank' \
  -H 'Authorization: Bearer your-api-key' \
  -H 'Content-Type: application/json' \
  --data '{
    "model": "MODEL_ID",
    "query": "API Key 應該如何儲存?",
    "documents": [
      "將 API Key 儲存在伺服器端環境變數或金鑰管理服務中。",
      "模型廣場用於檢視目前可用模型。",
      "不要把真實 API Key 寫入瀏覽器前端或公開倉庫。"
    ],
    "top_n": 2
  }'
參數必填說明
model否Rerank 模型 ID;是否可省略取決於所選格式
query是用於判斷相關性的查詢文字
documents是需要重新排序的候選文件陣列
top_n否回傳的結果數量

讀取結果

結果按相關性排列。使用 results[].index 映射回原始 documents,並從 results[].relevance_score 讀取相關性分數。

選擇請求格式

格式請求路徑API Reference
JinaPOST /v1/rerankJina Rerank
CoherePOST /v1/rerankCohere Rerank
XinferencePOST /v1/rerankXinference Rerank

理解相關性分數

  • 相關性分數不是機率。
  • 分數主要用於比較同一次請求中的候選順序。
  • 閾值和 top_n 應使用業務資料評估。

進一步了解

本頁目錄