Reranker重排序API
更新时间 2025-09-08 14:07:19
最近更新时间: 2025-09-08 14:07:19
接口描述
| - | 描述 |
|---|---|
| 接口名称 | 重排序 |
| 请求路径 | https://wishub-x6.ctyun.cn/v1/rerank |
| 功能描述 | 通常用于计算查询和文档之间的相关性分数。 |
请求参数
请求头header参数
| 参数 | 类型 | 必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Content-Type | String | 是 | application/json | json格式 |
| Authorization | String | 是 | Bearer APP_KEY | 请求鉴权的 App Key，由平台提供。Bearer 开头 |
请求体body参数
| 名称 | 类型 | 必选 | 示例值 | 描述 |
|---|---|---|---|---|
| model | String | 是 | 96dcaaaaaaaaaaaa5ff55ea377831a | 模型id，请在模型详情页顶部区域查看，样例：96dcaaaaaaaaaaaa5ff55ea377831a |
| query | String | 是 | 人工智能的发展趋势 | 待重排序的查询文本（例如用户搜索词） |
| documents | Array | 是 | ["人工智能正在快速发展","机器学习是AI的核心技术","大语言模型改变了AI领域"] | 待排序的文档列表（每个元素为一个文档文本，例如搜索结果中的候选文本） |
| truncate_prompt_tokens | Int | 否 | 8192 | 最大token值，取值范围（1, 8192） |
| top_n | Int | 否 | 2 | 返回top_n个文档，取值范围大于0，且小于documents的数量 |
| return_documents | Boolean | 否 | false | 是否返回原文档 |
请求代码示例
使用前请替换具体的${APP_KEY}和${MODEL_ID}值
curl --location 'https://wishub-x6.ctyun.cn/v1/rerank' \
--header 'Authorization: Bearer ${APP_KEY}' \
--header 'Content-Type: application/json' \
--data '{
"model": "${MODEL_ID}",
"query": "人工智能的发展趋势",
"documents": [
"人工智能正在快速发展。",
"机器学习是AI的核心技术。",
"大语言模型改变了AI领域。",
"自然语言是AI领域的里程碑"
],
"top_n": 2,
"return_documents": true
}'返回值说明
请求成功返回响应参数
| 名称 | 类型 | 描述 | 示例值 | 下级对象 |
|---|---|---|---|---|
| code | Int | 接口状态码，返回状态，返回 0 表示成功 | 0 | |
| id | String | 请求标识 | endpoint_common_11684 | |
| results | Array | 模型返回的结果 | - | results |
| created | Int | 回答的创建时间，由模型侧返回 | 1719904068 | |
| model | String | 模型名称 | Bge-Rerank-Large |
表results
| 名称 | 类型 | 描述 | 示例值 | 下级对象 |
|---|---|---|---|---|
| index | Int | 在原文档中对应索引 | 0 | |
| relevance_score | Float | 分数 | 0.992 | |
| document | Object | 文档内容，当return_documents为true时，无此字段 | - | document |
表document
| 名称 | 类型 | 描述 | 示例值 | 下级对象 |
|---|---|---|---|---|
| text | String | 目标文档 | 人工智能正在快速发展 |
请求失败返回响应参数
| 字段名 | 二级字段 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| error | - | Object | 错误信息 | - |
| - | code | String | 错误码，返回错误代码参考下面的错误代码列表 | 500002 |
| - | type | String | 返回对应的错误码 | PARAM_ERROR |
| - | message | String | 返回对应的错误信息 | modelId不正确，请重试 |
错误码
如遇模型调用失败且返回报错信息，可访问官网错误处理页面，寻求解决方法。
返回值示例
请求成功返回值示例
{
"code": 0,
"id": "34870e0590084e40800f856bc8e08201",
"model": "b2d640f305f64c52ab5a04cd8565a233",
"results": [
{
"index": 0,
"document": {
"text": "人工智能正在快速发展。"
},
"relevance_score": 0.992597
},
{
"index": 2,
"document": {
"text": "大语言模型改变了AI领域。"
},
"relevance_score": 0.8079157
}
]
}请求失败返回值示例
{
"error": {
"code": "500001",
"message": "算法服务接口异常，请联系管理员",
"type": "INVOKE_MODEL_ERROR"
}
}
