Rerank - 重排序 - OB Cloud 云数据库 master

Rerank - 重排序

更新时间：2026-05-28 13:56:27

功能说明

重排序接口,兼容文本与多模态请求。该接口接收一个查询(query)和一组文档(documents),根据查询与文档的相关性对文档进行重新排序,并返回排序后的结果。

调用说明

接口约束

调用者需要拥有 API Key,详情请参见管理 AI API Key。

请求路径

POST {BASE_URL}/api/v1/rerank

请求头

名称	是否必选	示例值	描述
Authorization	是	Bearer {token}	鉴权信息
Content-Type	否	application/json	请求体格式

请求参数

Path 参数

此接口无 Path 参数。

Query 参数

此接口无 Query 参数。

Body 参数

名称	类型	是否必填	示例值	描述
model	string	是	bge-reranker-v2-m3	用于重排序的模型名称
query	string	是	什么是人工智能?	查询文本
documents	array	是	["文档1内容", "文档2内容"]	待排序的文档列表
input	object	否	-	输入对象(多模态请求时使用)
top_n	integer	否	5	返回最相关的 top_n 个结果,默认返回全部
return_documents	boolean	否	false	是否在返回结果中包含原始文档内容
parameters	object	否	-	模型特定的参数配置

返回结果

返回参数

名称	类型	描述
success	boolean	请求是否成功
code	string	返回码
message	string	返回信息
data	object	业务返回数据

data 字段说明

名称	类型	描述
results	array	重排序后的结果列表,每个元素包含文档索引和相关性得分等信息

请求示例

curl --request POST '{BASE_URL}/api/v1/rerank' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "bge-reranker-v2-m3",
    "query": "什么是人工智能?",
    "documents": ["人工智能是研究、开发用于模拟、延伸和扩展人的智能的理论、方法、技术及应用系统的一门新的技术科学。", "机器学习是人工智能的一个分支,它使计算机能够在没有明确编程的情况下学习。"],
    "top_n": 2,
    "return_documents": false
  }'

返回示例

{
  "success": true,
  "code": "200",
  "message": "successful",
  "data": {
    "results": [
      {
        "index": 0,
        "relevance_score": 0.95
      },
      {
        "index": 1,
        "relevance_score": 0.82
      }
    ]
  }
}