> ## Documentation Index
> Fetch the complete documentation index at: https://mixroute.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Rerank v5.0 Pro

> Cohere 注重排序品質的多語言重排序模型，適合複雜查詢和長文件，包含 MixRoute 請求示例與回應欄位說明。

Rerank v5.0 Pro 依文件與查詢的相關性重新排序。適用於重視檢索品質的複雜查詢，在將候選片段交給 LLM 前篩選相關內容。

先檢索候選文件，再進行重排序。回應包含相關性分數與原始文件索引，不產生回答或向量。在 MixRoute 上使用 `/v1/rerank`。

## 模型資訊

| 欄位 | 說明 |
| - | - |
| `model` | rerank-v5.0-pro |
| `endpoint` | [POST /v1/rerank](https://mixroute.ai/docs/zh-Hant/api-reference/endpoint/rerank.md) |
| `context` | 32,768 tokens |

廠商上下文視窗為每組查詢與文件合計 32,768 tokens，不是整個文件清單共用的上限。實際請求限制取決於 MixRoute 路由。

## 請求欄位

| 欄位 | 說明 |
| - | - |
| `model` | 必填，使用上方列出的完整模型 ID。 |
| `query` | 必填的查詢字串。 |
| `documents` | 必填的文件字串陣列。保留原始陣列，以便透過索引對應結果。 |
| `top_n` | 可選的正整數，回傳數量不超過候選文件數。 |
| `return_documents` | 可選布林值。設為 true 時，在 `results[].document.text` 中回傳原文。 |

## 請求示例

設定 `MIXROUTE_API_KEY` 環境變數。Python 示例使用 requests 套件。

> [tab] cURL
>
> ```bash theme={null}
> curl --request POST "https://api.mixroute.ai/v1/rerank" \
>   --header "Authorization: Bearer $MIXROUTE_API_KEY" \
>   --header "Content-Type: application/json" \
>   --data '{
>   "model": "rerank-v5.0-pro",
>   "query": "What is the capital of France?",
>   "documents": [
>     "Paris is the capital of France.",
>     "A triangle has three sides."
>   ],
>   "top_n": 1,
>   "return_documents": true
> }'
> ```

> [tab] Python
>
> ```python theme={null}
> import os
> import requests
>
> documents = ["Paris is the capital of France.", "A triangle has three sides."]
> response = requests.post(
>     "https://api.mixroute.ai/v1/rerank",
>     headers={"Authorization": "Bearer " + os.environ["MIXROUTE_API_KEY"]},
>     json={
>         "model": "rerank-v5.0-pro",
>         "query": "What is the capital of France?",
>         "documents": documents,
>         "top_n": 1,
>         "return_documents": True,
>     },
>     timeout=60,
>     allow_redirects=False,
> )
> response.raise_for_status()
> result = response.json()
> if "error" in result:
>     raise RuntimeError(result["error"])
> for item in result["results"]:
>     print(item["relevance_score"], documents[item["index"]])
> print(result.get("usage", {}))
> ```

## 回應欄位

`results[].index` 是文件在原始 documents 陣列中的索引，從 0 開始。`results[].relevance_score` 是相關性分數，數值越大表示越相關。僅在回應包含文件原文時讀取 `results[].document.text`。

```json theme={null}
{
  "results": [
    {
      "document": {
        "text": "Paris is the capital of France."
      },
      "index": 0,
      "relevance_score": 0.8398325
    }
  ],
  "usage": {
    "prompt_tokens": 27,
    "completion_tokens": 0,
    "total_tokens": 27
  }
}
```

## 用量與計費

透過 `usage.prompt_tokens` 和 `usage.total_tokens` 讀取回報的 token 用量。重排序不產生回答文字，因此 `usage.completion_tokens` 可以為 0。其他通用 token 欄位不能取代這兩個用量欄位。

目前價格和可用路由請查看[模型廣場](https://console.mixroute.ai/models)。控制台消費紀錄顯示每個請求的實際費用；核對帳單時應使用這些紀錄，不要將 usage 物件當作美元金額。

[完整請求格式](https://mixroute.ai/docs/zh-Hant/api-reference/endpoint/rerank.md)。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.