OpenAI Reranks
检索系统在“召回”阶段为保证效率,返回的结果可能不够精准。排序模型能对召回的文档进行二次精准排序,确保将与用户查询最相关的结果排在最前,有效提升应用准确率。
接口地址
| 方法 | 端点 |
|---|---|
| POST | https://neolink.com/api/v1/rerank |
认证
| 方式 | 说明 |
|---|---|
| Bearer Token | 在请求头中携带 Authorization: Bearer <API_key> 用于验证账户信息。 |
请求头
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
Content-Type | string | 是 | 请求体的媒介类型,请设置为 application/json |
Authorization | string | 是 | Bearer API_key,用于验证账户信息 |
请求体
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
model | string | 是 | - | 使用的模型 ID |
query | string | 是 | - | 用户的查询文本,用于与文档进行相关性匹配 |
documents | array | 是 | - | 待排序的文档列表,每个元素为一个字符串文档 |
top_n | int | 否 | - | 返回排序后的前 N 个最相关文档。如不指定,返回全部文档的排序结果 |
instruct | string | 否 | - | 任务指令,用于指导模型如何理解查询和文档的关系 |
return_documents | bool | 否 | 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
