跳转到主要内容
POST
/
v1
/
rerank
文档重排序（Rerank）
curl --request POST \
  --url https://llm.ai-nebula.com/v1/rerank \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "query": "<string>",
  "documents": [
    {}
  ],
  "top_n": 123,
  "return_documents": true
}
'
{
  "model": "rerank-v1",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.95,
      "document": "人工智能是计算机科学的一个分支，致力于创建能够模拟人类智能的系统。"
    },
    {
      "index": 1,
      "relevance_score": 0.82,
      "document": "机器学习是人工智能的一个子领域，专注于让计算机从数据中学习。"
    },
    {
      "index": 2,
      "relevance_score": 0.65,
      "document": "深度学习使用神经网络来处理复杂的模式识别任务。"
    }
  ],
  "usage": {
    "total_tokens": 128
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.openai-nebula.com/llms.txt

Use this file to discover all available pages before exploring further.

​
简介

根据查询对文档列表进行相关性重排序，常用于 RAG（检索增强生成）场景中优化检索结果。

​
认证

​
Authorization
string
必填
Bearer Token，如 Bearer sk-xxxxxxxxxx

​
请求参数

​
model
string
必填
模型名称，如 rerank-v1
​
query
string
必填
查询文本
​
documents
array
必填
待排序的文档列表
​
top_n
integer
返回前 N 个结果（默认返回全部）
​
return_documents
boolean
默认值:"false"
是否返回原文档内容

​
cURL 示例

curl https://llm.ai-nebula.com/v1/rerank \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-XyLy**************************mIqSt" \
  -d '{
    "model": "rerank-v1",
    "query": "什么是人工智能？",
    "documents": [
      "人工智能是计算机科学的一个分支，致力于创建能够模拟人类智能的系统。",
      "机器学习是人工智能的一个子领域，专注于让计算机从数据中学习。",
      "深度学习使用神经网络来处理复杂的模式识别任务。"
    ],
    "top_n": 3,
    "return_documents": true
  }'

​
Python 示例

import requests

url = "https://llm.ai-nebula.com/v1/rerank"
headers = {
    "Authorization": "Bearer sk-XyLy**************************mIqSt",
    "Content-Type": "application/json"
}

data = {
    "model": "rerank-v1",
    "query": "什么是人工智能？",
    "documents": [
        "人工智能是计算机科学的一个分支，致力于创建能够模拟人类智能的系统。",
        "机器学习是人工智能的一个子领域，专注于让计算机从数据中学习。",
        "深度学习使用神经网络来处理复杂的模式识别任务。"
    ],
    "top_n": 3,
    "return_documents": True
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

{
  "model": "rerank-v1",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.95,
      "document": "人工智能是计算机科学的一个分支，致力于创建能够模拟人类智能的系统。"
    },
    {
      "index": 1,
      "relevance_score": 0.82,
      "document": "机器学习是人工智能的一个子领域，专注于让计算机从数据中学习。"
    },
    {
      "index": 2,
      "relevance_score": 0.65,
      "document": "深度学习使用神经网络来处理复杂的模式识别任务。"
    }
  ],
  "usage": {
    "total_tokens": 128
  }
}

​
响应字段

字段类型说明
results[].indexinteger原始文档在输入列表中的索引
results[].relevance_scorefloat相关性分数（0-1）
results[].documentstring原文档内容（当 return_documents=true）

​
注意事项

  • 常用于 RAG 场景，先用向量检索获取候选文档，再用 rerank 优化排序
  • relevance_score 越高表示与查询越相关
  • 依赖 requests 库：pip install requests