文档重排序
POST
AI 工具
对一组文档按与查询文本的相关性进行重新排序,广泛用于 RAG 检索增强生成、搜索引擎结果优化、推荐系统等场景。
POST
https://api.tinyaii.cn/v1/rerank
请求参数
| 参数名 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| query | string | 必填 | 查询文本,用于和文档做相关性比对 | 什么是机器学习 |
| documents | array | 必填 | 待排序的文档列表,字符串数组(最多50条) | ["机器学习是人工智能的一个分支", "今天天气不错", "深度学习是机器学习的子领域"] |
| top_n | integer | 可选 | 返回最相关的文档数量,默认返回全部 | 3 |
返回字段
| 字段 | 类型 | 说明 |
|---|---|---|
| query | string | 原始查询文本 |
| results | array | 排序结果数组,按相关性从高到低排列 |
| results[].index | integer | 原文档在输入数组中的索引位置 |
| results[].document | string | 原文档文本内容 |
| results[].relevance_score | float | 相关性得分,范围 0-1,越高越相关 |
返回示例
{
"code": 200,
"message": "success",
"data": {
"query": "什么是机器学习",
"results": [
{
"index": 0,
"document": {
"text": "机器学习是人工智能的一个分支,通过数据训练模型来自动改进算法性能。"
},
"relevance_score": 0.95
},
{
"index": 1,
"document": {
"text": "深度学习是机器学习的子集,使用神经网络处理复杂数据。"
},
"relevance_score": 0.82
},
{
"index": 2,
"document": {
"text": "自然语言处理让计算机能够理解和生成人类语言。"
},
"relevance_score": 0.71
}
]
}
}
调用示例
curl "https://api.tinyaii.cn/v1/rerank" \
-X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query": "什么是机器学习", "documents": "["机器学习是人工智能的一个分支", "今天天气不错", "深度学习是机器学习的子领域"]"}'const res = await fetch("https://api.tinyaii.cn/v1/rerank", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({"query": "什么是机器学习", "documents": "["机器学习是人工智能的一个分支", "今天天气不错", "深度学习是机器学习的子领域"]"}),
});
console.log(await res.json());import requests
resp = requests.post(
"https://api.tinyaii.cn/v1/rerank",
json={"query": "什么是机器学习", "documents": "["机器学习是人工智能的一个分支", "今天天气不错", "深度学习是机器学习的子领域"]"},
headers={"Authorization": "Bearer YOUR_API_KEY"},
timeout=10,
)
print(resp.json())把 YOUR_API_KEY 换成你的密钥即可直接运行。密钥只保存在你自己的设备上。