重排序文档

根据查询内容为候选文档重新排序，返回相关性分数和原始位置。

POST https://token.moi.matrixorigin.cn/v1/rerank

调用前准备

1. 准备用于 Genesis 调用的个人访问令牌或服务账号 API Key。创建和权限配置参阅管理 Genesis 访问凭据。

2. 通过查询可调用模型选择支持 Rerank 的模型。

请求体

将示例中的 $GENESIS_ACCESS_TOKEN 和 $MODEL_ID 分别替换为访问凭据和所选模型的 ID。

输入示例

curl -X POST \
  "https://token.moi.matrixorigin.cn/v1/rerank" \
  -H "Authorization: Bearer $GENESIS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "'"$MODEL_ID"'",
  "query": "database",
  "documents": [
    "database transaction",
    "weather forecast"
  ],
  "top_n": 1,
  "return_documents": true
}'

参数说明

以下字段覆盖文本查询和文本候选内容；图像或视频重排序需要相应模型能力及输入配置。

参数	类型	是否必填	说明
model	string	是	所选模型的 ID，取自模型查询结果中的 data[].id。
query	string 或 object	是	用于比较相关性的非空查询文本。对象形态的字段如下。
query.content	string 或 array of object	对象查询中必填	对象输入中的文本或文本块。
query.content[].type	string	文本块中必填	文本块填写 text。
query.content[].text	string	文本块中必填	非空文本内容。
documents	array of string 或 array of object	是	非空候选内容列表，保留其原始顺序以关联返回结果。
documents[].content	string 或 array of object	对象候选内容中必填	对象输入中的文本或文本块。
documents[].content[].type	string	文本块中必填	文本块填写 text。
documents[].content[].text	string	文本块中必填	非空文本内容。
top_n	integer	否	返回的最高相关性结果数量，必须为正整数。
return_documents	boolean	否	设为 true 时在结果中包含候选内容。

成功响应

成功时返回按相关性排列的候选结果。

响应示例

{
  "id": "rerank-example",
  "model": "MODEL_ID",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.98,
      "document": {
        "text": "database transaction"
      }
    }
  ],
  "usage": {
    "prompt_tokens": 5,
    "completion_tokens": 0,
    "total_tokens": 5
  }
}

字段说明

字段	类型	说明
id	string	本次重排序请求的标识。
model	string	处理请求的模型。
results	array of object	按相关性排序的结果。
results[].index	integer	原始 documents 中的位置，从 0 开始。
results[].relevance_score	number	模型给出的相关性分数。
results[].document	string 或 object	请求返回候选内容时包含；文本对象的字段如下。
results[].document.text	string	候选文本。
usage	object	模型返回的 Token 用量。
usage.prompt_tokens	integer	输入 Token 数。
usage.completion_tokens	integer	生成 Token 数。
usage.total_tokens	integer	输入与生成 Token 总数。

错误响应

缺少必填模型 ID 时返回 HTTP 400。补充模型 ID 后重新提交。

响应示例

{
  "error": {
    "message": "missing required parameter: model",
    "type": "invalid_request",
    "code": "invalid_request"
  }
}

字段说明

字段	类型	说明
error	object	错误信息。
error.message	string	错误原因；示例表示缺少模型 ID。
error.type	string	错误类别，模型服务返回时可能省略。
error.code	string 或 null	错误代码，模型服务返回时可能省略。

最后更新于 2026 年 9 月 8 日