文本排序

本页说明文本排序（rerank）接口，采用 models-model.md 风格：概览、认证、参数表、请求示例、返回示例。

---

概览

• 请求方法：POST
• 路径：/v1/rerank
• 内容类型：application/json

认证

• 使用 HTTP Bearer Token，示例：Authorization: Bearer sk-xxxxx

---

请求参数

参数	类型	必填	描述
model	string	是	排序模型名称，例如 gte-rerank-v2
query	string	是	查询提示词，用于与候选文档匹配并排序
documents	array[string]	是	候选文档列表（字符串数组），将按与 query 的相关性排序
top_n	integer	否	返回的前 N 条文档，未指定则返回全部候选文档
return_documents	boolean	否	返回结果中是否包含原始文档文本，默认 false

---

请求示例

{
  "model": "gte-rerank-v2",
  "query": "什么是文本排序模型",
  "documents": [
    "文本排序模型广泛用于搜索引擎和推荐系统中，它们根据文本相关性对候选文本进行排序",
    "量子计算是计算科学的一个前沿领域",
    "预训练语言模型的发展给文本排序模型带来了新的进展"
  ],
  "return_documents": true,
  "top_n": 5
}

curl

curl -X POST "https://api.gpt.ge/v1/rerank" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxx" \
  -d '{"model":"gte-rerank-v2","query":"什么是文本排序模型","documents":["文本排序模型广泛用于搜索引擎和推荐系统中，它们根据文本相关性对候选文本进行排序","量子计算是计算科学的一个前沿领域","预训练语言模型的发展给文本排序模型带来了新的进展"],"return_documents":true,"top_n":5}'

JavaScript (fetch)

fetch('https://api.gpt.ge/v1/rerank', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer sk-xxxx' },
  body: JSON.stringify({ model: 'gte-rerank-v2', query: '什么是文本排序模型', documents: ['文本排序模型广泛用于搜索引擎和推荐系统中，它们根据文本相关性对候选文本进行排序','量子计算是计算科学的一个前沿领域','预训练语言模型的发展给文本排序模型带来了新的进展'], return_documents: true, top_n: 5 })
}).then(r => r.json()).then(console.log)

Python (requests)

import requests

payload = {
  'model': 'gte-rerank-v2',
  'query': '什么是文本排序模型',
  'documents': [
    '文本排序模型广泛用于搜索引擎和推荐系统中，它们根据文本相关性对候选文本进行排序',
    '量子计算是计算科学的一个前沿领域',
    '预训练语言模型的发展给文本排序模型带来了新的进展'
  ],
  'return_documents': True,
  'top_n': 5
}

resp = requests.post('https://api.gpt.ge/v1/rerank', headers={'Content-Type':'application/json','Authorization':'Bearer sk-xxxx'}, json=payload)
print(resp.json())

---

返回示例（200）

{
  "results": [
    {
      "document": { "text": "文本排序模型广泛用于搜索引擎和推荐系统中，它们根据文本相关性对候选文本进行排序" },
      "index": 0,
      "relevance_score": 0.9334521178273196
    },
    {
      "document": { "text": "预训练语言模型的发展给文本排序模型带来了新的进展" },
      "index": 2,
      "relevance_score": 0.34100082626411193
    },
    {
      "document": { "text": "量子计算是计算科学的一个前沿领域" },
      "index": 1,
      "relevance_score": 0.005814161578735119
    }
  ],
  "usage": { "prompt_tokens": 79, "total_tokens": 79 }
}