文档重排序(Rerank)
curl --request POST \
--url https://api.leapx-hub.com/v1/rerank \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"model": "<string>",
"query": "<string>",
"documents": [
{}
],
"top_n": 123,
"return_documents": true
}
'import requests
url = "https://api.leapx-hub.com/v1/rerank"
payload = {
"model": "<string>",
"query": "<string>",
"documents": [{}],
"top_n": 123,
"return_documents": True
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
model: '<string>',
query: '<string>',
documents: [{}],
top_n: 123,
return_documents: true
})
};
fetch('https://api.leapx-hub.com/v1/rerank', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.leapx-hub.com/v1/rerank",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'model' => '<string>',
'query' => '<string>',
'documents' => [
[
]
],
'top_n' => 123,
'return_documents' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.leapx-hub.com/v1/rerank"
payload := strings.NewReader("{\n \"model\": \"<string>\",\n \"query\": \"<string>\",\n \"documents\": [\n {}\n ],\n \"top_n\": 123,\n \"return_documents\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.leapx-hub.com/v1/rerank")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"model\": \"<string>\",\n \"query\": \"<string>\",\n \"documents\": [\n {}\n ],\n \"top_n\": 123,\n \"return_documents\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.leapx-hub.com/v1/rerank")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model\": \"<string>\",\n \"query\": \"<string>\",\n \"documents\": [\n {}\n ],\n \"top_n\": 123,\n \"return_documents\": true\n}"
response = http.request(request)
puts response.read_body{
"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
}
}
文本系列
文档重排序(Rerank)
POST
/
v1
/
rerank
文档重排序(Rerank)
curl --request POST \
--url https://api.leapx-hub.com/v1/rerank \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"model": "<string>",
"query": "<string>",
"documents": [
{}
],
"top_n": 123,
"return_documents": true
}
'import requests
url = "https://api.leapx-hub.com/v1/rerank"
payload = {
"model": "<string>",
"query": "<string>",
"documents": [{}],
"top_n": 123,
"return_documents": True
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
model: '<string>',
query: '<string>',
documents: [{}],
top_n: 123,
return_documents: true
})
};
fetch('https://api.leapx-hub.com/v1/rerank', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.leapx-hub.com/v1/rerank",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'model' => '<string>',
'query' => '<string>',
'documents' => [
[
]
],
'top_n' => 123,
'return_documents' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.leapx-hub.com/v1/rerank"
payload := strings.NewReader("{\n \"model\": \"<string>\",\n \"query\": \"<string>\",\n \"documents\": [\n {}\n ],\n \"top_n\": 123,\n \"return_documents\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.leapx-hub.com/v1/rerank")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"model\": \"<string>\",\n \"query\": \"<string>\",\n \"documents\": [\n {}\n ],\n \"top_n\": 123,\n \"return_documents\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.leapx-hub.com/v1/rerank")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model\": \"<string>\",\n \"query\": \"<string>\",\n \"documents\": [\n {}\n ],\n \"top_n\": 123,\n \"return_documents\": true\n}"
response = http.request(request)
puts response.read_body{
"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
}
}
简介
根据查询对文档列表进行相关性重排序,常用于 RAG(检索增强生成)场景中优化检索结果。认证
string
必填
Bearer Token,如
Bearer sk-xxxxxxxxxx请求参数
string
必填
模型名称,如
rerank-v1string
必填
查询文本
array
必填
待排序的文档列表
integer
返回前 N 个结果(默认返回全部)
boolean
默认值:"false"
是否返回原文档内容
cURL 示例
curl https://api.leapx-hub.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://api.leapx-hub.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[].index | integer | 原始文档在输入列表中的索引 |
| results[].relevance_score | float | 相关性分数(0-1) |
| results[].document | string | 原文档内容(当 return_documents=true) |
注意事项
- 常用于 RAG 场景,先用向量检索获取候选文档,再用 rerank 优化排序
relevance_score越高表示与查询越相关- 依赖
requests库:pip install requests
⌘I
