TokenToSea开发者文档
控制台

重排序POST

按查询与候选文档的相关性打分排序,常用于检索增强生成的第二阶段。

本页内容

POST https://api.tokentosea.com/v1/rerank

给定一个查询和一组候选文档,返回每个文档的相关性分数与排序。请求字段统一,响应为厂商原生结构。

前提:全能密钥或模型密钥,账户可用余额足以覆盖本次预留。Python 示例需要 pip install requests,Node.js 示例需要 Node.js 18+。

支持的型号#

服务商型号
千问qwen3.7-text-rerank、qwen3-rerank、qwen3-vl-rerank、gte-rerank-v2
智谱rerank

截至 2026-10-21,以 GET /v1/models 为准。只支持非流式(JSON)响应,按输入 token 计费。

请求体#

参数类型必填说明
modelstring必填型号 ID
querystring必填查询文本
documentsstring[]必填候选文档
top_ninteger可选只返回前 N 个结果
return_documentsboolean可选是否在结果中附带原文
parametersobject可选千问:其他厂商原生参数

千问型号的 top_n、return_documents 会转换为厂商的 parameters;智谱的请求体原样转发,其他字段以智谱文档为准。

响应#

千问响应示例
{
  "output": {
    "results": [
      { "index": 0, "relevance_score": 0.93 }
    ]
  },
  "usage": { "total_tokens": 42 },
  "request_id": "…"
}

index 是文档在 documents 中的位置。千问返回 DashScope 原生结构(结果位于 output.results);智谱返回其原生结构。字段以厂商文档为准。

示例#

curl https://api.tokentosea.com/v1/rerank \
  -H "Authorization: Bearer $TOKENTOSEA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "model": "gte-rerank-v2",
    "query": "什么是向量检索?",
    "documents": ["向量检索通过向量相似度查找相关内容。", "今天的午餐是米饭。"],
    "top_n": 1
  }'

错误#

状态码code原因与处理
422endpoint_not_verified型号未开放本接口
422response_mode_not_verified本接口不支持流式
400main_wallet_authorization_failed输入过长,超出该型号单次预留上限
4xxprovider_http_<状态码>厂商拒绝(例如文档数量超出厂商限制),未扣费

下一步#

    输入关键词搜索全部文档与模型。