重排序
更新时间:2025-06-27
POST
https://qianfan.baidubce.com/v2/rerank
用于重新排序向量模型返回的top-k文档,优化语义搜索结果。
支持模型列表
支持模型列表请查看千帆ModelBuilder-模型列表-重排序。
注意事项
(1)本文API,支持预置服务对应API和平台训练模型调用API。
(2)针对平台训练调用API,调用本文API前,需先经过SFT模型训练后发布服务,相关内容请参考新手指南-平台使用快速开始。
权限说明
调用本文API,需使用API Key鉴权方式。使用API Key鉴权调用API流程,具体调用流程,请查看认证鉴权。
请求参数
Headers 参数
除公共头域外,无其它特殊头域
Body 参数
model
string
模型名称,说明:
(1)预置服务,可选值请参考千帆ModelBuilder-模型列表-重排序 ,表格中model入参列
(2)平台训练模型或预置模型,可以通过查看服务详情获取该字段值,详情请查看千帆控制台-在线推理:model值为服务详情中对应的API名称,如下图所示:
必选
query
string
查询文本,说明:长度不超过1600个字符,token数若超过400做截断
必选
documents
array
需要重排序的文本,说明:
(1)不能为空List,List的每个成员不能为空字符串
(2)文本数量不超过64
(3)每条document文本长度不超过4096个字符,token数若超过1024做截断
必选
显示子属性
隐藏子属性
items
string
top_n
integer
返回的最相关文本的数量,默认为document的数量
可选
user
string
表示最终用户的唯一标识符
可选
请求结构
POST /v2/rerank HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
{
"model": "idgn***",
"query": "上海天气",
"documents": [
"上海气候",
"北京美食"
]
}
示例代码
curl --location 'https://qianfan.baidubce.com/v2/rerank' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer bce-v3/ALTAK-*********/614fb**********' \
--data '{
"model": "bce-reranker-base",
"query": "上海天气",
"documents": [
"上海气候",
"北京美食"
]
}'
import requests
import json
def main():
url = "https://qianfan.baidubce.com/v2/rerank"
payload = json.dumps({
"model": "bce-reranker-base",
"query": "上海天气",
"documents": [
"上海气候",
"北京美食"
]
})
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer bce-v3/ALTAK-*********/614fb**********'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
if __name__ == '__main__':
main()
返回响应
Headers 参数
除公共头域外,无其它特殊头域
返回参数
id
string
本次请求的唯一标识,可用于排查问题
可选
object
string
回包类型,固定值“rerank_list”
可选
created
integer
时间戳
可选
results
array
重排序结果,按相似性得分倒序
可选
显示子属性
隐藏子属性
items
object {3}
显示子属性
隐藏子属性
document
string
文本内容
可选
relevance_score
number
相似性得分
可选
index
integer
序号
可选
usage
object {4}
token统计信息
可选
显示子属性
隐藏子属性
prompt_tokens
integer
问题tokens数(包含历史QA)
可选
prompt_tokens_details
integer
问题token详情,说明:当调用对话Chat API返回此参数
可选
completion_tokens
integer
回答tokens数,说明:当调用对话Chat API返回此参数
可选
total_tokens
integer
总tokens数
可选
model
string
模型名称或地址
可选
响应示例
{
"id": "as-1qjhejaief",
"object": "reranker_list",
"created": 1737030836,
"model": "bce-reranker-base",
"results": [
{
"document": "上海气候",
"relevance_score": 0.689619243144989,
"index": 0
},
{
"document": "北京美食",
"relevance_score": 0.36954259872436523,
"index": 1
}
],
"usage": {
"prompt_tokens": 11,
"total_tokens": 11
}
}
错误码
如果请求错误,服务器返回的JSON文本包含以下参数。
名称 | 描述 |
---|---|
code | 错误码 |
msg | 错误描述信息,帮助理解和解决发生的错误 |
type | 错误类型 |
更多相关错误码,请查看模型错误码说明。