Skip to content
On this page

Rerank 重排接入

Rerank 用于把一批候选文档按用户查询重新排序,常见于 RAG、搜索、知识库问答和推荐场景。

接口信息

配置项填写内容
Endpointhttps://api.corerouter.tech/v1/rerank
HeaderAuthorization: Bearer sk-...
必填字段model、query、documents
返回字段results,每项通常包含 index、relevance_score,可选 document
模型要求控制台中支持 Rerank 的 Model ID

最小请求

bash
export COREROUTER_API_KEY="sk-xxxxxxxxxxxxxxxx"

curl https://api.corerouter.tech/v1/rerank \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $COREROUTER_API_KEY" \
  -d '{
    "model": "rerank-model-id",
    "query": "如何配置 API Key?",
    "documents": [
      "在控制台创建 API Key,并通过 Authorization Header 发送。",
      "图片生成需要选择图片模型。",
      "Base URL 通常填写 https://api.corerouter.tech/v1。"
    ],
    "top_n": 2,
    "return_documents": true
  }'

字段说明

字段是否必填说明
model是控制台中的 Rerank 模型 ID。
query是用户查询或检索问题。
documents是候选文档数组,可以是字符串,也可以是模型/渠道支持的文档对象。
top_n否只返回前 N 个结果。
return_documents否是否在结果里返回原文档。
max_chunk_per_doc否长文档切块相关参数,是否生效取决于渠道。
overlap_tokens否长文档切块重叠 token 数,是否生效取决于渠道。

返回示例

json
{
  "results": [
    {
      "index": 0,
      "relevance_score": 0.93,
      "document": "在控制台创建 API Key,并通过 Authorization Header 发送。"
    },
    {
      "index": 2,
      "relevance_score": 0.81,
      "document": "Base URL 通常填写 https://api.corerouter.tech/v1。"
    }
  ],
  "usage": {
    "prompt_tokens": 123,
    "total_tokens": 123
  }
}

RAG 推荐流程

  1. 使用 Embeddings 从向量库召回 20 到 100 条候选文档。
  2. 用 Rerank 按用户问题重排候选文档。
  3. 取前 3 到 10 条作为 Chat Completions 或 Responses 的上下文。
  4. 最终回答时保留引用来源,方便用户核对。

常见问题

  • query is empty:请求体缺少 query 或值为空。
  • documents is empty:请求体缺少 documents,或数组为空。
  • model not found:不要使用聊天模型 ID,请使用支持 Rerank 的模型。
  • 分数看起来不稳定:检查候选文档是否太长、是否包含无关内容,以及 Embeddings 召回质量。

Released under the MIT License.