请求参数
Body 参数application/json
modelstring必填重排模型,可在下方查看可用模型。
示例:
<rerank-model>querystring必填查询文本。
示例:
什么是向量检索?documentsstring[]必填候选文档数组。
示例:
["文档1", "文档2"]top_ninteger可选只返回相关性最高的前 N 条。
示例:
3return_documentsboolean可选设为 true 时,结果会带回原始文档内容(document.text)。
示例:
true响应
results 按 relevance_score 降序排列,每项包含原 documents 下标 index 和 0–1 的 relevance_score。费用根据 query 与 documents 的估算 token 计算。
可用模型
重排模型见 模型广场。示例中的 model 是占位符;如果模型列表中没有 Rerank 模型,表示该能力当前未开放。
请求与响应体
用下面的示例确认请求格式与返回结构。需要在线发起请求时,点击页面顶部“调试”拉起在线运行面板。
bash
curl https://zerofa.ai/v1/rerank \
-H "Authorization: Bearer sk-zerofa-xxx" \
-H "Content-Type: application/json" \
-d '{
"model": "<rerank-model>",
"query": "什么是向量检索?",
"documents": [
"向量检索通过相似度匹配语义相近的文档",
"今天天气很好,适合出门",
"rerank 模型按相关性重新排序候选文档"
],
"top_n": 3,
"return_documents": true
}'响应 · 200
{
"model": "<rerank-model>",
"results": [
{ "index": 0, "relevance_score": 0.389,
"document": { "text": "向量检索通过相似度匹配语义相近的文档" } },
{ "index": 2, "relevance_score": 0.022,
"document": { "text": "rerank 模型按相关性重新排序候选文档" } }
]
}