创建重排序请求

Endpoint

POST /rerank

完整地址:

https://router.tumuer.me/v1/rerank

请求头

Header必填说明
AuthorizationBearer <api_key>
Content-Typeapplication/json

请求体(JSON)

字段类型必填说明
modelstring重排序模型名称(以控制台模型列表为准)
querystring查询文本
documentsstring[]需要重排的文档列表(目前仅支持字符串数组)
top_nnumber返回最相关的前 N 条
return_documentsboolean是否在结果中返回原始文档文本
instructionstring重排序指令(部分模型支持)
max_chunks_per_docnumber长文切分的最大 chunk 数(部分模型支持)
overlap_tokensnumberchunk 之间的 token 重叠(部分模型支持)
常见用法

例如:只返回索引/分数(return_documents: false)、不同 top_n 策略等,见 代码示例

返回体(JSON)

字段类型说明
idstring请求 ID
resultsArray<{ index: number; relevance_score: number; document?: { text: string } }>重排结果
metaobject[]元信息(如 tokens 统计)

请求示例

Python(openai SDK,自定义请求)
JavaScript(openai SDK,自定义请求)
Python(requests)
cURL
from openai import OpenAI
import httpx
import os

client = OpenAI(
    base_url="https://router.tumuer.me/v1",
    api_key=os.environ["OPENAI_API_KEY"],
)

resp = client.post(
    "/rerank",
    cast_to=httpx.Response,
    body={
        "model": "Pro/BAAI/bge-reranker-v2-m3",
        "query": "Apple",
        "documents": ["apple", "banana", "fruit", "vegetable"],
        "top_n": 4,
        "return_documents": True,
        "max_chunks_per_doc": 1024,
        "overlap_tokens": 80,
    },
)

resp.raise_for_status()
print(resp.json())