典名词元典名词元首页
API 文档三方工具教程
AI 模型接口文本

重排序(同步)

POST/api/v1/reranks

Header Parameters

Authorization*string

使用 Bearer Token 认证。 格式: Authorization: Bearer sk-xxxxxx

Request Body

application/json

model*string

模型名称。固定值:qwen3-rerank

Value in"qwen3-rerank"
query*string

查询内容。最大长度不能超过 4,000 个 Token。

documents*array<string>

待排序的候选文档列表。每个元素是一个字符串,最多 500 条。

Itemsitems <= 500
[]?string
top_n?integer

返回排序后的 top_n 个文档。默认返回全部文档。如果指定的值大于文档总数,将返回全部文档。

instruct?string

自定义排序任务类型说明,指导模型采用不同的排序策略。建议使用英文撰写。如不指定,默认按问答检索任务排序。

问答检索(默认):"Given a web search query, retrieve relevant passages that answer the query."

语义相似度:"Retrieve semantically similar text."

return_original?boolean

返回原厂数据。默认 false:返回中继站标准响应格式(code+data+message+request_id);true:返回原厂格式。

Defaultfalse

Response Body

application/json

成功

TypeScript Definitions

Use the response body type in TypeScript.

code?integer

状态码

data?object

响应数据

object?string

数据类型,固定为 list

model?string

模型名称

results?array<object>

排序结果列表,按 relevance_score 从高到低排列

[]?object
index?integer

对应输入 documents 列表中的原始索引位置

relevance_score?number

该文档与查询的语义相关性得分,取值范围 0.0 ~ 1.0,分数越高相关性越强。此分数为当前请求中的相对分数,不可跨请求比较。

usage?object
total_tokens?integer

本次请求消耗的 Token 总数

id?string

请求唯一标识

message?string

提示信息

request_id?string

请求ID

curl -X POST "https://api.aa.com.cn/api/v1/reranks" \  -H "Authorization: string" \  -H "Content-Type: application/json" \  -d '{    "model": "qwen3-rerank",    "query": "string",    "documents": [      "string"    ],    "return_original": false  }'
{
  "code": 0,
  "data": {
    "object": "string",
    "model": "string",
    "results": [
      {
        "index": 0,
        "relevance_score": 0
      }
    ],
    "usage": {
      "total_tokens": 0
    },
    "id": "string"
  },
  "message": "string",
  "request_id": "string"
}