Skip to main content
POST
/
v1
/
rerank
curl --request POST \
  --url https://api.mixroute.ai/v1/rerank \
  --header 'Authorization: Bearer sk-xxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "rerank-v1",
    "query": "什麼是人工智慧？",
    "documents": [
      "人工智慧是電腦科學的一個分支...",
      "機器學習是人工智慧的一個子領域..."
    ],
    "top_n": 3,
    "return_documents": true
  }'

{
  "model": "rerank-v1",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.95,
      "document": "人工智慧是電腦科學的一個分支，致力於建立能夠模擬人類智慧的系統。"
    },
    {
      "index": 1,
      "relevance_score": 0.82,
      "document": "機器學習是人工智慧的一個子領域，專注於讓電腦從資料中學習。"
    }
  ],
  "usage": {
    "total_tokens": 128
  }
}

​
簡介

根據查詢對文件列表進行相關性重排序，常用於 RAG（檢索增強生成）情境中最佳化檢索結果。

​
認證

Bearer Token，如 Bearer sk-xxxxxxxxxx

​
請求參數

​
model
string
required
模型名稱，如 rerank-v1
​
query
string
required
查詢文字
​
documents
array
required
待排序的文件列表
​
top_n
integer
回傳前 N 個結果（預設回傳全部）
​
return_documents
boolean
是否回傳原文件內容

​
cURL 範例

curl https://api.mixroute.ai/v1/rerank \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "rerank-v1",
    "query": "什麼是人工智慧？",
    "documents": [
      "人工智慧是電腦科學的一個分支，致力於建立能夠模擬人類智慧的系統。",
      "機器學習是人工智慧的一個子領域，專注於讓電腦從資料中學習。",
      "深度學習使用神經網路來處理複雜的模式識別任務。"
    ],
    "top_n": 3,
    "return_documents": true
  }'

​
Python 範例

import requests

url = "https://api.mixroute.ai/v1/rerank"
headers = {
    "Authorization": "Bearer sk-xxxxxxxxxx",
    "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())

​
回應欄位

欄位類型說明
results[].indexinteger原始文件在輸入列表中的索引
results[].relevance_scorefloat相關性分數（0-1）
results[].documentstring原文件內容（當 return_documents=true）

​
注意事項

  • relevance_score 越高表示與查詢越相關
  • 常用於 RAG 情境，先用向量檢索取得候選文件，再用 rerank 最佳化排序
curl --request POST \
  --url https://api.mixroute.ai/v1/rerank \
  --header 'Authorization: Bearer sk-xxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "rerank-v1",
    "query": "什麼是人工智慧？",
    "documents": [
      "人工智慧是電腦科學的一個分支...",
      "機器學習是人工智慧的一個子領域..."
    ],
    "top_n": 3,
    "return_documents": true
  }'

{
  "model": "rerank-v1",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.95,
      "document": "人工智慧是電腦科學的一個分支，致力於建立能夠模擬人類智慧的系統。"
    },
    {
      "index": 1,
      "relevance_score": 0.82,
      "document": "機器學習是人工智慧的一個子領域，專注於讓電腦從資料中學習。"
    }
  ],
  "usage": {
    "total_tokens": 128
  }
}