help.khb.com 文本系列 API: 创建重排序请求 (Rerank)

API: 创建重排序请求 (Rerank)

Create a Rerank Request

根据查询(query)对一组文档(documents)进行相关性重排序,常用于 RAG 场景优化检索结果。

端点:POST /v1/rerank

Request Body

model (string, required)

对应重排序模型。完整可用模型列表请查看 模型广场

示例:"BAAI/bge-reranker-v2-m3"

query (string, required)

查询文本,用于与 documents 进行相关性比对。

documents (array<string>, required)

待排序的文档列表,每个元素为一段文本。

top_n (integer, optional)

返回前 N 个最相关的文档,默认返回全部。

return_documents (boolean, optional)

是否在响应中返回文档原文。默认 true

代码示例

Python

import requests

url = "https://khb.net.cn/v1/rerank"

payload = {
    "model": "BAAI/bge-reranker-v2-m3",
    "query": "什么是机器学习?",
    "documents": [
        "机器学习是人工智能的一个分支,致力于开发能够从数据中学习的算法。",
        "深度学习是机器学习的一个子集,使用多层神经网络。",
        "今天天气晴朗,适合外出游玩。",
        "监督学习是机器学习的一种范式,使用标注数据训练模型。"
    ],
    "top_n": 3,
    "return_documents": True
}

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)
result = response.json()

for item in result["results"]:
    print(f"分数: {item['relevance_score']:.4f} - {item['document']}")

Response Body

{
  "id": "rerank-xxx",
  "results": [
    {
      "document": "机器学习是人工智能的一个分支...",
      "index": 0,
      "relevance_score": 0.9876
    },
    {
      "document": "监督学习是机器学习的一种范式...",
      "index": 3,
      "relevance_score": 0.8543
    },
    {
      "document": "深度学习是机器学习的一个子集...",
      "index": 1,
      "relevance_score": 0.7123
    }
  ],
  "tokens": {
    "input_tokens": 156,
    "output_tokens": 0
  }
}

使用场景

  • RAG 检索优化:先用向量检索召回 Top-K 文档,再用 Rerank 精细排序
  • 搜索引擎:对初步检索结果进行二次排序,提升准确度
  • 推荐系统:对候选内容进行个性化重排序

Related Post