创建重排序请求
创建模型重排序请求，对文档进行相关性排序
POST
https://api.openapi.cn/v1/rerank
认证参数
Authorization
string
header
必填
使用以下格式进行身份验证：Bearer <YOUR API KEY>
请求体
application/json
model
string
必填
对应的模型名称。为了更好地提升服务质量，我们将对本服务提供的模型进行定期变更，包括但不限于模型上下线、模型服务能力调整等，在可行的情况下，我们将通过公告、消息推送等适当方式通知您相关变更。
query
string
必填
必填。搜索查询。
documents
array
必填
目前仅支持字符串列表。未来将支持文档对象。
top_n
integer
可选
返回的最相关文档或索引的数量。
return_documents
boolean
可选
如果为false，响应不包含文档文本；如果为true，则包含输入文档文本。
max_chunks_per_doc
integer
可选
从文档内生成的最大块数。长文档被分成多个块进行计算，块中的最高分数被视为文档的分数。
overlap_tokens
integer
可选
文档分块时相邻块之间的令牌重叠数。要求范围：x <= 80
响应体
id
string
请求的唯一标识符
results
array
重排序结果列表
tokens
object
令牌使用统计信息
请求示例
curl -X POST "https://api.example.com/rerank" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "BAAI/bge-reranker-v2-m3",
"query": "人工智能的应用",
"documents": [
"人工智能在医疗领域的应用正在快速发展",
"自然语言处理是人工智能的一个重要分支",
"机器学习算法可以从数据中学习模式"
],
"top_n": 2,
"return_documents": true
}'
响应示例
{
"id": "rerank-123456789",
"results": [
{
"index": 0,
"document": "人工智能在医疗领域的应用正在快速发展",
"relevance_score": 0.92
},
{
"index": 1,
"document": "自然语言处理是人工智能的一个重要分支",
"relevance_score": 0.85
}
],
"tokens": {
"total_tokens": 42
}
}