文本
重排序文档
根据与查询的相关性对文档进行重排序
通过 GET /v1/models?recommended_for=rerank 查看当前重排序模型。请使用模型详情中列出 rerank 操作的模型。
根据查询内容重新排列文档,常用于搜索和 RAG。
请求体
输入较多时,请将 HTTP 客户端超时设为至少 120s;接口会在处理完成后返回。
要使用的重排序模型 ID(例如 qwen3-vl-rerank)。
用于对文档进行排序的查询语句。最大长度:32,000 个字符。
需要重排序的文档列表(字符串数组)。限制:最多 1,000 篇文档;每篇最多 100,000 个字符;所有文档合计最多 2,000,000 个字符。
返回的前若干个结果,范围为 1 到 documents.length。省略时由所选模型决定返回数量。
false是否在每个结果中包含原始文档文本。仅当模型详情列出 return_documents 时才发送。
响应
已按相关性排列的结果。
每个结果包含:
index(integer): 原始文档索引relevance_score(number): 相关性评分,取值范围由所选模型决定。document(string): 原始文本(如果return_documents=true)
用于重排序的模型。 可用时返回。
请求的用量(可用时返回):total_tokens,按搜索次数计费的模型则为 search_units。
请求
curl -X POST "https://api.tokenlab.sh/v1/rerank" \
-H "Authorization: Bearer sk-your-api-key" \
-H "Content-Type: application/json" \
-d '{
"model": "qwen3-vl-rerank",
"query": "What is machine learning?",
"documents": [
"Machine learning is a subset of AI",
"The weather is nice today",
"Deep learning uses neural networks"
],
"top_n": 2,
"return_documents": true
}'响应
{
"results": [
{
"index": 0,
"relevance_score": 0.95,
"document": "Machine learning is a subset of AI"
},
{
"index": 2,
"relevance_score": 0.82,
"document": "Deep learning uses neural networks"
}
],
"model": "qwen3-vl-rerank",
"usage": {
"total_tokens": 45
}
}错误
| 状态码 | 代码 | 原因 |
|---|---|---|
400 | invalid_request | 字段缺失、为空,或超过上述限制,param 指出该字段 |
400 | unsupported_endpoint | 该模型未开放此端点 |
其他状态码的处理见处理 API 错误。
授权
BearerAuth API Key 身份验证。在 Dashboard > API > API Keys 中创建或管理 API Key。
位置: header
请求头
单次请求的交付策略。覆盖 API 密钥和 Workspace 的默认设置。自动优先尝试 TokenLab Verified,并在输出、请求接受或持久资源创建之前,可能会切换一次至仅限 Official。
可选值
- "auto"
- "verified"
- "official"
请求体
application/json
响应
application/json
application/json
application/json
application/json
application/json
application/json
application/json