Skip to content

OpenAI Reranks ​

检索系统在“召回”阶段为保证效率,返回的结果可能不够精准。排序模型能对召回的文档进行二次精准排序,确保将与用户查询最相关的结果排在最前,有效提升应用准确率。

接口地址 ​

方法端点
POSThttps://neolink.com/api/v1/rerank

认证 ​

方式说明
Bearer Token在请求头中携带 Authorization: Bearer <API_key> 用于验证账户信息。

请求头 ​

参数名类型必填说明
Content-Typestring是请求体的媒介类型,请设置为 application/json
Authorizationstring是Bearer API_key,用于验证账户信息

请求体 ​

参数名类型必填默认值说明
modelstring是-使用的模型 ID
querystring是-用户的查询文本,用于与文档进行相关性匹配
documentsarray是-待排序的文档列表,每个元素为一个字符串文档
top_nint否-返回排序后的前 N 个最相关文档。如不指定,返回全部文档的排序结果
instructstring否-任务指令,用于指导模型如何理解查询和文档的关系
return_documentsbool否true是否在结果中返回原始文档内容

请求示例 ​

bash
curl --location 'https://neolink.com/api/v1/rerank' \
     --header 'Authorization: Bearer <API Key>' \
     --header 'Content-Type: application/json' \
     --data '{
         “model”: “<Model ID>”,
         “documents”: [
             “文本排序模型广泛用于搜索引擎和推荐系统中,它们根据文本相关性对候选文本进行排序”,
             “量子计算是计算科学的一个前沿领域”,
             “预训练语言模型的发展给文本排序模型带来了新的进展”
         ],
         “query”: “什么是文本排序模型”,
         “top_n”: 2,
         “instruct”: “Given a web search query, retrieve relevant passages that answer the query.”
     }'
python
import requests

url = “https://neolink.com/api/v1/rerank”

headers = {
    “Authorization”: “Bearer <API Key>”,
    “Content-Type”: “application/json”,
}

payload = {
    “model”: “<Model ID>”,
    “documents”: [
        “文本排序模型广泛用于搜索引擎和推荐系统中,它们根据文本相关性对候选文本进行排序”,
        “量子计算是计算科学的一个前沿领域”,
        “预训练语言模型的发展给文本排序模型带来了新的进展”,
    ],
    “query”: “什么是文本排序模型”,
    “top_n”: 2,
    “instruct”: (
        “Given a web search query, retrieve relevant passages “
        “that answer the query.”
    ),
}

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

response.raise_for_status()

print(response.status_code)
print(response.json())

支持模型Id:

  • qwen3-rerank