结果重排序

POST /v1/rerank — 根据查询对文档列表做相关性重排序

POST/v1/rerank

根据查询(query)对候选文档列表计算相关性并重新排序,常用于检索增强(RAG)中对初筛结果做精排。兼容 Jina / Cohere 风格的 rerank 协议。

鉴权:在请求头携带 Authorization: Bearer <令牌>,详见鉴权与令牌

请求参数

modelstring必填

重排序模型 ID

querystring必填

查询文本

documentsarray必填

候选文档数组,元素通常为字符串(部分模型支持对象形式)

top_ninteger

只返回相关性最高的前 N 条,缺省返回全部

return_documentsboolean

true 时在结果中回带文档原文

默认值: false
max_chunk_per_docinteger

长文档分块时每文档最大块数(需模型支持)

overlap_tokensinteger

分块重叠 token 数(需模型支持)

请求示例

# <RERANK_MODEL_ID> 例如 jina-rerank-v2,需先在模型列表确认已开通
curl https://api.jimu.chat/v1/rerank \
  -H "Authorization: Bearer $JIMU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "<RERANK_MODEL_ID>",
    "query": "如何配置鉴权",
    "documents": ["在请求头携带 Bearer 令牌", "今天天气不错", "令牌可在控制台创建"],
    "top_n": 2,
    "return_documents": true
  }'

响应结构

以下样例依据服务端响应结构定义给出(usage 部分有删减,实际返回可能包含更多字段),字段以实际返回为准:

响应200
{
  "results": [
    { "index": 0, "relevance_score": 0.95, "document": "在请求头携带 Bearer 令牌" },
    { "index": 2, "relevance_score": 0.88, "document": "令牌可在控制台创建" }
  ],
  "usage": { "prompt_tokens": 42, "total_tokens": 42 }
}
  • resultsrelevance_score(0–1,越高越相关)降序排列,index 指向原 documents 数组中的位置。
  • document 字段仅当 return_documents: true 时返回;为 false 时用 index 回原数组取原文。
  • usage 计量以服务端返回为准。
本端点可用;模型需在你的账号下已开通,未开通返回 model_not_found。示例中的 <RERANK_MODEL_ID> 为占位符,可用模型以 GET /v2/models 返回为准。