---
title: "Reranks - 重新排序 - OB Cloud 云数据库 master | OceanBase 文档中心"
description: "Reranks - 重新排序 功能说明 此接口用于对输入的文档列表进行重新排序,返回与查询最相关的文档顺序。它是 /api/v1/rerank 接口的别名,行为完全一致。 调用说明 接口约束 调用者需要拥有 API Key,详情请参见 管理 AI API Key 。 请求路径 POST {BASE_URL}/api/…"
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*qbZXRo_94ZEAAAAAAAAAAAAADiGDAQ/original) OB Cloud 云数据库

# Reranks - 重新排序

更新时间：2026-06-30 09:48:15

## 功能说明

此接口用于对输入的文档列表进行重新排序,返回与查询最相关的文档顺序。它是 `/api/v1/rerank` 接口的别名,行为完全一致。

## 调用说明

### 接口约束

- 调用者需要拥有 API Key,详情请参见 [管理 AI API Key](https://www.oceanbase.com/docs/common-oceanbase-cloud-1000000005766992)。

### 请求路径

`POST {BASE_URL}/api/v1/reranks`

### 请求头

| 名称 | 是否必选 | 示例值 | 描述 |
| --- | --- | --- | --- |
| Authorization | 是 | Bearer {token} | 鉴权信息 |
| Content-Type | 否 | application/json | 请求体格式 |

## 请求参数

### Path 参数

此接口无 Path 参数。

### Query 参数

此接口无 Query 参数。

### Body 参数

| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| model | string | 是 | rerank-model-v1 | 用于重新排序的模型标识 |
| query | string | 是 | 什么是机器学习? | 查询文本 |
| documents | array | 是 | ["文档A内容", "文档B内容"] | 待排序的文档列表 |
| input | object | 否 | {} | 输入参数对象 |
| top_n | integer | 否 | 5 | 返回最相关的前 N 个文档,默认返回全部 |
| return_documents | boolean | 否 | false | 是否在返回结果中包含文档内容 |
| parameters | object | 否 | {} | 模型特定的参数 |

## 返回结果

### 返回参数

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| success | boolean | 请求是否成功 |
| code | string | 返回码 |
| message | string | 返回信息 |
| data | object | 业务返回数据 |

### data 字段说明

返回数据的具体结构取决于模型和参数,通常包含排序后的文档索引、分数等信息。

## 请求示例

```bash
curl --request POST '{BASE_URL}/api/v1/reranks' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "rerank-model-v1",
    "query": "什么是机器学习?",
    "documents": ["机器学习是人工智能的一个分支...", "深度学习是机器学习的一种..."],
    "top_n": 3
  }'

```

## 返回示例

```json
{
  "success": true,
  "code": "200",
  "message": "successful",
  "data": {
    "results": [
      {
        "index": 0,
        "relevance_score": 0.95
      },
      {
        "index": 1,
        "relevance_score": 0.82
      }
    ]
  }
}

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线