认证
authorization string required
所有 API 均使用 Bearer Token 鉴权
获取 API Key:
访问 API Key 管理页面 获取 API Key
用法:
将以下 Header 添加到请求中:
Authorization: Bearer YOUR_API_KEY
参数
model string required
用于请求的模型 ID
Value:qwen3-rerank
query string required
用于排序的查询内容。最大长度不能超过 4,000 个 token
documents array required
待排序的候选文档列表。每个元素是一个文本字符串
top_n integer
返回排序后的前 N 个文档。如果不指定, 返回全部文档。如果指定的值大于文档总数, 将返回全部文档
instruct string
自定义排序任务指令。指导模型采用不同的排序策略
问答检索任务 (默认):
"Given a web search query, retrieve relevant passages that answer the query."
侧重点:寻找问题的答案。模型会优先评估文档是否解答了查询中的问题
示例:对于查询 “如何预防感冒?”, 文档 “勤洗手是预防感冒的有效方法” 会获得高分;而文档 “感冒是一种常见疾病” 虽然主题相关, 但因未提供答案, 得分会显著更低
语义相似度排序任务:
"Retrieve semantically similar text."
侧重点:判断语义的等价性。模型会评估查询和文档的核心含义是否一致, 而不管具体措辞或句式
示例:在 FAQ 场景中, 用户查询 “如何修改密码?” 与候选问题 “忘记密码怎么办?” 在语义上高度相似, 应获得高分。模型会关注两者是否指向同一个用户意图
建议使用英文撰写。如不指定该参数, 将默认按问答检索任务进行排序
return_documents boolean
是否在排序结果中返回文档原文。默认值为 false, 以减少网络传输开销
响应格式
request_id string
请求唯一标识。可用于请求明细溯源和问题排查
output object
任务输出信息
results
array排序结果列表。按
relevance_score从高到低排列index
integer表示该结果对应于输入
documents列表中的原始索引位置relevance_score
number该文档与查询的语义相关性得分, 取值范围为
0.0到1.0。分数越高, 相关性越强说明:此分数为当前请求中的相对分数, 主要用于对本次请求内的文档排序, 不可作为跨请求比较的绝对值
document
object文档原文对象。仅在请求参数
return_documents为true时返回。结构为{"text": "文档原文"}
usage object
token 使用统计
total_tokens
integer本次请求消耗的总 token 数量